[INTERNAL] TaskUtil: Document standard tag 'IsBundle'

Seems like an oversight in #535. The tag can already be used and should be documented in the API reference
SAP · Nov 10, 2021 · 2203226 · 2203226
1 parent ed0da12
commit 2203226
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/lib/builder/ProjectBuildContext.js b/lib/builder/ProjectBuildContext.js
@@ -1,5 +1,7 @@
 const ResourceTagCollection = require("@ui5/fs").ResourceTagCollection;
 
+// Note: When adding standard tags, always update the public documentation in TaskUtil
+// (Type "module:@ui5/builder.tasks.TaskUtil~StandardBuildTags")
 const STANDARD_TAGS = Object.freeze({
 	OmitFromBuildResult: "ui5:OmitFromBuildResult",
 	IsBundle: "ui5:IsBundle"

diff --git a/lib/tasks/TaskUtil.js b/lib/tasks/TaskUtil.js
@@ -20,6 +20,8 @@ class TaskUtil {
 	 * @typedef {object} module:@ui5/builder.tasks.TaskUtil~StandardBuildTags
 	 * @property {string} OmitFromBuildResult
 	 * 		Setting this tag to true for a resource will prevent it from being written to the build target
+	 * @property {string} IsBundle
+	 * 		This tag identifies resources that contain ("bundle") multiple other resources
 	 */
 
 	/**