7 Commits

Author SHA1 Message Date
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
fa693fdd85 fix: make the --readme flag usable
+ fix(jsdoc): resolve the path to the README file
+ fix(jsdoc-cli): don't treat --readme as a boolean
2020-06-07 16:41:06 -07:00
Jeff Williams
65e2226eb0 feature(jsdoc): temporarily remove tutorial support
To be replaced by more flexible support for additional content.

BREAKING CHANGE: Removed support for tutorials.
2020-05-25 11:06:23 -07:00
Jeff Williams
a0f8d178aa refactor: extract most of @jsdoc/core into @jsdoc/util
BREAKING CHANGE: Most modules in `@jsdoc/core` have moved.
2019-12-31 14:40:14 -08: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