JsDoc build incompatible with older versions of the demokit

Open
#356 2 comments 0 reactions 0 assignees View on GitHub

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

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

module/ui5-builder

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

  1. 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"
    },
  2. run ui5 build jsdoc --all
  3. open the file dist/docs/api/api-index.json and compare it to the file here

Context

  • UI5 Module Version (output of ui5 --version when 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from UI5/cli

All issues in UI5/cli

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.