143 Commits

Author SHA1 Message Date
Jeff Williams
301a3a4e5d
feat(jsdoc-core): move generateDocs() to public API 2024-01-01 20:02:32 -08:00
Jeff Williams
aa49b841bb
fix(jsdoc-core): extract the correct basename for scoped modules, and when a namespace is present 2023-12-30 14:34:38 -08:00
Jeff Williams
638a89a204
feat(jsdoc-core): move source-file scanning to public API 2023-12-29 11:51:34 -08:00
Jeff Williams
865b9faa1e
feat(jsdoc-core): add Api class
Starting point for a public API for JSDoc.
2023-12-27 12:46:21 -08:00
Jeff Williams
5b11762b35
refactor(jsdoc-core): rename default config object 2023-12-27 12:09:18 -08:00
Jeff Williams
02e82eaaa4
fix: use the correct name and longname for class-private methods and properties 2023-12-19 12:47:15 -08:00
Jeff Williams
db20d51066
Publish
- jsdoc@5.0.0-dev.16
 - @jsdoc/ast@0.2.10
 - @jsdoc/cli@0.3.9
 - @jsdoc/core@0.5.7
 - @jsdoc/doclet@0.2.10
 - @jsdoc/eslint-config@1.2.8
 - @jsdoc/parse@0.3.10
 - @jsdoc/plugins@0.1.10
 - @jsdoc/prettier-config@0.2.7
 - @jsdoc/tag@0.2.10
 - @jsdoc/task-runner@0.2.4
 - @jsdoc/template-legacy@0.1.10
2023-12-10 17:47:38 -08:00
Jeff Williams
45c497e192
refactor: simplify dependency management
It turns out that JSDoc's dependency-injection needs are pretty simple; we mostly just need to pass around some data, plus some logging functions. That means the previous solution was overengineered, even though it was still pretty lightweight.

Now we just put everything in the `Env` object and pass that around instead.
2023-12-10 15:05:35 -08:00
Jeff Williams
f31388c188
refactor: move some Env-related code around 2023-12-09 20:15:49 -08:00
Jeff Williams
48148e120d
refactor: convert env to a class
Because we now share `env` by passing it around, not by relying on the module cache.
2023-12-09 10:18:17 -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
3e4f5fc557
Publish
- jsdoc@5.0.0-dev.15
 - @jsdoc/ast@0.2.9
 - @jsdoc/cli@0.3.8
 - @jsdoc/core@0.5.6
 - @jsdoc/doclet@0.2.9
 - @jsdoc/eslint-config@1.2.7
 - @jsdoc/parse@0.3.9
 - @jsdoc/plugins@0.1.9
 - @jsdoc/prettier-config@0.2.6
 - @jsdoc/salty@0.2.7
 - @jsdoc/tag@0.2.9
 - @jsdoc/template-legacy@0.1.9
 - @jsdoc/test-matchers@0.2.6
2023-12-03 14:53:40 -08:00
renovate[bot]
9eeb34f933
fix(deps): update dependency cosmiconfig to v9 2023-11-26 16:52:59 +00:00
Jeff Williams
3fddc126ab
Publish
- jsdoc@5.0.0-dev.12
 - @jsdoc/ast@0.2.6
 - @jsdoc/cli@0.3.6
 - @jsdoc/core@0.5.5
 - @jsdoc/doclet@0.2.6
 - @jsdoc/eslint-config@1.2.5
 - @jsdoc/parse@0.3.6
 - @jsdoc/plugins@0.1.6
 - @jsdoc/prettier-config@0.2.4
 - @jsdoc/salty@0.2.6
 - @jsdoc/tag@0.2.6
 - @jsdoc/task-runner@0.2.3
 - @jsdoc/template-legacy@0.1.6
 - @jsdoc/test-matchers@0.2.5
 - @jsdoc/util@0.3.1
2023-11-12 15:43:49 -08:00
Jeff Williams
5e4f999497
refactor: don't use deprecated RegExp.$1...$9 properties
Plus some miscellaneous cleanup.
2023-10-11 16:40:23 -07:00
Jeff Williams
ba08fc3b9b
chore: use npm workspaces 2023-10-08 20:57:07 -07:00
Jeff Williams
76ac64eaf2
Publish
- jsdoc@5.0.0-dev.10
 - @jsdoc/ast@0.2.4
 - @jsdoc/cli@0.3.4
 - @jsdoc/core@0.5.4
 - @jsdoc/doclet@0.2.4
 - @jsdoc/eslint-config@1.2.3
 - @jsdoc/parse@0.3.4
 - @jsdoc/plugins@0.1.4
 - @jsdoc/tag@0.2.4
 - @jsdoc/task-runner@0.2.2
 - @jsdoc/template-legacy@0.1.4
 - @jsdoc/test-matchers@0.2.4
