`opts.destination` parsed differently for static files
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
I'm not sure if this is to a bug, or something that should be addressed in the documentation, but here goes:
In jsdoc.json, the following works, and will put generated documentation and static files in /docs
opts.destination: "docs"
templates.default.staticFiles.include: ["resources"]
This works too:
opts.destination: "./docs/"
templates.default.staticFiles.include: ["./resources/"]
The following, however, will put files from resources in the root, and not in with the rest of the output:
opts.destination: "docs"
templates.default.staticFiles.include: ["./resources/"]
This is potentially confusing (took me quite a while to figure out...), as no warning or error is given.
Environment
| Software | Version |
|---|---|
| JSDoc | 3.5.5 |
| Node.js | 8.15.0 |
| Operating system | Ubuntu 18.10 |
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 three jsdoc.json configurations described in the issue with JSDoc 3.5.5 and compare where the generated documentation and resources are written. Trace the handling of opts.destination and templates.default.staticFiles.include, then add or update coverage so the intended destination behavior is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100