[FIX] JSDoc: add project name to JSDoc configuration and api.json #609
Conversation
The JSDoc processor did not propagate the library name (project name) to
the JSDoc configuration. As a consequence, the UI5 template (publish.js)
could not properly validate the metadata property 'library' for control
and elements classes. It reported many false positives ("ERROR:
specified library 'foo.bar' for class 'foo.bar.Control' doesn't match
containing library 'undefined'").
|
@RandomByte thank you for the quick review! |
| @@ -106,6 +106,7 @@ async function generateJsdocConfig({targetPath, tmpPath, namespace, projectName, | |||
| "ui5": { | |||
| "variants": ${JSON.stringify(variants)}, | |||
| "version": "${version}", | |||
| "uilib": "${projectName}", | |||
There was a problem hiding this comment.
I think we should not use the projectName (= ui5.yaml metadata name) but the namespace.
Usually they are equal but the namespace is guaranteed to be correct as it is also used for the folder structure. The project name is mainly used for logging purposes.
See my abandoned change here: https://github.com/SAP/ui5-builder/pull/598/files#diff-03d08225d447cd18da349dd9928b9093a83e66d9a6aa66cee4e0a0038779a9c8
There was a problem hiding this comment.
Hm, what does "correct" mean here anyways? If the "uilib" property shall contain the libraries name, the projectName is always correct imho.
There was a problem hiding this comment.
Especially for that "library" check IMO it's important that it fits to the namespace of the library. If it would be something else (e.g. mylib instead of com.example.mylib), the check would fail and report false findings.
There was a problem hiding this comment.
I see. In that case we should change it to the namespace
|
Thanks! I only cherry-picked the openui5 change and missed to add my changes from #598. |
Tests have been adopted to check whether the right information is used. Follow-up of #609
Tests have been adopted to check whether the right information is used. Follow-up of #609
The JSDoc processor did not propagate the library name (project name) to the JSDoc configuration. As a consequence, the UI5 template (publish.js) could not properly validate the metadata property 'library' for control and element classes. It reported many false positives ("ERROR: specified library 'foo.bar' for class 'foo.bar.Control' doesn't match containing library 'undefined'").