[INTERNAL] Default force flag to 'false'

Update JSDoc
SAP · Nov 14, 2023 · 4a1ece4 · 4a1ece4
1 parent 61cec42
commit 4a1ece4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/lib/build/helpers/BuildContext.js b/lib/build/helpers/BuildContext.js
@@ -80,7 +80,7 @@ class BuildContext {
 		return projectBuildContext;
 	}
 
-	async executeCleanupTasks(force) {
+	async executeCleanupTasks(force = false) {
 		await Promise.all(this._projectBuildContexts.map((ctx) => {
 			return ctx.executeCleanupTasks(force);
 		}));

diff --git a/lib/build/helpers/TaskUtil.js b/lib/build/helpers/TaskUtil.js
@@ -169,8 +169,8 @@ class TaskUtil {
 	 * @public
 	 * @callback @ui5/project/build/helpers/TaskUtil~cleanupTaskCallback
 	 * @param {boolean} force Specifies whether the cleanup callback should
-	 * 							gracefully wait for certain jobs to be completed
-	 * 							or enforce immediate termination and cleanup of those jobs.
+	 * 							gracefully wait for certain jobs to be completed (<code>false</code>)
+	 * 							or enforce immediate termination (<code>true</code>).
 	 */
 
 	/**

diff --git a/test/lib/build/ProjectBuilder.js b/test/lib/build/ProjectBuilder.js
@@ -728,15 +728,15 @@ test("_executeCleanupTasks", async (t) => {
 	await builder._executeCleanupTasks();
 	t.is(executeCleanupTasksStub.callCount, 1, "BuildContext#executeCleanupTasks got called once");
 	t.deepEqual(executeCleanupTasksStub.getCall(0).args, [undefined],
-		"BuildContext#executeCleanupTasks got called with no arguments");
+		"BuildContext#executeCleanupTasks got called with correct arguments");
 
 	// reset stub
 	executeCleanupTasksStub.reset();
 	// Call with enforcement flag
 	await builder._executeCleanupTasks(true);
 	t.is(executeCleanupTasksStub.callCount, 1, "BuildContext#executeCleanupTasks got called once");
 	t.deepEqual(executeCleanupTasksStub.getCall(0).args, [true],
-		"BuildContext#executeCleanupTasks got called with force flag");
+		"BuildContext#executeCleanupTasks got called with correct arguments");
 });
 
 test("instantiate new logger for every ProjectBuilder", async (t) => {