10 Commits

Author SHA1 Message Date
Jeff Williams
c076b5d8f1
docs: add and improve JSDoc comments
Plus some minor refactoring.
2025-09-28 12:53:50 -07:00
Jeff Williams
5b11762b35
refactor(jsdoc-core): rename default config object 2023-12-27 12:09:18 -08:00
Jeff Williams
a82263f925
refactor: make config loading asynchronous
Workaround for https://github.com/tschaub/mock-fs/issues/377, which causes `fs.readFileSync()` to fail on Node.js >=20.5.0.

Fixes #2097.
2023-12-03 15:42:56 -08:00
Jeff Williams
c04508f295
refactor: migrate to ES modules 2023-02-28 20:12:24 -08:00
Jeff Williams
6a5b88cb5a
feat: use globs, not regexes, to specify source files
Glob expressions are easier than regexes to write correctly; they're often easier to read as well. We support all of the syntax in https://github.com/mrmlnc/fast-glob#pattern-syntax, which should provide more than enough flexibility for JSDoc users.

Related change: If a `package.json` or `README.md` file gets picked up as one of your source files, we no longer assume that it should be incorporated into the generated docs. Instead, you must specify the file explicitly with the `-P` flag (for `package.json`) or the `-R` flag (for `README.md`).
2023-01-22 17:32:17 -08:00
Jeff Williams
8c6aad8440
chore: add license headers, and a CI check for their presence 2023-01-08 16:11:38 -08:00
Jeff Williams
1305499207 chore: use Prettier to format source files 2021-09-19 13:20:31 -07:00
Jeff Williams
0fa28300b2 refactor: reorganize @jsdoc/core
Also creates a new package, `@jsdoc/cli`.

BREAKING CHANGE: Methods in `@jsdoc/core` moved around.
2019-12-08 18:30:58 -08:00
Jeff Williams
c6d3dea475 fix(jsdoc-core): use the cosmiconfig 6.x API 2019-12-01 11:43:18 -08:00
Jeff Williams
a291608954 add @jsdoc/core package 2019-07-28 15:14:16 -07:00