@es-joy/jsdoccomment

Releases

1. 0.50.219 May 2025
   Release notes2 sources agree

   • fix: remove @types/eslint (#20)

   Thanks:

   • @ocavue

   Open source →
2. 0.50.114 May 2025
   Release notes2 sources agree

   • fix: for TSFunctionType part of TSTypeAliasDeclaration and export, return export

   Open source →
3. 0.50.025 Oct 2024
   Release notes2 sources agree

   BREAKING CHANGES:

   • Require Node 18+
   • chore: add .d.cts file / add type dependencies (#19)
   • test(ci): drop Node 16.x and add Node 22.x

   Thanks:

   • @typhonrt

   Open source →
4. 0.49.014 Oct 2024
   Release notes2 sources agree

   • fix: avoid changing name for @template; should be able to recover optional brackets and defaults in AST

   Open source →
5. 0.48.013 Aug 2024
   Release notes2 sources agree

   • chore: bump jsdoc-type-pratt-parser and devDeps.

   Open source →
6. 0.47.013 Aug 2024
   Release notes2 sources agree

   • fix(parseComment): assume closing bracket of name is final instead of first one
   • chore: flat config/ESLint 9; change browser targets; lint; update devDeps.

   Open source →
7. 0.46.010 Jul 2024
   Release notes2 sources agree

   • chore: update esquery, drop bundling of types, update devDeps

   Open source →
8. 0.45.09 Jul 2024
   Release notes2 sources agree

   • feat: get following comment (experimental)

   Open source →
9. 0.44.05 Jul 2024
   Release notes2 sources agree

   • feat: add getNonJsdocComment for getting non-JSDoc comments above node

   Open source →
10. 0.43.129 May 2024
    Release notes2 sources agree

    • fix: for @template name parsing, ensure (default-)bracketed name is not broken with internal spaces.

    Open source →
11. 0.43.020 Mar 2024
    Release notes2 sources agree

    This release brings surgical round trip parsing to generated AST and reconstruction of JSDoc comment blocks via: parseComment -> commentParserToESTree -> estreeToString.

    • feat: new option spacing for commentParserToESTree; the default is compact removing empty description lines.

    Set to preserve to retain empty description lines.

    • feat: new properties in the JsdocBlock generated AST delimiterLineBreak and preterminalLineBreak that encode

    any line break after the opening delimiter and before the closing terminal string. Values are either \n or an empty string.

    • chore: update devDeps / switch to Vitest.
    • New API documentation.

    Thanks:

    • @typhonrt

    Open source →
12. 0.42.05 Feb 2024
    Release notes2 sources agree

    • feat: expand argument for parseComment to accept a comment token string (@typhonrt)
    • chore: update devDeps.

    Open source →
13. 0.41.010 Nov 2023
    Release notes2 sources agree

    • feat: look above surrounding parenthesis tokens for comment blocks, even if on a higher line than the corresponding AST structure
    • chore: update comment-parser and devDeps.

    Open source →
14. 0.40.14 Aug 2023
    Release notes2 sources agree

    • chore(TS): fix path issue

    Open source →
15. 0.40.04 Aug 2023
    Release notes2 sources agree

    • chore: update comment-parser and devDeps.
    • chore(TS): switch to NodeNext

    Open source →
16. 0.39.415 May 2023
    Release notes2 sources agree

    • fix: include type exports for full inlineTags (and line) property support on blocks and tags

    Open source →
17. 0.39.312 May 2023
    Release notes2 sources agree

    • fix: add type details for Node range and settings

    Open source →
18. 0.39.212 May 2023
    Release notes2 sources agree

    • fix: export additional typedefs from index.js

    Open source →
19. 0.39.111 May 2023
    Release notes2 sources agree

    • fix: typing export

    Open source →
20. 0.39.011 May 2023
    Release notes2 sources agree

    • feat: types for test files and emit declaration files
    • fix(estreeToString): add JsdodInlineTag stringify support
    • refactor: lint
    • docs: add JsdocInlineTag to README
    • chore: update devDeps.

    Open source →
21. 0.38.05 May 2023
    Release notes2 sources agree

    • feat: add parsing inline tags (#12); fixes #11

    Open source →
22. 0.37.118 Apr 2023
    Release notes2 sources agree

    • chore: support Node 20
    • chore: update esquery, devDeps.

    Open source →
23. 0.37.015 Mar 2023

    Nothing published for this version

24. 0.37.0-pre.014 Mar 2023pre-release
    Release notes2 sources agree

    • fix: update jsdoc-type-pratt-parser (supports bracket indexes)

    Open source →
25. 0.36.124 Nov 2022
    Release notes2 sources agree

    • fix(getReducedASTNode): stop checking for comment blocks at return statement

    Open source →
26. 0.36.02 Nov 2022
    Release notes2 sources agree

    • feat: add hasPreterminalTagDescription property
    • fix: avoid description line properties if tag is present
    • fix: ensure description and description lines added to terminal multi-line tag

    Open source →
27. 0.35.02 Nov 2022
    Release notes2 sources agree

    • feat: add hasPreterminalDescription property
    • fix: allow newline even for 1st line (after 0th)

    Open source →
28. 0.34.02 Nov 2022
    Release notes2 sources agree

    • feat: add descriptionStartLine and descriptionEndLine properties
    • fix: avoid duplication with 0 line comments
    • chore: update devDeps.

    Open source →
29. 0.33.425 Oct 2022
    Release notes2 sources agree

    • chore: republish as npm seems to have missed the release

    Open source →
30. 0.33.325 Oct 2022
    Release notes2 sources agree

    • fix: ensure multi-line description includes newline except for initial line descriptions

    Open source →
31. 0.33.225 Oct 2022
    Release notes2 sources agree

    • fix: avoid repetition within multi-line descriptions

    Open source →
32. 0.33.125 Oct 2022
    Release notes2 sources agree

    • fix: add to default no types: description, example, file, fileoverview, license, overview, see, summary
    • fix: add to no names: file, fileoverview,overview`

    Open source →
33. 0.33.018 Oct 2022
    Release notes2 sources agree

    • chore: add Node 19 to engines (@RodEsp)
    • chore: update devDeps. and build file accordingly

    Open source →
34. 0.32.04 Oct 2022
    Release notes2 sources agree

    • feat: have comment checking stop at assignment patterns (comments for defaults should not rise to function itself)
    • chore: bump devDeps.

    Open source →
35. 0.31.024 May 2022
    Release notes2 sources agree

    • feat: support default values with @template per https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#template

    Open source →
36. 0.30.019 May 2022
    Release notes2 sources agree

    • chore: bump jsdoc-type-pratt-parser and devDeps.

    Open source →
37. 0.29.024 Apr 2022
    Release notes2 sources agree

    • fix: update engines as per current getJSDocComment behavior
    • chore: update devDeps.

    Open source →
38. 0.28.124 Apr 2022
    Release notes2 sources agree

    • fix(getReducedASTNode): token checking
    • build: add Node 18 support (@WikiRik)

    Open source →
39. 0.28.020 Apr 2022
    Release notes2 sources agree

    • chore: bump engines to support Node 18

    Open source →
40. 0.27.019 Apr 2022
    Release notes2 sources agree

    • chore: bump jsdoc-type-pratt-parser and devDeps.

    Open source →
41. 0.26.119 Apr 2022
    Release notes2 sources agree

    • fix(estreeToString): ensure typeLines may be picked up

    Open source →
42. 0.26.019 Apr 2022
    Release notes2 sources agree

    • feat(getJSDocComment): allow function to detect comments just preceding a parenthesized expression (these have no special AST but their tokens have to be overpassed)

    Open source →
43. 0.25.018 Apr 2022
    Release notes2 sources agree

    • feat(parseComment): properly support whitespace
    • fix(estreeToString): carriage return placement for ending of JSDoc block
    • fix(commentParserToESTree): avoid adding initial space before a tag if on a single line
    • test: make tests more accurate to jsdoc semantically

    Open source →
44. 0.24.018 Apr 2022
    Release notes2 sources agree

    • feat(estreeToString): support stringification of parsedType but with a new preferRawType option allowing the old behavior of using rawType

    Open source →
45. 0.23.618 Apr 2022
    Release notes2 sources agree

    • fix(commentParserToESTree): ensure postType added after multi-line type
    • fix(estreeToString): ensure JsdocTypeLine stringified with initial and that they are joined together with newlines

    Open source →
46. 0.23.517 Apr 2022
    Release notes2 sources agree

    • fix(commentParserToESTree): avoid duplicating tag names

    Open source →
47. 0.23.417 Apr 2022
    Release notes2 sources agree

    • fix(estreeToString): add delimiter, etc. if adding JsdocDescriptionLine for JsdocBlock
    • fix(estreeToString): add line break when tags are present (unless already ending in newline)

    Open source →
48. 0.23.317 Apr 2022
    Release notes2 sources agree

    • fix(estreeToString): handle multi-line block descriptions followed by tags with line break

    Open source →
49. 0.23.217 Apr 2022
    Release notes2 sources agree

    • fix: ensure JsdocBlock stringifier has any initial whitespace on end line

    Open source →
50. 0.23.117 Apr 2022
    Release notes2 sources agree

    • docs(README): update

    Open source →
51. 0.23.017 Apr 2022
    Release notes2 sources agree

    • BREAKING CHANGE(commentParserToESTree): rename start and end to initial and terminal to avoid any conflicts with Acorn-style parsers
    • feat: add initial and terminal on JsdocBlock

    Open source →
52. 0.22.216 Apr 2022
    Release notes2 sources agree

    • fix: preserve type tokens
    • perf: cache tokenizers

    Open source →
53. 0.22.119 Mar 2022
    Release notes2 sources agree

    • fix: ensure getJSDocComment does not treat block comments as JSDoc unless their first asterisk is followed by whitespace

    Open source →
54. 0.22.019 Mar 2022
    Release notes2 sources agree

    • fix: update dep. jsdoc-type-pratt-parser
    • chore: update comment-parser and simplify as possible

    Open source →
55. 0.21.213 Mar 2022
    Release notes2 sources agree

    • fix: only throw if the raw type is not empty

    Open source →
56. 0.21.113 Mar 2022
    Release notes2 sources agree

    • fix: provide clearer error message for throwOnTypeParsingErrors

    Open source →
57. 0.21.013 Mar 2022
    Release notes2 sources agree

    • feat: add throwOnTypeParsingErrors to receive run-time type parsing errors for parsedType
    • chore: update jsdoc-type-pratt-parser and devDeps.; also lints

    Open source →
58. 0.20.118 Feb 2022
    Release notes2 sources agree

    • fix: resume catching bad parsed type (at least until jsdoc-type-pratt-parser may support all expected types)

    Open source →
59. 0.20.016 Feb 2022
    Release notes2 sources agree

    • feat: add estree stringifer
    • fix: properly supports name/postName for multi-line type
    • fix: allow pratt parser to fail (unless empty)
    • fix: don't add tag postDelimiter when on 0 description line
    • fix: avoid adding extra line when only name and no succeeding description
    • docs: clarify re: kind
    • test: add parsedType with correct mode; add tests
    • chore: updates jsdoc-type-pratt-parser
    • chore: updates devDeps.

    Open source →
60. 0.19.09 Feb 2022
    Release notes2 sources agree

    User-impacting

    • feat: treat @kind as having no name

    Dev-impacting

    • docs: jsdoc
    • test: begin checking jsdoccomment
    • test: adds lcov reporter and open script for it
    • chore: update devDeps.

    Open source →