Look into JSDoc build performance
Open
Nobody has claimed this yet.
module/ui5-builder
- Dominant language
- JavaScript
- Stars
- 511
- Forks
- 83
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 55
Description
Expected Behavior
A JSDoc build with the UI5 Tooling should be as fast or faster to complete than when using the OpenUI5 grunt docs build
Current Behavior
❯ hyperfine --warmup 1 'grunt docs --force'
Benchmark SAP/ui5-builder#1: grunt docs --force
Time (mean ± σ): 53.871 s ± 2.201 s [User: 75.092 s, System: 5.580 s]
Range (min … max): 51.555 s … 58.946 s 10 runs
❯ hyperfine --warmup 1 'npm run build-sdk'
Benchmark SAP/ui5-builder#1: npm run build-sdk
Time (mean ± σ): 111.163 s ± 2.921 s [User: 158.006 s, System: 33.348 s]
Range (min … max): 106.719 s … 115.586 s 10 runs
➡️ UI5 Tooling takes about 2x longer compared to grunt docs
Context
- UI5 Module Version (output of
ui5 --versionwhen using the CLI):1.2.2 - Node.js Version:
v11.8.0 - npm Version:
6.9.0 - OS/Platform:
macOS 10.14.3
Affected components (if known)
Log Output / Stack Trace
{...}
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.
Research direction
Reproduce the reported comparison with grunt docs --force and npm run build-sdk, using the stated warmup and repeated benchmark runs. Compare the UI5 Tooling build against the OpenUI5 Grunt build and identify where the extra time occurs; done means documenting or addressing the cause so the UI5 Tooling JSDoc build is no slower than the reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- build-system, cli, performance
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100