Jeff Williams
c076b5d8f1
docs: add and improve JSDoc comments
...
Plus some minor refactoring.
2025-09-28 12:53:50 -07:00
renovate[bot]
8d9fa98561
fix(deps): update dependency strip-json-comments to ^5.0.3
2025-08-08 17:05:30 +00:00
Jeff Williams
ee53851057
chore(deps): update supported engines; upgrade yargs-parser
...
Node.js 18 is EOL, and yargs-parser requires recent versions of Node.js 20 and 22.
2025-05-30 21:51:32 -07:00
renovate[bot]
13c52db01e
fix(deps): update dependency strip-json-comments to ^5.0.2
2025-05-16 22:05:00 +00:00
Jeff Williams
153b899c2e
refactor(jsdoc-core): remove obsolete getter and method
2025-02-11 21:22:49 -08:00
Jeff Williams
687c1c182d
Publish
...
- jsdoc@5.0.0-dev.19
- @jsdoc/ast@0.2.13
- @jsdoc/cli@0.3.12
- @jsdoc/core@0.5.10
- @jsdoc/doclet@0.2.13
- @jsdoc/eslint-config@2.0.2
- @jsdoc/name@0.1.1
- @jsdoc/parse@0.3.13
- @jsdoc/plugins@0.1.13
- @jsdoc/prettier-config@0.2.10
- @jsdoc/tag@0.2.13
- @jsdoc/task-runner@0.2.7
- @jsdoc/template-legacy@0.1.13
2025-01-15 12:31:09 -08:00
renovate[bot]
d8e7ff416f
fix(deps): update dependency fast-glob to ^3.3.3
2025-01-05 10:40:13 +00:00
Jeff Williams
42f73299c7
docs: improve code comments
...
Plus some very minor code cleanup.
2024-12-16 22:03:35 -08:00
Jeff Williams
7e92e5acfd
Publish
...
- jsdoc@5.0.0-dev.18
- @jsdoc/ast@0.2.12
- @jsdoc/cli@0.3.11
- @jsdoc/core@0.5.9
- @jsdoc/doclet@0.2.12
- @jsdoc/eslint-config@2.0.1
- @jsdoc/name@0.1.0
- @jsdoc/parse@0.3.12
- @jsdoc/plugins@0.1.12
- @jsdoc/prettier-config@0.2.9
- @jsdoc/salty@0.2.9
- @jsdoc/tag@0.2.12
- @jsdoc/task-runner@0.2.6
- @jsdoc/template-legacy@0.1.12
- @jsdoc/util@0.3.4
2024-12-15 15:08:57 -08:00
Jeff Williams
428ddcf521
refactor: create @jsdoc/name package to break dependency cycles
...
Tons of stuff depends on these methods; in contrast, these methods don't depend on any other JSDoc packages.
2024-12-15 15:08:06 -08:00
Jeff Williams
fdf8f6b481
refactor: use env instead of deps
2024-12-07 21:02:01 -08:00
Jeff Williams
125a9add3d
refactor: remove jsdoc.deps from test environment
...
Use `jsdoc.env` instead.
2024-12-07 14:56:28 -08:00
Jeff Williams
3652d69bc5
refactor: rename Dictionary.fromConfig() to Dictionary.fromEnv()
2024-12-07 14:30:05 -08:00
Jeff Williams
f7d5fa77b0
fix: use a special longname for a non-default export in an ES2015 module
...
Previously, we used `exports.NAME`, which was both incorrect and confusing.
2024-05-11 17:42:04 -07:00
Jeff Williams
575f0dccc8
fix: use a special longname for an ES2015 module's default export
...
Previously, we used `module.exports`, which is both incorrect and confusing.
2024-05-11 12:07:56 -07:00
Jeff Williams
7942901ff7
Publish
...
- jsdoc@5.0.0-dev.17
- @jsdoc/ast@0.2.11
- @jsdoc/cli@0.3.10
- @jsdoc/core@0.5.8
- @jsdoc/doclet@0.2.11
- @jsdoc/eslint-config@2.0.0
- @jsdoc/parse@0.3.11
- @jsdoc/plugins@0.1.11
- @jsdoc/prettier-config@0.2.8
- @jsdoc/salty@0.2.8
- @jsdoc/tag@0.2.11
- @jsdoc/task-runner@0.2.5
- @jsdoc/template-legacy@0.1.11
- @jsdoc/util@0.3.3
2024-04-15 14:25:21 -07:00
Jeff Williams
55b0489662
chore(jsdoc-eslint-config): migrate to ESLint flat config
2024-04-14 11:39:46 -07:00
Jeff Williams
cee9fbf914
refactor: move tag initialization out of runCommand()
2024-02-21 13:50:06 -08:00
Jeff Williams
21c9f5df97
fix(jsdoc-core): remove ill-conceived test
...
Running the legacy template in a test has too many potential side effects. (Also, it wasn't working, because the JSDoc environment was missing some data.)
2024-01-20 21:46:38 -08:00
Jeff Williams
4fcaf793f6
feat(jsdoc-core): move parseSourceFiles() to public API
2024-01-12 19:26:16 -08:00
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
