[FEATURE] TaskUtil: Enhance interface provided to custom tasks defining specVersion 3.0 and later#514
[FEATURE] TaskUtil: Enhance interface provided to custom tasks defining specVersion 3.0 and later#514RandomByte merged 8 commits intomainfrom
Conversation
New API is only available to custom tasks defining specVerson 3.0 and later.
…ilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
…tasks New parameters are only provided to custom tasks defining specVersion 3.0 and later
358da3d to
5a458fd
Compare
…ilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
lib/specifications/Specification.js
Outdated
| /** | ||
| * @public | ||
| */ | ||
| * Get the project kind |
There was a problem hiding this comment.
How does this differ from the 'project type' below?
lib/specifications/Specification.js
Outdated
| * Get the project kind | ||
| * | ||
| * @public | ||
| * @returns {string} Project kind |
There was a problem hiding this comment.
It's confusing to have both a 'kind' and 'type' of project. Can this be remedied?
There was a problem hiding this comment.
Thank you for pointing this out. I did a mistake by referring to a specification as a "project".
In fact, a specification can be either a "project", or an "extension" (this is defined by the kind property). There might be other kinds in the future too...
I updated the documentation in the latest commit: 88375b7 (#514)
There was a problem hiding this comment.
I still think it might cause confusion if we're having both a kind and a type of specification, since these terms are used as synonyms so often. Is there really no other way to do this?
There was a problem hiding this comment.
I agree it is confusing. But sadly we introduced the additional "kind" term over two years ago when we added support for extensions. So I think it is to late to change any of the two terms now.
There was a problem hiding this comment.
That's really unfortunate. I think it would make sense to at least explain these terms better. Maybe we could put a more detailed example in, together with the definitions - what do you think?
There was a problem hiding this comment.
Yes, that makes sense. I'll create a dedicated PR for that 👍 Thanks!
Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>
b6fb0f6 to
88375b7
Compare
| [TaskUtil]{@link @ui5/project/build/helpers/TaskUtil} instance | ||
| {@ui5/project/build/helpers/TaskUtil} parameters.taskUtil Specification Version-dependent | ||
| interface of a [TaskUtil]{@link @ui5/project/build/helpers/TaskUtil} instance | ||
| {@ui5/logger/GroupLogger} [parameters.log] Logger instance to use by the custom task. |
There was a problem hiding this comment.
We should make @ui5/logger/GroupLogger public, right?
Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>
…ilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
…ilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
…ctory#createFilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
…y#createFilterReader Depends on SAP/ui5-project#514 Relates to SAP/ui5-fs#438
New API is only available to custom tasks defining specVerson 3.0 and
later.
JIRA: CPOUI5FOUNDATION-568