@cjser/es-joy__jsdoccomment 0.96.0-cjser.2 → 0.98.0-cjser.2

package/CHANGES.md

@@ -1,5 +1,13 @@
 # CHANGES for `@es-joy/jsdoccomment`
 
+## 0.98.0
+
+- chore: update typescript-eslint/types, comment-parser, jsdoc-type-pratt-parser, devDeps
+
+## 0.97.0
+
+- fix: accept any AST node in the public comment-finding helpers regardless of `@typescript-eslint/types` version
+
 ## 0.96.0
 
 - feat: update jsdoc-type-pratt-parser and devDeps.

package/dist/index.d.ts

@@ -82,9 +82,9 @@ type CommentParserToESTreeOptions = {
    * By default, empty lines are
    * compacted; set to 'preserve' to preserve empty comment lines.
    */
-  spacing?: 'compact' | 'preserve';
-  throwOnTypeParsingErrors?: boolean;
-  jsdocTypePrattParserArgs?: JtppOptions;
+  spacing?: 'preserve' | 'compact' | undefined;
+  throwOnTypeParsingErrors?: boolean | undefined;
+  jsdocTypePrattParserArgs?: JtppOptions | undefined;
 };
 /**
  * @typedef {{
@@ -116,10 +116,10 @@ declare function commentParserToESTree(
 ): JsdocBlock;
 declare namespace jsdocVisitorKeys {
   let JsdocBlock: string[];
-  let JsdocDescriptionLine: any[];
-  let JsdocTypeLine: any[];
+  let JsdocDescriptionLine: never[];
+  let JsdocTypeLine: never[];
   let JsdocTag: string[];
-  let JsdocInlineTag: any[];
+  let JsdocInlineTag: never[];
 }
 
 /**
@@ -168,6 +168,23 @@ type Token =
       value: string;
     };
 type ESLintOrTSNode = eslint.Rule.Node | _typescript_eslint_types.TSESTree.Node;
+/**
+ * The type accepted in node parameter positions of the public comment-finding
+ * helpers. It is deliberately looser than {@link ESLintOrTSNode}: callers pass
+ * nodes typed against their own copy of `@typescript-eslint/types`, and when
+ * that copy differs from the one resolved here the two `TSESTree` unions are
+ * nominally distinct and, being large and recursive, can exceed the
+ * type-checker's comparison depth. Requiring only `type` lets any AST node
+ * through while the helpers narrow internally; return types keep the precise
+ * {@link ESLintOrTSNode}.
+ *
+ * `ESLintOrTSNode` is deliberately *not* part of this union: including it makes
+ * the checker relate arguments against the full recursive `TSESTree.Node` union
+ * anyway, which is what overflows.
+ */
+type ESLintOrTSNodeInput = {
+  type: string;
+};
 type int = number;
 type DecoratedNode =
   | ESLintOrTSNode
