NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #3793 most downloaded on npm
Maintained replacement for ESLint's deprecated SourceCode#getJSDocComment along with other jsdoc utilities
Last release 16 days ago
18 Sep 2026
Ships fairly regularly
a new release about every 3 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
5 years old
165 releases · first in 2021
One column per quarter.
fix(jsdoccomment): ensure overloading check looks to identically named functions only
jsdoccomment): ensure overloading check looks to identically named functions onlyfix(jsdoccomment): find overload comment
jsdoccomment): find overload comment- fix: remove @types/eslint (#20) Thanks: - @ocavue
fix: for TSFunctionType part of TSTypeAliasDeclaration and export, return export
TSFunctionType part of TSTypeAliasDeclaration and export, return exportchore: add .d.cts file / add type dependencies
BREAKING CHANGES:
.d.cts file / add type dependencies (#19)Thanks:
fix: avoid changing name for @template; should be able to recover optional brackets and defaults in AST
name for @template; should be able to recover
optional brackets and defaults in ASTchore: bump jsdoc-type-pratt-parser and devDeps.
fix(parseComment): assume closing bracket of name is final instead of first one
parseComment): assume closing bracket of name is final instead of
first onechore: update esquery, drop bundling of types, update devDeps
feat: get following comment (experimental)
feat: add getNonJsdocComment for getting non-JSDoc comments above node
getNonJsdocComment for getting non-JSDoc comments above nodefix: for @template name parsing, ensure (default-)bracketed name is not broken with internal spaces.
@template name parsing, ensure (default-)bracketed name is not broken with internal spaces.This release brings surgical round trip parsing to generated AST and reconstruction of JSDoc comment blocks via: parseComment -> commentParserToESTree
This release brings surgical round trip parsing to generated AST and reconstruction of JSDoc comment blocks via: parseComment ->
commentParserToESTree -> estreeToString.
spacing for commentParserToESTree; the default is compact removing empty description lines.Set to preserve to retain empty description lines.
JsdocBlock generated AST delimiterLineBreak and preterminalLineBreak that encodeany line break after the opening delimiter and before the closing terminal string. Values are either \n or an
empty string.
Thanks:
feat: expand argument for parseComment to accept a comment token string (@typhonrt)
parseComment to accept a comment token string (@typhonrt)feat: look above surrounding parenthesis tokens for comment blocks, even if on a higher line than the corresponding AST structure
- chore(TS): fix path issue
chore: update comment-parser and devDeps.
fix: include type exports for full inlineTags (and line) property support on blocks and tags
fix: add type details for Node range and settings
fix: export additional typedefs from index.js
- fix: typing export
feat: types for test files and emit declaration files
JsdodInlineTag stringify supportJsdocInlineTag to READMEfeat: add parsing inline tags (#12); fixes #11
chore: update esquery, devDeps.
Nothing published for this version
fix: update jsdoc-type-pratt-parser (supports bracket indexes)
jsdoc-type-pratt-parser (supports bracket indexes)fix(getReducedASTNode): stop checking for comment blocks at return statement
getReducedASTNode): stop checking for comment blocks at return
statementfeat: add hasPreterminalTagDescription property
hasPreterminalTagDescription propertyfeat: add hasPreterminalDescription property
hasPreterminalDescription propertyfeat: add descriptionStartLine and descriptionEndLine properties
descriptionStartLine and descriptionEndLine propertieschore: republish as npm seems to have missed the release
fix: ensure multi-line description includes newline except for initial line descriptions
description includes newline except for
initial line descriptionsfix: avoid repetition within multi-line descriptions
fix: add to default no types: description, example, file, fileoverview, license, overview, see, summary
description, example, file,
fileoverview, license, overview, see, summaryfile, fileoverview,overview`chore: add Node 19 to engines (@RodEsp)
engines (@RodEsp)feat: have comment checking stop at assignment patterns (comments for defaults should not rise to function itself)
feat: support default values with @template per
@template per
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#templatechore: bump jsdoc-type-pratt-parser and devDeps.
jsdoc-type-pratt-parser and devDeps.fix: update engines as per current getJSDocComment behavior
engines as per current getJSDocComment behaviorfix(getReducedASTNode): token checking
getReducedASTNode): token checkingchore: bump engines to support Node 18
engines to support Node 18chore: bump jsdoc-type-pratt-parser and devDeps.
jsdoc-type-pratt-parser and devDeps.fix(estreeToString): ensure typeLines may be picked up
estreeToString): ensure typeLines may be picked upfeat(getJSDocComment): allow function to detect comments just preceding a parenthesized expression (these have no special AST but their tokens have to
getJSDocComment): allow function to detect comments just preceding a
parenthesized expression (these have no special AST but their tokens
have to be overpassed)feat(parseComment): properly support whitespace
parseComment): properly support whitespaceestreeToString): carriage return placement for ending of JSDoc blockcommentParserToESTree): avoid adding initial space before a tag if on
a single linefeat(estreeToString): support stringification of parsedType but with a new preferRawType option allowing the old behavior of using rawType
estreeToString): support stringification of parsedType but with
a new preferRawType option allowing the old behavior of using rawTypefix(commentParserToESTree): ensure postType added after multi-line type
commentParserToESTree): ensure postType added after multi-line typeestreeToString): ensure JsdocTypeLine stringified with initial and
that they are joined together with newlinesfix(commentParserToESTree): avoid duplicating tag names
commentParserToESTree): avoid duplicating tag namesfix(estreeToString): add delimiter, etc. if adding JsdocDescriptionLine for JsdocBlock
estreeToString): add delimiter, etc. if adding JsdocDescriptionLine
for JsdocBlockestreeToString): add line break when tags are present (unless already
ending in newline)fix(estreeToString): handle multi-line block descriptions followed by tags with line break
estreeToString): handle multi-line block descriptions followed by
tags with line breakfix: ensure JsdocBlock stringifier has any initial whitespace on end line
- docs(README): update
BREAKING CHANGE(commentParserToESTree): rename start and end to initial and terminal to avoid any conflicts with Acorn-style parsers
commentParserToESTree): rename start and end to
initial and terminal to avoid any conflicts with Acorn-style parsersinitial and terminal on JsdocBlock- fix: preserve type tokens - perf: cache tokenizers
fix: ensure getJSDocComment does not treat block comments as JSDoc unless their first asterisk is followed by whitespace
getJSDocComment does not treat block comments as JSDoc unless
their first asterisk is followed by whitespacefix: update dep. jsdoc-type-pratt-parser
jsdoc-type-pratt-parsercomment-parser and simplify as possiblefix: only throw if the raw type is not empty
fix: provide clearer error message for throwOnTypeParsingErrors
throwOnTypeParsingErrorsfeat: add throwOnTypeParsingErrors to receive run-time type parsing errors for parsedType
throwOnTypeParsingErrors to receive run-time type parsing errors
for parsedTypefix: resume catching bad parsed type (at least until jsdoc-type-pratt-parser may support all expected types)
jsdoc-type-pratt-parser may support all expected types)Your coding agent can read these notes before it upgrades. Set up the MCP server →