[github-actions]

v0.2.0 is the next major release.

Timetable: to be announced.

👉 Changelog

compare changes

🚀 Enhancements

• gates: set scope per path in overrides (3a5daac)
• lsp: add docov lsp, a language server for editors (f199ab1)
• fix: write prefilled doc stubs with --fix (b3c9f34)
• collect: leave out deprecated items and generated files (b2d81f2)
• collect: pick which ways of exporting count with exports (951b33e)
• collect: count override members as documented with inherit (47efc36)
• collect: pick the access levels that count with access (6f78d7c)
• collect: leave out items by name with ignore.names (64906c2)
• collect: pick the kinds that count, and total them by kind (bda1b2e)
• cli: write docov-ignore comments with --add-ignore (05317af)
• collect: ignore items with docov-ignore comments (70dacff)
• collect: leave out items by JSDoc tag with excludeTags (8920364)
• collect: require a description with --require-description (3aa4e4d)
• report: list doc-check findings in every format (ca26c83)
• check: merge rules per id across configs (48bad0c)
• check: add doc-markdown (0617ae0)
• check: add summary-sentence (86b40b3)
• check: add valid-link (4cb6eb1)
• check: add informative-docs (e4eb8da)
• check: add empty-tag-description (3a5f87a)
• check: add require-template (350d98f)
• check: add require-throws (5801f4a)
• check: add require-returns and require-yields (7551a42)
• check: add doc checks with per-rule levels, param checks and --complete (3d9f1a8)
• cli: explain a file's items with --explain (5b2e7cd)
• scope: count a package's public API with --scope public (dbcb6b2)
• report: add JavaScript type coverage with --types (e349267)
• report: add release-tag coverage with --release-tags (39adefd)
• collect: count CommonJS prototype members with commonjsMembers (ed0e841)
• collect: count enum, type and object members with members all (5b6ca17)
• collect: count @typedef and @callback blocks as types with virtual (3510ccd)
• collect: count each file as an item with fileDocs (c56043e)
• report: count example coverage as a second metric (bb46705)
• report: describe each item's docs in the JSON and sort by priority (894e728)
• cli: reuse unchanged files' items with --cache (d50b396)
• cli: scan again on changes with --watch (50ab276)
• report: color the text report where it helps (3da3a56)
• cli: scan stdin as a named file with --stdin-filename (7fec3b8)
• cli: set how many files scan at once with --threads (2265260)
• config: scan the files a jsdoc.json documents (180d02a)
• config: nested configs and per-package totals (88a6889)
• cli: add docov init to write a starting docov.json (4d671fb)
• cli: add --print-config and --list-files (bb2b4e9)
• config: extend other config files with "extends" (428db7d)
• git: gate the items on lines a change added (675b6f9)
• git: scan only changed or staged files (b2d6998)
• threshold: ratchet the threshold with --update-threshold (f926fcb)
• baseline: let known undocumented items through the gates (802320e)
• hooks: add a pre-commit hook and a lefthook recipe (989afb2)
• gates: add a cap on undocumented items (507a997)
• config: add overrides that change exclude and threshold by glob (769a7a9)
• threshold: add thresholds per file and per glob (c155c7e)
• action: commit reports to a data branch for trends and badges (d86628d)
• report: add a self-contained HTML report (7ea7fce)
• action: add a composite GitHub Action (2121af8)
• report: add a compiler-style unix format (1b2ac5b)
• report: show the change from an earlier report with --compare (5b2920e)
• report: add a github-action-benchmark format (d7bf634)
• report: add --omit-covered and --quiet to the text report (12a30df)
• report: add an SVG badge and a shields.io endpoint format (04ebdac)
• report: add Cobertura XML and lcov function records (8b6abc4)
• report: add GitLab, JUnit, Checkstyle and reviewdog formats (b367dc9)
• report: add SARIF 2.1.0 output (639746f)
• report: add a Markdown summary format (f3394a4)
• report: add GitHub Actions annotations (d0b61ee)
• report: write several formats from one scan (36e54b1)

🔥 Performance

• lsp: keep each project's config until its files change (2460f41)

🩹 Fixes

• release: drop repeated changelog entries on release PRs (c7cd428)
• release: bump the pre-commit hook and the README schema URL on release PRs (cf4c678)
• public: show plain Windows paths instead of verbatim ones (ab23822)
• jsdoc: escape backslashes in excluded names (e5e33fd)
• config: show extends and jsdocConfig paths with native separators (dc5020c)
• baseline: show the baseline key's path with native separators (043079b)
• ignore: report ignore comments that cover nothing (f85815e)
• ignore: cover a file's own item when adding ignores (2968b73)

💅 Refactors

• lsp: use lsp-types 0.97's Uri (9bf42f9)
• report: register output formats from src/report/ (cd822fc)
• ⚠️ feature: give each flag and config key its own file (7cd8689)

📖 Documentation

• collect: say which members the method and property kinds cover (a5769b2)
• describe exit codes in terms of gates (cc00439)
• readme: add a Codecov recipe for doc coverage (40842a1)

✅ Tests

• lsp: start docov lsp through docov_command (cb3a8f0)
• props: expect native separators in the nested doc check gate (92daf58)
• props: expect native separators in nested config failures (e6c292e)
• props: build the unbuildable threshold glob by nesting, as test(props): fail the exclude glob build by nesting, not size #10 did (c090ab5)
• props: start docov through docov_command in more-items' properties (5dea3a7)
• clear the variables docov reads when properties run it (22c7cea)
• tools: compare docov with jsdoc on plain JavaScript fixtures (d33b4b0)
• props: fail the exclude glob build by nesting, not size (861d89f)

🤖 CI

• deps: bump the actions group with 2 updates (8377c99)
• harden the workflows and check dependencies, workflows and the MSRV (03b5e43)
• list uncovered lines in the log when writing lcov (481706b)
• release: release through uppt and publish the crate alongside (03d27da)
• run lint and coverage as separate checks (644b989)
• report coverage in the job summary and as an artifact (5decc0b)

🎉 New Contributors

• dependabot[bot] (@dependabot[bot])

❤️ Contributors

• botandbang (@botandbang)
• dependabot[bot] (@dependabot[bot])