Skip to content

Commit

Permalink
[BREAKING] generateJsDoc: Remove internal 'buildContext' parameter
Browse files Browse the repository at this point in the history
Initially the generateJsDoc task use a buildContext parameter to
register a cleanup task.
In the meantime this functionality is available via the taskUtil.
  • Loading branch information
matz3 committed Dec 2, 2022
1 parent 921ea75 commit 4ec80c8
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions lib/tasks/jsdoc/generateJsdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,10 @@ import {createAdapter} from "@ui5/fs/resourceFactory";
* @param {@ui5/fs/AbstractReader} parameters.dependencies Reader or Collection to read dependency files
* @param {module:@ui5/builder/tasks/jsdoc/generateJsdoc~GenerateJsdocOptions} parameters.options Options
* @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
* @param {object} [parameters.buildContext] Internal, deprecated parameter
* @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
*/
export default async function generateJsdoc({
taskUtil,
buildContext,
workspace,
dependencies,
options = {}
Expand All @@ -58,11 +56,7 @@ export default async function generateJsdoc({
const {sourcePath: resourcePath, targetPath, tmpPath, cleanup} =
await utils.createTmpDirs(projectName);

// TODO 3.0: remove buildContext
const _taskUtil = taskUtil || buildContext;
if (_taskUtil) {
_taskUtil.registerCleanupTask(cleanup);
}
taskUtil?.registerCleanupTask(cleanup);

const [writtenResourcesCount] = await Promise.all([
utils.writeResourcesToDir({
Expand Down

0 comments on commit 4ec80c8

Please sign in to comment.