2023-09-17 17:46:06 -07:00
renovate[bot]
58050cde29
fix(deps): update dependency cosmiconfig to ^8.3.6 2023-09-13 17:00:23 +00:00
renovate[bot]
5d42995f33
fix(deps): update dependency cosmiconfig to ^8.3.5 2023-09-09 00:00:02 +00:00
renovate[bot]
decac39eed
fix(deps): update dependency cosmiconfig to ^8.3.4 2023-09-04 21:07:55 +00:00
Jeff Williams
bf6e6a45a5
Publish
- jsdoc@5.0.0-dev.9
 - @jsdoc/ast@0.2.3
 - @jsdoc/cli@0.3.3
 - @jsdoc/core@0.5.3
 - @jsdoc/doclet@0.2.3
 - @jsdoc/eslint-config@1.2.2
 - @jsdoc/parse@0.3.3
 - @jsdoc/plugins@0.1.3
 - @jsdoc/prettier-config@0.2.3
 - @jsdoc/tag@0.2.3
 - @jsdoc/template-legacy@0.1.3
 - @jsdoc/test-matchers@0.2.3
2023-09-03 14:31:23 -07:00
renovate[bot]
0dbe9517ec
fix(deps): update dependency strip-json-comments to ^5.0.1 (#2061)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-02 15:34:52 -07:00
Jeff Williams
ae5ae0bb12
Publish
- jsdoc@5.0.0-dev.8
 - @jsdoc/ast@0.2.2
 - @jsdoc/cli@0.3.2
 - @jsdoc/core@0.5.2
 - @jsdoc/doclet@0.2.2
 - @jsdoc/eslint-config@1.2.1
 - @jsdoc/parse@0.3.2
 - @jsdoc/plugins@0.1.2
 - @jsdoc/prettier-config@0.2.2
 - @jsdoc/tag@0.2.2
 - @jsdoc/template-legacy@0.1.2
 - @jsdoc/test-matchers@0.2.2
2023-09-02 15:24:22 -07:00
Jeff Williams
1e23b7e61f
fix(jsdoc-core): mock fs correctly in config tests 2023-09-02 15:04:49 -07:00
renovate[bot]
d141336394
fix(deps): update dependency cosmiconfig to ^8.2.0 2023-06-04 22:14:02 +00:00
renovate[bot]
e926a3f300
fix(deps): update dependency cosmiconfig to ^8.1.3 2023-03-18 22:48:00 +00:00
renovate[bot]
daa7eb1274
fix(deps): update dependency cosmiconfig to ^8.1.2 2023-03-17 17:13:06 +00:00
Jeff Williams
e20ec9ce0c
Publish
- @jsdoc/ast@0.2.1
 - @jsdoc/cli@0.3.1
 - @jsdoc/core@0.5.1
 - @jsdoc/doclet@0.2.1
 - @jsdoc/parse@0.3.1
 - @jsdoc/plugins@0.1.1
 - @jsdoc/prettier-config@0.2.1
 - @jsdoc/salty@0.2.5
 - @jsdoc/tag@0.2.1
 - @jsdoc/task-runner@0.2.1
 - @jsdoc/template-legacy@0.1.1
 - @jsdoc/test-matchers@0.2.1
 - jsdoc@5.0.0-dev.7
2023-03-08 15:53:45 -08:00
Jeff Williams
0e866cb18e
fix: remove leftover exports 2023-03-08 15:52:52 -08:00
Jeff Williams
7dee4094ce
Publish
- @jsdoc/ast@0.2.0
 - @jsdoc/cli@0.3.0
 - @jsdoc/core@0.5.0
 - @jsdoc/doclet@0.2.0
 - @jsdoc/eslint-config@1.2.0
 - @jsdoc/parse@0.3.0
 - @jsdoc/plugins@0.1.0
 - @jsdoc/prettier-config@0.2.0
 - @jsdoc/salty@0.2.4
 - @jsdoc/tag@0.2.0
 - @jsdoc/task-runner@0.2.0
 - @jsdoc/template-legacy@0.1.0
 - @jsdoc/test-matchers@0.2.0
 - @jsdoc/util@0.3.0
 - jsdoc@5.0.0-dev.6
2023-02-28 20:19:11 -08:00
Jeff Williams
c04508f295
refactor: migrate to ES modules 2023-02-28 20:12:24 -08:00
Jeff Williams
f8731da99e
chore: add/update .npmignore files 2023-02-20 19:46:15 -08:00
Jeff Williams
cfc4ba0610
refactor: move plugins and plugin loader to different packages 2023-02-20 11:43:12 -08:00
Jeff Williams
1a63331a15
Publish
- @jsdoc/ast@0.1.1
 - @jsdoc/cli@0.2.11
 - @jsdoc/core@0.4.6
 - @jsdoc/doclet@0.1.2
 - @jsdoc/parse@0.2.0
 - @jsdoc/tag@0.1.6
 - jsdoc@5.0.0-dev.5
2023-01-29 14:03:01 -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
a6f56e29f8
Publish
- @jsdoc/ast@0.1.0
 - @jsdoc/cli@0.2.10
 - @jsdoc/core@0.4.5
 - @jsdoc/doclet@0.1.0
 - @jsdoc/eslint-config@1.1.11
 - @jsdoc/prettier-config@0.1.2
 - @jsdoc/salty@0.2.3
 - @jsdoc/tag@0.1.5
 - @jsdoc/task-runner@0.1.14
 - @jsdoc/test-matchers@0.1.18
 - @jsdoc/util@0.2.8
 - jsdoc@5.0.0-dev.3
2023-01-16 12:15:35 -08:00
Jeff Williams
0ca411969e
refactor: move doclet module to @jsdoc/doclet 2023-01-16 12:09:50 -08:00
Jeff Williams
333522a2cd
chore: Object.prototype.hasOwnProperty.call -> Object.hasOwn 2023-01-08 22:11:12 -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
e3ac8e1670
refactor: migrate task runners to Hereby 2023-01-07 20:46:11 -08:00
Jeff Williams
22a935fb06
Publish
- @jsdoc/cli@0.2.9
 - @jsdoc/core@0.4.4
 - @jsdoc/eslint-config@1.1.10
 - @jsdoc/parse@0.1.5
 - @jsdoc/salty@0.2.2
 - @jsdoc/tag@0.1.4
 - @jsdoc/test-matchers@0.1.13
 - jsdoc@5.0.0-dev.1
2022-12-11 19:00:20 -08:00
renovate[bot]
036e6cce58
fix(deps): update dependency cosmiconfig to ^7.1.0 2022-11-12 15:34:38 +00:00
Jeff Williams
5178661c1c chore: move jsdoc/env to @jsdoc/core.env 2022-11-03 14:36:42 -07:00
Jeff Williams
12da2f7ecc Publish
- @jsdoc/cli@0.2.8
 - @jsdoc/core@0.4.3
 - @jsdoc/eslint-config@1.1.9
 - @jsdoc/parse@0.1.4
 - @jsdoc/salty@0.2.0
 - @jsdoc/tag@0.1.3
 - @jsdoc/task-runner@0.1.13
 - @jsdoc/test-matchers@0.1.11
 - @jsdoc/util@0.2.7
 - jsdoc@4.0.0-dev.19
2022-11-01 20:49:02 -07:00
renovate[bot]
cf64accd78
chore(deps): update node.js to v18 2022-11-01 07:25:22 +00:00
renovate[bot]
a724ea311b
chore(deps): update node.js to >=v16.18.0 2022-10-31 19:43:37 +00:00
Jeff Williams
3a6cdb28f5 Publish
- @jsdoc/cli@0.2.7
 - @jsdoc/core@0.4.2
 - @jsdoc/eslint-config@1.1.8
 - @jsdoc/parse@0.1.3
 - @jsdoc/prettier-config@0.1.1
 - @jsdoc/tag@0.1.2
 - @jsdoc/task-runner@0.1.12
 - @jsdoc/test-matchers@0.1.8
 - @jsdoc/util@0.2.6
 - jsdoc@4.0.0-dev.18
2022-10-23 20:06:03 -07:00
Jeff Williams
41ac86129b chore(deps): update Jasmine; add missing deps
We can't update Jasmine past 3.99.0 until we've done away with our `require()`-hacking shenanigans.
2022-09-02 12:34:26 -07:00
renovate[bot]
580d8927f9
chore(deps): update node.js to >=v16.17.0 2022-08-30 02:34:54 +00:00
renovate[bot]
2dee2e72b7
fix(deps): update dependency bottlejs to ^2.0.1 2022-08-29 07:01:00 +00:00