JsDoc build incompatible with older versions of the demokit
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, node.js
- Domain
- build-system, tooling
Research direction
Start with the ui5 build jsdoc --all entry point in the ui5-builder component and reproduce the issue using the listed 1.60.14 dependencies in the sample app. Compare dist/docs/api/api-index.json with the linked OpenUI5 1.60.14 version; done means the generated JsDoc output matches the version-specific deployed output.
Written by the indexing model from the issue text.
Description
Expected Behavior
When running ui5 build jsdoc --all in an project the version schould be considert when formatting the JsDoc output.
Current Behavior
when running ui5 build jsdoc --all on 1.60.14 the output of is different to the one that is deployed on https://openui5.hana.ondemand.com/1.60.14
Steps to reproduce the issue
- add the following dependencies to the sample app
"dependencies": {
"@openui5/sap.f": "1.60.14",
"@openui5/sap.m": "1.60.14",
"@openui5/sap.tnt": "1.60.14",
"@openui5/sap.ui.codeeditor": "1.60.14",
"@openui5/sap.ui.core": "1.60.14",
"@openui5/sap.ui.documentation": "1.60.14",
"@openui5/sap.ui.fl": "1.60.14",
"@openui5/sap.ui.dt": "1.60.14",
"@openui5/sap.ui.layout": "1.60.14",
"@openui5/sap.ui.rta": "1.60.14",
"@openui5/sap.uxap": "1.60.14",
"@openui5/themelib_sap_belize": "1.60.14"
}, - run
ui5 build jsdoc --all - open the file
dist/docs/api/api-index.jsonand compare it to the file here
Context
- UI5 Module Version (output of
ui5 --versionwhen using the CLI):1.6.0 - Node.js Version:
v12.6.0 - npm Version:
6.9.0 - OS/Platform:
OSX - Browser (if relevant):
{...} - Other information:
{...}
Affected components (if known)
- Dominant language
- JavaScript
- Stars
- 511
- Forks
- 83
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 55
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from UI5/cli
-
module/ui5-builder
-
Build cache: buildThemes cache is invalidated by irrelevant library.js / .library content changes Openmodule/ui5-builder module/ui5-fs module/ui5-project
Difficulty 3/5 1-2 days Newbie friendliness 76/100
-
module/ui5-project
Difficulty 4/5 3-5 days Newbie friendliness 64/100
-
roadmap
Similar issues
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100