Change the default behaviour which ignores folders with leading underscore
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
As part of an automated process, jsdoc-api writes source code to the system tmp folder (returned by os.tmpdir()) then parses it using jsdoc -X.
However, some users are reporting that jsdoc-api randomly fails with There are no input files to process yet a reboot of the machine fixes it.
It's because the system temp folder path occasionally features a leading underscore, e.g.
/var/folders/_9/nl_3vwh14lx9325r9cn6s08s96pd8g/T/
If there is a leading underscore in any part of the working directory tree, jsdoc fails. Could this default behaviour be reconsidered please? It leads to confusing, intermittent bugs.
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 failure by placing source files under a working-directory path containing a leading underscore and running jsdoc -X. Trace the input-file filtering behavior responsible for reporting no input files, then verify that files under such paths are processed successfully without changing the intended handling of other ignored folders.
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
- 45/100