@@ -194,14 +211,14 @@ type Settings = {
  * Reduces the provided node to the appropriate node for evaluating
  * JSDoc comment status.
  *
- * @param {ESLintOrTSNode} node An AST node.
+ * @param {ESLintOrTSNodeInput} nodeInput An AST node.
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode.
  * @param {Settings} [settings]
  * @returns {ESLintOrTSNode} The AST node that
  *   can be evaluated for appropriate JSDoc comments.
  */
 declare function getReducedASTNode(
-  node: ESLintOrTSNode,
+  nodeInput: ESLintOrTSNodeInput,
   sourceCode: eslint.SourceCode,
   settings?: Settings,
 ): ESLintOrTSNode;
@@ -209,7 +226,7 @@ declare function getReducedASTNode(
  * Retrieves the JSDoc comment for a given node.
  *
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode
- * @param {ESLintOrTSNode} node The AST node to get
+ * @param {ESLintOrTSNodeInput} node The AST node to get
  *   the comment for.
  * @param {Settings} settings The settings in context
  * @param {{checkOverloads?: boolean}} [opts]
@@ -220,7 +237,7 @@ declare function getReducedASTNode(
  */
 declare function getJSDocComment(
   sourceCode: eslint.SourceCode,
-  node: ESLintOrTSNode,
+  node: ESLintOrTSNodeInput,
   settings: Settings,
   opts?: {
     checkOverloads?: boolean;
@@ -230,7 +247,7 @@ declare function getJSDocComment(
  * Retrieves the comment preceding a given node.
  *
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode
- * @param {ESLintOrTSNode} node The AST node to get
+ * @param {ESLintOrTSNodeInput} node The AST node to get
  *   the comment for.
  * @param {{maxLines: int, minLines: int, [name: string]: any}} settings The
  *   settings in context
@@ -241,7 +258,7 @@ declare function getJSDocComment(
  */
 declare function getNonJsdocComment(
   sourceCode: eslint.SourceCode,
-  node: ESLintOrTSNode,
+  node: ESLintOrTSNodeInput,
   settings: {
     maxLines: int;
     minLines: int;
@@ -263,7 +280,7 @@ declare function getDecorator(node: DecoratedNode): _typescript_eslint_types.TSE
 /**
  * Checks for the presence of a JSDoc comment for the given node and returns it.
  *
- * @param {ESLintOrTSNode} astNode The AST node to get
+ * @param {ESLintOrTSNodeInput} astNode The AST node to get
  *   the comment for.
  * @param {import('eslint').SourceCode} sourceCode
  * @param {{maxLines: int, minLines: int, [name: string]: any}} settings
@@ -272,7 +289,7 @@ declare function getDecorator(node: DecoratedNode): _typescript_eslint_types.TSE
  *    for the given node or null if not found.
  */
 declare function findJSDocComment(
-  astNode: ESLintOrTSNode,
+  astNode: ESLintOrTSNodeInput,
   sourceCode: eslint.SourceCode,
   settings: {
     maxLines: int;
@@ -290,12 +307,12 @@ declare function findJSDocComment(
  * This method is experimental.
  *
  * @param {import('eslint').SourceCode} sourceCode
- * @param {ESLintOrTSNode} astNode The AST node to get
+ * @param {ESLintOrTSNodeInput} astNodeInput The AST node to get
  *   the comment for.
  * @returns {Token|null} The comment token containing the comment
  *    for the given node or null if not found.
  */
-declare function getFollowingComment(sourceCode: eslint.SourceCode, astNode: ESLintOrTSNode): Token | null;
+declare function getFollowingComment(sourceCode: eslint.SourceCode, astNodeInput: ESLintOrTSNodeInput): Token | null;
 
 declare function hasSeeWithLink(spec: comment_parser.Spec): boolean;
 declare const defaultNoTypes: string[];
@@ -321,8 +338,8 @@ declare function getTokenizers({
   noTypes,
   noNames,
 }?: {
-  noTypes?: string[];
-  noNames?: string[];
+  noTypes?: string[] | undefined;
+  noNames?: string[] | undefined;
 }): CommentParserTokenizer[];
 /**
  * Accepts a comment token or complete comment string and converts it into
@@ -408,6 +425,7 @@ export type {
   CommentParserTokenizer,
   DecoratedNode,
   ESLintOrTSNode,
+  ESLintOrTSNodeInput,
   ESTreeToStringOptions,
   InlineTag,
   Integer,

package/dist-cjser/index.cjs

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/index.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/index.js
 var index_exports = {};
 __export(index_exports, {
   commentHandler: () => commentHandler,
@@ -52,11 +52,11 @@ module.exports = __toCommonJS(index_exports);
 var import_jsdoc_type_pratt_parser4 = require("@cjser/jsdoc-type-pratt-parser");
 __reExport(index_exports, require("@cjser/jsdoc-type-pratt-parser"), module.exports);
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/commentHandler.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/commentHandler.js
 var import_esquery = __toESM(require("esquery"), 1);
 var import_jsdoc_type_pratt_parser2 = require("@cjser/jsdoc-type-pratt-parser");
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/commentParserToESTree.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/commentParserToESTree.js
 var import_jsdoc_type_pratt_parser = require("@cjser/jsdoc-type-pratt-parser");
 var stripEncapsulatingBrackets = (container, isArr) => {
   if (isArr) {
@@ -230,7 +230,9 @@ var commentParserToESTree = (jsdoc, mode = "typescript", {
           i++;
         }
       }
-      const tagInlineTags = tag ? (
+      const tagInlineTags = (
+        // Assuming the tags from `source` are in the same order as `jsdoc.tags`
+        // we can use the `tags` length as index into the parser result tags.
         /**
          * @type {import('comment-parser').Spec & {
          *   inlineTags: JsdocInlineTagNoType[]
@@ -239,7 +241,7 @@ var commentParserToESTree = (jsdoc, mode = "typescript", {
         jsdoc.tags[tags.length].inlineTags.map(
           (t) => inlineTagToAST(t)
         )
-      ) : [];
+      );
       const tagObj = {
         ...tkns,
         initial: endLine ? init : "",
@@ -340,7 +342,7 @@ var jsdocVisitorKeys = {
   JsdocInlineTag: []
 };
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/commentHandler.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/commentHandler.js
 var commentHandler = (settings, commentParserToESTreeOptions) => {
   return (commentSelector, jsdoc) => {
     const { mode } = settings;
@@ -369,10 +371,10 @@ var commentHandler = (settings, commentParserToESTreeOptions) => {
   };
 };
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/estreeToString.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/estreeToString.js
 var import_jsdoc_type_pratt_parser3 = require("@cjser/jsdoc-type-pratt-parser");
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/inlineTagEscapes.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/inlineTagEscapes.js
 function getLabelDelimiter(format) {
   return format === "prefix" ? "]" : "}";
 }
@@ -416,7 +418,7 @@ function encodeInlineTagText(text, format) {
   return encoded;
 }
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/estreeToString.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/estreeToString.js
 var stringifiers = {
   /* eslint-enable jsdoc/reject-function-type -- Different functions */
   JsdocBlock,
@@ -572,7 +574,7 @@ function JsdocTag(node, opts) {
   return result;
 }
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/jsdoccomment.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/jsdoccomment.js
 var isCommentToken = (token) => {
   return ["Line", "Block", "Shebang"].includes(token.type);
 };
@@ -682,12 +684,13 @@ var allowableCommentNode = /* @__PURE__ */ new Set([
   "ExportDefaultDeclaration",
   "ReturnStatement"
 ]);
-var getReducedASTNode = function(node, sourceCode, settings) {
-  let { parent } = node;
-  switch (
+var getReducedASTNode = function(nodeInput, sourceCode, settings) {
+  const node = (
     /** @type {ESLintOrTSNode} */
-    node.type
-  ) {
+    nodeInput
+  );
+  let { parent } = node;
+  switch (node.type) {
     case "TSFunctionType":
       return getTSFunctionComment(node);
     case "TSInterfaceDeclaration":
@@ -750,7 +753,10 @@ var getReducedASTNode = function(node, sourceCode, settings) {
 var findJSDocComment = (astNode, sourceCode, settings, opts = {}) => {
   const { nonJSDoc } = opts;
   const { minLines, maxLines } = settings;
-  let currentNode = astNode;
+  let currentNode = (
+    /** @type {ESLintOrTSNode} */
+    astNode
+  );
   let tokenBefore = null;
   let parenthesisToken = null;
   while (currentNode) {
@@ -936,7 +942,11 @@ var compareLocEndToStart = (nodeA, nodeB) => {
   var _a, _b;
   return (((_a = nodeA.loc) == null ? void 0 : _a.end.line) ?? 0) === (((_b = nodeB.loc) == null ? void 0 : _b.start.line) ?? 0);
 };
-var getFollowingComment = function(sourceCode, astNode) {
+var getFollowingComment = function(sourceCode, astNodeInput) {
+  const astNode = (
+    /** @type {ESLintOrTSNode} */
+    astNodeInput
+  );
   const getTokensAfterIgnoringSemis = (node) => {
     let tokenAfter2 = sourceCode.getTokenAfter(
       /** @type {import('eslint').Rule.Node} */
@@ -978,10 +988,10 @@ var getFollowingComment = function(sourceCode, astNode) {
   return tokenAfter;
 };
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/parseComment.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/parseComment.js
 var import_comment_parser = require("comment-parser");
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/parseInlineTags.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/parseInlineTags.js
 function determineFormat(match) {
   const { separator, text } = match.groups;
   const [, textEnd] = match.indices.groups.text;
@@ -1020,7 +1030,10 @@ function parseDescription(description) {
       mtch
     );
     const { tag, namepathOrURL, text } = match.groups;
-    const [start, end] = match.indices[0];
+    const [start, end] = (
+      /** @type {[number, number]} */
+      match.indices[0]
+    );
     const format = determineFormat(match);
     const decodedText = decodeInlineTagText(text, format);
     result.push({
@@ -1055,7 +1068,7 @@ function parseInlineTags(block) {
   );
 }
 
-// packages/@cjser/es-joy__jsdoccomment.tmp-26-1788540365480/src/parseComment.js
+// packages/@cjser/es-joy__jsdoccomment.tmp-26-1789749139393/src/parseComment.js
 var {
   name: nameTokenizer,
   tag: tagTokenizer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cjser/es-joy__jsdoccomment",
-  "version": "0.96.0-cjser.2",
+  "version": "0.98.0-cjser.2",
   "author": "Brett Zamir <brettz9@yahoo.com>",
   "contributors": [],
   "description": "Maintained replacement for ESLint's deprecated SourceCode#getJSDocComment along with other jsdoc utilities",
@@ -45,32 +45,32 @@
   },
   "dependencies": {
     "@types/estree": "^1.0.9",
-    "@typescript-eslint/types": "^8.67.0",
-    "comment-parser": "1.4.8",
+    "@typescript-eslint/types": "^8.70.0",
+    "comment-parser": "1.4.9",
     "esquery": "^1.7.0",
-    "@cjser/jsdoc-type-pratt-parser": "9.2.1-cjser.2"
+    "@cjser/jsdoc-type-pratt-parser": "9.2.2-cjser.2"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
-    "@brettz9/node-static": "^0.1.1",
+    "@node-static/node-static": "^0.10.0",
     "@types/esquery": "^1.5.4",
     "@types/estraverse": "^5.1.7",
-    "@typescript-eslint/visitor-keys": "^8.67.0",
+    "@typescript-eslint/visitor-keys": "^8.70.0",
     "@typhonjs-build-test/esm-d-ts": "0.4.0",
     "@typhonjs-typedoc/typedoc-pkg": "^0.4.2",
-    "@vitest/coverage-v8": "^4.1.11",
-    "@vitest/ui": "^4.1.11",
-    "@webcoder49/code-input": "^2.8.3",
-    "eslint": "^10.9.0",
-    "eslint-config-ash-nazg": "42.6.0",
-    "eslint-plugin-jsdoc": "^64.2.1",
+    "@vitest/coverage-v8": "^5.0.1",
+    "@vitest/ui": "^5.0.1",
+    "@webcoder49/code-input": "^2.8.4",
+    "eslint": "^10.10.0",
+    "eslint-config-ash-nazg": "43.1.10",
+    "eslint-plugin-jsdoc": "^64.5.2",
     "espree": "^11.2.0",
     "estraverse": "^5.3.0",
     "prismjs": "^1.30.0",
     "typedoc": "^0.28.20",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.67.0",
-    "vitest": "^4.1.11"
+    "typescript": "6.0.3",
+    "typescript-eslint": "^8.70.0",
+    "vitest": "^5.0.1"
   },
   "files": [
     "/dist",
@@ -92,15 +92,16 @@
     "test-ui": "vitest --ui --coverage",
     "test-cov": "vitest --coverage",
     "tsc": "tsc",
+    "tsc:ts7": "npx -y -p typescript@^7 -c \"tsc\"",
     "types": "esm-d-ts gen ./src/index.js --output ./dist/index.d.ts"
   },
   "main": "./dist-cjser/index.cjs",
   "cjser": {
-    "sourceVersion": "0.96.0",
+    "sourceVersion": "0.98.0",
     "cjserVersion": 2,
     "original": {
       "name": "@es-joy/jsdoccomment",
-      "version": "0.96.0",
+      "version": "0.98.0",
       "exports": {
         ".": {
           "types": "./dist/index.d.ts",
@@ -113,10 +114,10 @@
       },
       "dependencies": {
         "@types/estree": "^1.0.9",
-        "@typescript-eslint/types": "^8.67.0",
-        "comment-parser": "1.4.8",
+        "@typescript-eslint/types": "^8.70.0",
+        "comment-parser": "1.4.9",
         "esquery": "^1.7.0",
-        "jsdoc-type-pratt-parser": "~9.2.0"
+        "jsdoc-type-pratt-parser": "~9.2.2"
       },
       "files": [
         "/dist",
@@ -137,6 +138,7 @@
         "test-ui": "vitest --ui --coverage",
         "test-cov": "vitest --coverage",
         "tsc": "tsc",
+        "tsc:ts7": "npx -y -p typescript@^7 -c \"tsc\"",
         "types": "esm-d-ts gen ./src/index.js --output ./dist/index.d.ts"
       }
     }

package/src/commentParserToESTree.js

@@ -359,11 +359,9 @@ const commentParserToESTree = (jsdoc, mode = 'typescript', {
       /**
        * @type {JsdocInlineTag[]}
        */
-      const tagInlineTags = tag
-        // Assuming the tags from `source` are in the same order as `jsdoc.tags`
-        // we can use the `tags` length as index into the parser result tags.
-        // eslint-disable-next-line @stylistic/operator-linebreak -- Required
-        ?
+      const tagInlineTags =
+      // Assuming the tags from `source` are in the same order as `jsdoc.tags`
+      // we can use the `tags` length as index into the parser result tags.
         /**
          * @type {import('comment-parser').Spec & {
          *   inlineTags: JsdocInlineTagNoType[]
@@ -372,8 +370,7 @@ const commentParserToESTree = (jsdoc, mode = 'typescript', {
           jsdoc.tags[tags.length]
         ).inlineTags.map(
           (t) => inlineTagToAST(t)
-        )
-        : [];
+        );
 
       /** @type {JsdocTag} */
       const tagObj = {

package/src/jsdoccomment.js

@@ -18,6 +18,22 @@
  *   import('@typescript-eslint/types').TSESTree.Node} ESLintOrTSNode
  */
 
+/**
+ * The type accepted in node parameter positions of the public comment-finding
+ * helpers. It is deliberately looser than {@link ESLintOrTSNode}: callers pass
+ * nodes typed against their own copy of `@typescript-eslint/types`, and when
+ * that copy differs from the one resolved here the two `TSESTree` unions are
+ * nominally distinct and, being large and recursive, can exceed the
+ * type-checker's comparison depth. Requiring only `type` lets any AST node
+ * through while the helpers narrow internally; return types keep the precise
+ * {@link ESLintOrTSNode}.
+ *
+ * `ESLintOrTSNode` is deliberately *not* part of this union: including it makes
+ * the checker relate arguments against the full recursive `TSESTree.Node` union
+ * anyway, which is what overflows.
+ * @typedef {{type: string}} ESLintOrTSNodeInput
+ */
+
 /**
  * @typedef {number} int
  */
@@ -202,15 +218,16 @@ const allowableCommentNode = new Set([
  * Reduces the provided node to the appropriate node for evaluating
  * JSDoc comment status.
  *
- * @param {ESLintOrTSNode} node An AST node.
+ * @param {ESLintOrTSNodeInput} nodeInput An AST node.
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode.
  * @param {Settings} [settings]
  * @returns {ESLintOrTSNode} The AST node that
  *   can be evaluated for appropriate JSDoc comments.
  */
-const getReducedASTNode = function (node, sourceCode, settings) {
+const getReducedASTNode = function (nodeInput, sourceCode, settings) {
+  const node = /** @type {ESLintOrTSNode} */ (nodeInput);
   let {parent} = node;
-  switch (/** @type {ESLintOrTSNode} */ (node).type) {
+  switch (node.type) {
   case 'TSFunctionType':
     return getTSFunctionComment(node);
   case 'TSInterfaceDeclaration':
@@ -296,7 +313,7 @@ const getReducedASTNode = function (node, sourceCode, settings) {
 /**
  * Checks for the presence of a JSDoc comment for the given node and returns it.
  *
- * @param {ESLintOrTSNode} astNode The AST node to get
+ * @param {ESLintOrTSNodeInput} astNode The AST node to get
  *   the comment for.
  * @param {import('eslint').SourceCode} sourceCode
  * @param {{maxLines: int, minLines: int, [name: string]: any}} settings
@@ -309,7 +326,7 @@ const findJSDocComment = (astNode, sourceCode, settings, opts = {}) => {
   const {minLines, maxLines} = settings;
 
   /** @type {ESLintOrTSNode|import('estree').Comment} */
-  let currentNode = astNode;
+  let currentNode = /** @type {ESLintOrTSNode} */ (astNode);
   let tokenBefore = null;
   let parenthesisToken = null;
 
@@ -557,7 +574,7 @@ const getPreviousOverloadSibling = (node) => {
  * Retrieves the JSDoc comment for a given node.
  *
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode
- * @param {ESLintOrTSNode} node The AST node to get
+ * @param {ESLintOrTSNodeInput} node The AST node to get
  *   the comment for.
  * @param {Settings} settings The settings in context
  * @param {{checkOverloads?: boolean}} [opts]
@@ -592,7 +609,7 @@ const getJSDocComment = function (sourceCode, node, settings, opts = {}) {
  * Retrieves the comment preceding a given node.
  *
  * @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode
- * @param {ESLintOrTSNode} node The AST node to get
+ * @param {ESLintOrTSNodeInput} node The AST node to get
  *   the comment for.
  * @param {{maxLines: int, minLines: int, [name: string]: any}} settings The
  *   settings in context
@@ -629,12 +646,13 @@ const compareLocEndToStart = (nodeA, nodeB) => {
  * This method is experimental.
  *
  * @param {import('eslint').SourceCode} sourceCode
- * @param {ESLintOrTSNode} astNode The AST node to get
+ * @param {ESLintOrTSNodeInput} astNodeInput The AST node to get
  *   the comment for.
  * @returns {Token|null} The comment token containing the comment
  *    for the given node or null if not found.
  */
-const getFollowingComment = function (sourceCode, astNode) {
+const getFollowingComment = function (sourceCode, astNodeInput) {
+  const astNode = /** @type {ESLintOrTSNode} */ (astNodeInput);
   /**
    * @param {ESLintOrTSNode} node The
    *   AST node to get the comment for.

package/src/parseInlineTags.js

@@ -64,7 +64,9 @@ function parseDescription (description) {
         mtch
       );
     const {tag, namepathOrURL, text} = match.groups;
-    const [start, end] = match.indices[0];
+    // `indices[0]` (the whole-match span) is always present for a successful
+    // match under the `d` flag, though the type includes `undefined`.
+    const [start, end] = /** @type {[number, number]} */ (match.indices[0]);
     const format = determineFormat(match);
     const decodedText = decodeInlineTagText(text, format);