eslint-plugin-jsdoc 63.1.0 → 63.2.1

package/dist/rules/normalizeSeeLinks.cjs

@@ -14,6 +14,7 @@ const prefixLinkAttemptRegex = /(?<!\\)\[[^\]\r\n]*\]\{@link[^\}\r\n]*(?:\}|$)/v
 const pipeLinkAttemptRegex = /\{@link[^\}\r\n]*\|[^\}\r\n]*(?:\}|$)/v;
 const scopedPackageNameRegex = /^@[\w.\-]+\/[\w.\-]+/v;
 const markdownCodeSpanRegex = /(?<!\\)(`+)(?!`)[\s\S]*?(?<!`)\1(?!`)/gv;
+const bareHttpUrlRegex = /^https?:\S+$/v;
 
 /**
  * @param {'pipe'|'prefix'} canonicalForm
@@ -38,6 +39,36 @@ const encodeLinkTarget = target => {
   return encodeURI(target).replaceAll(/%25(?=[\dA-F]{2})/giv, '%');
 };
 
+/**
+ * @param {string} description
+ * @param {boolean} enabled
+ * @returns {string|null}
+ */
+const getBareHttpUrl = (description, enabled) => {
+  if (!enabled) {
+    return null;
+  }
+  const trimmedDescription = description.trim();
+  return bareHttpUrlRegex.test(trimmedDescription) && URL.canParse(trimmedDescription) ? trimmedDescription : null;
+};
+
+/**
+ * @param {string} target
+ * @returns {string}
+ */
+const formatBareUrl = target => {
+  return `{@link ${encodeLinkTarget(target)}}`;
+};
+
+/**
+ * @param {string|undefined} bareUrl
+ * @param {'pipe'|'prefix'} canonicalForm
+ * @returns {string}
+ */
+const getExpectedMessage = (bareUrl, canonicalForm) => {
+  return bareUrl ? 'Expected bare @see URL to use a {@link} tag.' : `Expected @see link to use the ${canonicalForm} form.`;
+};
+
 /**
  * @param {string} description
  * @param {number} index
@@ -91,12 +122,15 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
 }) => {
   const {
     canonicalForm = 'pipe',
-    enableFixer = true
+    enableFixer = true,
+    wrapBareUrls = false
   } = context.options[0] || {};
   const descriptionMatcher = canonicalForm === 'pipe' ? new RegExp(`${markdownLinkRegex.source}|${prefixLinkRegex.source}`, 'v') : new RegExp(`${markdownLinkRegex.source}|${pipeLinkRegex.source}`, 'v');
 
   /** @type {import('comment-parser').Spec[]} */
   const fixableTags = [];
+  /** @type {Map<import('comment-parser').Spec, string>} */
+  const bareUrlTags = new Map();
   for (const tag of jsdoc.tags) {
     if (tag.tag !== 'see') {
       continue;
@@ -106,6 +140,11 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
     const rawDescription = firstTokens.name ? firstTokens.name + firstTokens.postName + tagDescription : tagDescription;
     let hasAmbiguousLink = false;
     let hasNoncanonicalLink = false;
+    const bareUrl = getBareHttpUrl(rawDescription, wrapBareUrls);
+    if (bareUrl) {
+      bareUrlTags.set(tag, bareUrl);
+      hasNoncanonicalLink = true;
+    }
     for (const match of rawDescription.matchAll(markdownLinkRegex)) {
       const label = match[1];
       const target = match[2];
@@ -153,7 +192,8 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
     fixableTags.push(tag);
   }
   for (const [reportIdx, tag] of fixableTags.entries()) {
-    utils.reportJSDoc(`Expected @see link to use the ${canonicalForm} form.`, {
+    const bareUrl = bareUrlTags.get(tag);
+    utils.reportJSDoc(getExpectedMessage(bareUrl, canonicalForm), {
       line: tag.source[0].number
     }, enableFixer && reportIdx === 0 ? () => {
       for (const fixableTag of fixableTags) {
@@ -163,6 +203,19 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
           firstTokens.name = '';
           firstTokens.postName = '';
         }
+        const fixableBareUrl = bareUrlTags.get(fixableTag);
+        if (fixableBareUrl) {
+          for (const source of fixableTag.source) {
+            if (!source.tokens.description.includes(fixableBareUrl)) {
+              continue;
+            }
+            source.tokens.description = source.tokens.description.replace(fixableBareUrl, () => {
+              return formatBareUrl(fixableBareUrl);
+            });
+            break;
+          }
+          continue;
+        }
         for (let sourceIdx = 0; sourceIdx < fixableTag.source.length; sourceIdx++) {
           if (!descriptionMatcher.test(fixableTag.source[sourceIdx].tokens.description)) {
             continue;
@@ -193,6 +246,10 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
         enableFixer: {
           description: 'Whether to enable the fixer. Defaults to `true`.',
           type: 'boolean'
+        },
+        wrapBareUrls: {
+          description: 'Whether to wrap an `@see` description containing only a lowercase `http:` or `https:` URL (for example, `@see https://example.com`) in a plain `{@link https://example.com}`. Defaults to `false`.',
+          type: 'boolean'
         }
       },
       type: 'object'

package/dist/rules/normalizeSeeLinks.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeSeeLinks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/normalizeSeeLinks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst markdownLinkRegex = /(?<!\\\\)\\[([^`\\]\\r\\n]+)\\]\\(([^`\\(\\)\\s]+)\\)/gv;\nconst prefixLinkRegex = /(?<!\\\\)\\[([^\\]\\r\\n]+)\\]\\{@link\\s+([^\\}\\s\\|]+)\\}/gv;\nconst pipeLinkRegex = /\\{@link\\s+([^\\}\\s\\|]+)\\s*\\|\\s*([^\\}\\r\\n]+)\\}/gv;\n\nconst markdownLinkAttemptRegex = /(?<!\\\\)\\[[^\\]\\r\\n]*\\]\\([^\\r\\n]*(?:\\)|$)/v;\nconst prefixLinkAttemptRegex = /(?<!\\\\)\\[[^\\]\\r\\n]*\\]\\{@link[^\\}\\r\\n]*(?:\\}|$)/v;\nconst pipeLinkAttemptRegex = /\\{@link[^\\}\\r\\n]*\\|[^\\}\\r\\n]*(?:\\}|$)/v;\n\nconst scopedPackageNameRegex = /^@[\\w.\\-]+\\/[\\w.\\-]+/v;\nconst markdownCodeSpanRegex = /(?<!\\\\)(`+)(?!`)[\\s\\S]*?(?<!`)\\1(?!`)/gv;\n\n/**\n * @param {'pipe'|'prefix'} canonicalForm\n * @param {string} label\n * @returns {boolean}\n */\nconst cannotSafelyFormatLink = (canonicalForm, label) => {\n  if (!label.trim()) {\n    return true;\n  }\n\n  if (canonicalForm === 'pipe') {\n    return label.includes('}');\n  }\n\n  return label.includes(']');\n};\n\n/**\n * @param {string} target\n * @returns {string}\n */\nconst encodeLinkTarget = (target) => {\n  return encodeURI(target).replaceAll(/%25(?=[\\dA-F]{2})/giv, '%');\n};\n\n/**\n * @param {string} description\n * @param {number} index\n * @returns {boolean}\n */\nconst isInsideMarkdownCodeSpan = (description, index) => {\n  for (const match of description.matchAll(markdownCodeSpanRegex)) {\n    const delimiterLength = match[1].length;\n    const contentStart = match.index + delimiterLength;\n    const contentEnd = match.index + match[0].length - delimiterLength;\n\n    if (index >= contentStart && index < contentEnd) {\n      return true;\n    }\n  }\n\n  return false;\n};\n\n/**\n * @param {'pipe'|'prefix'} canonicalForm\n * @param {string} label\n * @param {string} target\n * @returns {string}\n */\nconst formatLink = (canonicalForm, label, target) => {\n  const encodedTarget = encodeLinkTarget(target);\n\n  return canonicalForm === 'pipe' ?\n    `{@link ${encodedTarget}|${label.trim()}}` :\n    `[${label.trim()}]{@link ${encodedTarget}}`;\n};\n\n/**\n * @param {string} description\n * @param {'pipe'|'prefix'} canonicalForm\n * @returns {string}\n */\nconst normalizeDescription = (description, canonicalForm) => {\n  const markdownNormalized = description.replaceAll(\n    new RegExp(markdownLinkRegex, 'gv'),\n    (_match, label, target) => {\n      return formatLink(canonicalForm, label, target);\n    },\n  );\n\n  if (canonicalForm === 'pipe') {\n    return markdownNormalized.replaceAll(\n      new RegExp(prefixLinkRegex, 'gv'),\n      (_match, label, target) => {\n        return formatLink(canonicalForm, label, target);\n      },\n    );\n  }\n\n  return markdownNormalized.replaceAll(\n    new RegExp(pipeLinkRegex, 'gv'),\n    (_match, target, label) => {\n      return formatLink(canonicalForm, label, target);\n    },\n  );\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    canonicalForm = 'pipe',\n    enableFixer = true,\n  } = context.options[0] || {};\n\n  const descriptionMatcher = canonicalForm === 'pipe' ?\n    new RegExp(`${markdownLinkRegex.source}|${prefixLinkRegex.source}`, 'v') :\n    new RegExp(`${markdownLinkRegex.source}|${pipeLinkRegex.source}`, 'v');\n\n  /** @type {import('comment-parser').Spec[]} */\n  const fixableTags = [];\n\n  for (const tag of jsdoc.tags) {\n    if (tag.tag !== 'see') {\n      continue;\n    }\n\n    const firstTokens = tag.source[0].tokens;\n    const tagDescription = String(utils.getTagDescription(tag));\n    const rawDescription = firstTokens.name ?\n      firstTokens.name + firstTokens.postName + tagDescription :\n      tagDescription;\n\n    let hasAmbiguousLink = false;\n    let hasNoncanonicalLink = false;\n\n    for (const match of rawDescription.matchAll(markdownLinkRegex)) {\n      const label = match[1];\n      const target = match[2];\n\n      if (\n        isInsideMarkdownCodeSpan(rawDescription, match.index) ||\n        scopedPackageNameRegex.test(target) ||\n        cannotSafelyFormatLink(canonicalForm, label)\n      ) {\n        hasAmbiguousLink = true;\n      } else {\n        hasNoncanonicalLink = true;\n      }\n    }\n\n    for (const inlineTag of tag.inlineTags) {\n      if (inlineTag.tag !== 'link' || !inlineTag.text) {\n        continue;\n      }\n\n      if (inlineTag.format === 'space') {\n        hasAmbiguousLink = true;\n        continue;\n      }\n\n      if (cannotSafelyFormatLink(\n        canonicalForm,\n        inlineTag.text,\n      )) {\n        hasAmbiguousLink = true;\n        continue;\n      }\n\n      if (inlineTag.format === canonicalForm) {\n        continue;\n      }\n\n      const {\n        start,\n      } = /** @type {typeof inlineTag & {start: number}} */ (inlineTag);\n\n      if (\n        isInsideMarkdownCodeSpan(rawDescription, start) ||\n        scopedPackageNameRegex.test(inlineTag.namepathOrURL)\n      ) {\n        hasAmbiguousLink = true;\n      } else {\n        hasNoncanonicalLink = true;\n      }\n    }\n\n    const unrecognizedLinkText = rawDescription\n      .replaceAll(new RegExp(markdownLinkRegex, 'gv'), '')\n      .replaceAll(new RegExp(prefixLinkRegex, 'gv'), '')\n      .replaceAll(new RegExp(pipeLinkRegex, 'gv'), '');\n\n    hasAmbiguousLink ||= markdownLinkAttemptRegex.test(unrecognizedLinkText) ||\n      prefixLinkAttemptRegex.test(unrecognizedLinkText) ||\n      pipeLinkAttemptRegex.test(unrecognizedLinkText);\n\n    if (hasAmbiguousLink) {\n      utils.reportJSDoc('@see link cannot be safely normalized.', {\n        line: tag.source[0].number,\n      }, null);\n      continue;\n    }\n\n    if (!hasNoncanonicalLink) {\n      continue;\n    }\n\n    fixableTags.push(tag);\n  }\n\n  for (const [\n    reportIdx,\n    tag,\n  ] of fixableTags.entries()) {\n    utils.reportJSDoc(\n      `Expected @see link to use the ${canonicalForm} form.`,\n      {\n        line: tag.source[0].number,\n      },\n      enableFixer && reportIdx === 0 ?\n        () => {\n          for (const fixableTag of fixableTags) {\n            const firstTokens = fixableTag.source[0].tokens;\n\n            if (firstTokens.name) {\n              firstTokens.description = firstTokens.name +\n                firstTokens.postName + firstTokens.description;\n              firstTokens.name = '';\n              firstTokens.postName = '';\n            }\n\n            for (\n              let sourceIdx = 0;\n              sourceIdx < fixableTag.source.length;\n              sourceIdx++\n            ) {\n              if (!descriptionMatcher.test(\n                fixableTag.source[sourceIdx].tokens.description,\n              )) {\n                continue;\n              }\n\n              utils.setTagDescription(\n                fixableTag,\n                descriptionMatcher,\n                (description) => {\n                  return normalizeDescription(description, canonicalForm);\n                },\n              );\n            }\n          }\n        } :\n        null,\n      true,\n    );\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Normalizes labeled links in `@see` tags to a canonical `{@link}` form.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/normalize-see-links.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          canonicalForm: {\n            description: 'The canonical `{@link}` form: `\"pipe\"` produces `{@link url|label}`, while `\"prefix\"` produces `[label]{@link url}`. Defaults to `\"pipe\"`.',\n            enum: [\n              'pipe',\n              'prefix',\n            ],\n            type: 'string',\n          },\n          enableFixer: {\n            description: 'Whether to enable the fixer. Defaults to `true`.',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C,MAAM,iBAAiB,GAAG,6CAA6C;AACvE,MAAM,eAAe,GAAG,mDAAmD;AAC3E,MAAM,aAAa,GAAG,gDAAgD;AAEtE,MAAM,wBAAwB,GAAG,0CAA0C;AAC3E,MAAM,sBAAsB,GAAG,iDAAiD;AAChF,MAAM,oBAAoB,GAAG,wCAAwC;AAErE,MAAM,sBAAsB,GAAG,uBAAuB;AACtD,MAAM,qBAAqB,GAAG,yCAAyC;;AAEvE;AACA;AACA;AACA;AACA;AACA,MAAM,sBAAsB,GAAG,CAAC,aAAa,EAAE,KAAK,KAAK;EACvD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE;IACjB,OAAO,IAAI;EACb;EAEA,IAAI,aAAa,KAAK,MAAM,EAAE;IAC5B,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;EAC5B;EAEA,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;AAC5B,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAI,MAAM,IAAK;EACnC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,GAAG,CAAC;AAClE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,wBAAwB,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;EACvD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;IAC/D,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;IACvC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,eAAe;IAClD,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,eAAe;IAElE,IAAI,KAAK,IAAI,YAAY,IAAI,KAAK,GAAG,UAAU,EAAE;MAC/C,OAAO,IAAI;IACb;EACF;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAG,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,KAAK;EACnD,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC;EAE9C,OAAO,aAAa,KAAK,MAAM,GAC7B,UAAU,aAAa,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,GAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,aAAa,GAAG;AAC/C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,aAAa,KAAK;EAC3D,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAC/C,IAAI,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,EACnC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK;IACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;EACjD,CACF,CAAC;EAED,IAAI,aAAa,KAAK,MAAM,EAAE;IAC5B,OAAO,kBAAkB,CAAC,UAAU,CAClC,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,EACjC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK;MACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;IACjD,CACF,CAAC;EACH;EAEA,OAAO,kBAAkB,CAAC,UAAU,CAClC,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,EAC/B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,KAAK;IACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;EACjD,CACF,CAAC;AACH,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,aAAa,GAAG,MAAM;IACtB,WAAW,GAAG;EAChB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM,kBAAkB,GAAG,aAAa,KAAK,MAAM,GACjD,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,GACxE,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC;;EAExE;EACA,MAAM,WAAW,GAAG,EAAE;EAEtB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE;IAC5B,IAAI,GAAG,CAAC,GAAG,KAAK,KAAK,EAAE;MACrB;IACF;IAEA,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;IACxC,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAC3D,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,GACrC,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,QAAQ,GAAG,cAAc,GACxD,cAAc;IAEhB,IAAI,gBAAgB,GAAG,KAAK;IAC5B,IAAI,mBAAmB,GAAG,KAAK;IAE/B,KAAK,MAAM,KAAK,IAAI,cAAc,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;MAC9D,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;MACtB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;MAEvB,IACE,wBAAwB,CAAC,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,IACrD,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IACnC,sBAAsB,CAAC,aAAa,EAAE,KAAK,CAAC,EAC5C;QACA,gBAAgB,GAAG,IAAI;MACzB,CAAC,MAAM;QACL,mBAAmB,GAAG,IAAI;MAC5B;IACF;IAEA,KAAK,MAAM,SAAS,IAAI,GAAG,CAAC,UAAU,EAAE;MACtC,IAAI,SAAS,CAAC,GAAG,KAAK,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;QAC/C;MACF;MAEA,IAAI,SAAS,CAAC,MAAM,KAAK,OAAO,EAAE;QAChC,gBAAgB,GAAG,IAAI;QACvB;MACF;MAEA,IAAI,sBAAsB,CACxB,aAAa,EACb,SAAS,CAAC,IACZ,CAAC,EAAE;QACD,gBAAgB,GAAG,IAAI;QACvB;MACF;MAEA,IAAI,SAAS,CAAC,MAAM,KAAK,aAAa,EAAE;QACtC;MACF;MAEA,MAAM;QACJ;MACF,CAAC,GAAG,iDAAmD,SAAU;MAEjE,IACE,wBAAwB,CAAC,cAAc,EAAE,KAAK,CAAC,IAC/C,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EACpD;QACA,gBAAgB,GAAG,IAAI;MACzB,CAAC,MAAM;QACL,mBAAmB,GAAG,IAAI;MAC5B;IACF;IAEA,MAAM,oBAAoB,GAAG,cAAc,CACxC,UAAU,CAAC,IAAI,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CACnD,UAAU,CAAC,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CACjD,UAAU,CAAC,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IAElD,gBAAgB,KAAK,wBAAwB,CAAC,IAAI,CAAC,oBAAoB,CAAC,IACtE,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,CAAC,IACjD,oBAAoB,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAEjD,IAAI,gBAAgB,EAAE;MACpB,KAAK,CAAC,WAAW,CAAC,wCAAwC,EAAE;QAC1D,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;MACtB,CAAC,EAAE,IAAI,CAAC;MACR;IACF;IAEA,IAAI,CAAC,mBAAmB,EAAE;MACxB;IACF;IAEA,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;EACvB;EAEA,KAAK,MAAM,CACT,SAAS,EACT,GAAG,CACJ,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE;IAC1B,KAAK,CAAC,WAAW,CACf,iCAAiC,aAAa,QAAQ,EACtD;MACE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC,EACD,WAAW,IAAI,SAAS,KAAK,CAAC,GAC5B,MAAM;MACJ,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;QAE/C,IAAI,WAAW,CAAC,IAAI,EAAE;UACpB,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,GACxC,WAAW,CAAC,QAAQ,GAAG,WAAW,CAAC,WAAW;UAChD,WAAW,CAAC,IAAI,GAAG,EAAE;UACrB,WAAW,CAAC,QAAQ,GAAG,EAAE;QAC3B;QAEA,KACE,IAAI,SAAS,GAAG,CAAC,EACjB,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EACpC,SAAS,EAAE,EACX;UACA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,WACtC,CAAC,EAAE;YACD;UACF;UAEA,KAAK,CAAC,iBAAiB,CACrB,UAAU,EACV,kBAAkB,EACjB,WAAW,IAAK;YACf,OAAO,oBAAoB,CAAC,WAAW,EAAE,aAAa,CAAC;UACzD,CACF,CAAC;QACH;MACF;IACF,CAAC,GACD,IAAI,EACN,IACF,CAAC;EACH;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,wEAAwE;MACrF,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,aAAa,EAAE;UACb,WAAW,EAAE,4IAA4I;UACzJ,IAAI,EAAE,CACJ,MAAM,EACN,QAAQ,CACT;UACD,IAAI,EAAE;QACR,CAAC;QACD,WAAW,EAAE;UACX,WAAW,EAAE,kDAAkD;UAC/D,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
+{"version":3,"file":"normalizeSeeLinks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/normalizeSeeLinks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst markdownLinkRegex = /(?<!\\\\)\\[([^`\\]\\r\\n]+)\\]\\(([^`\\(\\)\\s]+)\\)/gv;\nconst prefixLinkRegex = /(?<!\\\\)\\[([^\\]\\r\\n]+)\\]\\{@link\\s+([^\\}\\s\\|]+)\\}/gv;\nconst pipeLinkRegex = /\\{@link\\s+([^\\}\\s\\|]+)\\s*\\|\\s*([^\\}\\r\\n]+)\\}/gv;\n\nconst markdownLinkAttemptRegex = /(?<!\\\\)\\[[^\\]\\r\\n]*\\]\\([^\\r\\n]*(?:\\)|$)/v;\nconst prefixLinkAttemptRegex = /(?<!\\\\)\\[[^\\]\\r\\n]*\\]\\{@link[^\\}\\r\\n]*(?:\\}|$)/v;\nconst pipeLinkAttemptRegex = /\\{@link[^\\}\\r\\n]*\\|[^\\}\\r\\n]*(?:\\}|$)/v;\n\nconst scopedPackageNameRegex = /^@[\\w.\\-]+\\/[\\w.\\-]+/v;\nconst markdownCodeSpanRegex = /(?<!\\\\)(`+)(?!`)[\\s\\S]*?(?<!`)\\1(?!`)/gv;\nconst bareHttpUrlRegex = /^https?:\\S+$/v;\n\n/**\n * @param {'pipe'|'prefix'} canonicalForm\n * @param {string} label\n * @returns {boolean}\n */\nconst cannotSafelyFormatLink = (canonicalForm, label) => {\n  if (!label.trim()) {\n    return true;\n  }\n\n  if (canonicalForm === 'pipe') {\n    return label.includes('}');\n  }\n\n  return label.includes(']');\n};\n\n/**\n * @param {string} target\n * @returns {string}\n */\nconst encodeLinkTarget = (target) => {\n  return encodeURI(target).replaceAll(/%25(?=[\\dA-F]{2})/giv, '%');\n};\n\n/**\n * @param {string} description\n * @param {boolean} enabled\n * @returns {string|null}\n */\nconst getBareHttpUrl = (description, enabled) => {\n  if (!enabled) {\n    return null;\n  }\n\n  const trimmedDescription = description.trim();\n\n  return bareHttpUrlRegex.test(trimmedDescription) &&\n    URL.canParse(trimmedDescription) ?\n    trimmedDescription : null;\n};\n\n/**\n * @param {string} target\n * @returns {string}\n */\nconst formatBareUrl = (target) => {\n  return `{@link ${encodeLinkTarget(target)}}`;\n};\n\n/**\n * @param {string|undefined} bareUrl\n * @param {'pipe'|'prefix'} canonicalForm\n * @returns {string}\n */\nconst getExpectedMessage = (bareUrl, canonicalForm) => {\n  return bareUrl ?\n    'Expected bare @see URL to use a {@link} tag.' :\n    `Expected @see link to use the ${canonicalForm} form.`;\n};\n\n/**\n * @param {string} description\n * @param {number} index\n * @returns {boolean}\n */\nconst isInsideMarkdownCodeSpan = (description, index) => {\n  for (const match of description.matchAll(markdownCodeSpanRegex)) {\n    const delimiterLength = match[1].length;\n    const contentStart = match.index + delimiterLength;\n    const contentEnd = match.index + match[0].length - delimiterLength;\n\n    if (index >= contentStart && index < contentEnd) {\n      return true;\n    }\n  }\n\n  return false;\n};\n\n/**\n * @param {'pipe'|'prefix'} canonicalForm\n * @param {string} label\n * @param {string} target\n * @returns {string}\n */\nconst formatLink = (canonicalForm, label, target) => {\n  const encodedTarget = encodeLinkTarget(target);\n\n  return canonicalForm === 'pipe' ?\n    `{@link ${encodedTarget}|${label.trim()}}` :\n    `[${label.trim()}]{@link ${encodedTarget}}`;\n};\n\n/**\n * @param {string} description\n * @param {'pipe'|'prefix'} canonicalForm\n * @returns {string}\n */\nconst normalizeDescription = (description, canonicalForm) => {\n  const markdownNormalized = description.replaceAll(\n    new RegExp(markdownLinkRegex, 'gv'),\n    (_match, label, target) => {\n      return formatLink(canonicalForm, label, target);\n    },\n  );\n\n  if (canonicalForm === 'pipe') {\n    return markdownNormalized.replaceAll(\n      new RegExp(prefixLinkRegex, 'gv'),\n      (_match, label, target) => {\n        return formatLink(canonicalForm, label, target);\n      },\n    );\n  }\n\n  return markdownNormalized.replaceAll(\n    new RegExp(pipeLinkRegex, 'gv'),\n    (_match, target, label) => {\n      return formatLink(canonicalForm, label, target);\n    },\n  );\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    canonicalForm = 'pipe',\n    enableFixer = true,\n    wrapBareUrls = false,\n  } = context.options[0] || {};\n\n  const descriptionMatcher = canonicalForm === 'pipe' ?\n    new RegExp(`${markdownLinkRegex.source}|${prefixLinkRegex.source}`, 'v') :\n    new RegExp(`${markdownLinkRegex.source}|${pipeLinkRegex.source}`, 'v');\n\n  /** @type {import('comment-parser').Spec[]} */\n  const fixableTags = [];\n  /** @type {Map<import('comment-parser').Spec, string>} */\n  const bareUrlTags = new Map();\n\n  for (const tag of jsdoc.tags) {\n    if (tag.tag !== 'see') {\n      continue;\n    }\n\n    const firstTokens = tag.source[0].tokens;\n    const tagDescription = String(utils.getTagDescription(tag));\n    const rawDescription = firstTokens.name ?\n      firstTokens.name + firstTokens.postName + tagDescription :\n      tagDescription;\n\n    let hasAmbiguousLink = false;\n    let hasNoncanonicalLink = false;\n    const bareUrl = getBareHttpUrl(rawDescription, wrapBareUrls);\n\n    if (bareUrl) {\n      bareUrlTags.set(tag, bareUrl);\n      hasNoncanonicalLink = true;\n    }\n\n    for (const match of rawDescription.matchAll(markdownLinkRegex)) {\n      const label = match[1];\n      const target = match[2];\n\n      if (\n        isInsideMarkdownCodeSpan(rawDescription, match.index) ||\n        scopedPackageNameRegex.test(target) ||\n        cannotSafelyFormatLink(canonicalForm, label)\n      ) {\n        hasAmbiguousLink = true;\n      } else {\n        hasNoncanonicalLink = true;\n      }\n    }\n\n    for (const inlineTag of tag.inlineTags) {\n      if (inlineTag.tag !== 'link' || !inlineTag.text) {\n        continue;\n      }\n\n      if (inlineTag.format === 'space') {\n        hasAmbiguousLink = true;\n        continue;\n      }\n\n      if (cannotSafelyFormatLink(\n        canonicalForm,\n        inlineTag.text,\n      )) {\n        hasAmbiguousLink = true;\n        continue;\n      }\n\n      if (inlineTag.format === canonicalForm) {\n        continue;\n      }\n\n      const {\n        start,\n      } = /** @type {typeof inlineTag & {start: number}} */ (inlineTag);\n\n      if (\n        isInsideMarkdownCodeSpan(rawDescription, start) ||\n        scopedPackageNameRegex.test(inlineTag.namepathOrURL)\n      ) {\n        hasAmbiguousLink = true;\n      } else {\n        hasNoncanonicalLink = true;\n      }\n    }\n\n    const unrecognizedLinkText = rawDescription\n      .replaceAll(new RegExp(markdownLinkRegex, 'gv'), '')\n      .replaceAll(new RegExp(prefixLinkRegex, 'gv'), '')\n      .replaceAll(new RegExp(pipeLinkRegex, 'gv'), '');\n\n    hasAmbiguousLink ||= markdownLinkAttemptRegex.test(unrecognizedLinkText) ||\n      prefixLinkAttemptRegex.test(unrecognizedLinkText) ||\n      pipeLinkAttemptRegex.test(unrecognizedLinkText);\n\n    if (hasAmbiguousLink) {\n      utils.reportJSDoc('@see link cannot be safely normalized.', {\n        line: tag.source[0].number,\n      }, null);\n      continue;\n    }\n\n    if (!hasNoncanonicalLink) {\n      continue;\n    }\n\n    fixableTags.push(tag);\n  }\n\n  for (const [\n    reportIdx,\n    tag,\n  ] of fixableTags.entries()) {\n    const bareUrl = bareUrlTags.get(tag);\n\n    utils.reportJSDoc(\n      getExpectedMessage(bareUrl, canonicalForm),\n      {\n        line: tag.source[0].number,\n      },\n      enableFixer && reportIdx === 0 ?\n        () => {\n          for (const fixableTag of fixableTags) {\n            const firstTokens = fixableTag.source[0].tokens;\n\n            if (firstTokens.name) {\n              firstTokens.description = firstTokens.name +\n                firstTokens.postName + firstTokens.description;\n              firstTokens.name = '';\n              firstTokens.postName = '';\n            }\n\n            const fixableBareUrl = bareUrlTags.get(fixableTag);\n\n            if (fixableBareUrl) {\n              for (const source of fixableTag.source) {\n                if (!source.tokens.description.includes(fixableBareUrl)) {\n                  continue;\n                }\n\n                source.tokens.description = source.tokens.description.replace(\n                  fixableBareUrl,\n                  () => {\n                    return formatBareUrl(fixableBareUrl);\n                  },\n                );\n                break;\n              }\n\n              continue;\n            }\n\n            for (\n              let sourceIdx = 0;\n              sourceIdx < fixableTag.source.length;\n              sourceIdx++\n            ) {\n              if (!descriptionMatcher.test(\n                fixableTag.source[sourceIdx].tokens.description,\n              )) {\n                continue;\n              }\n\n              utils.setTagDescription(\n                fixableTag,\n                descriptionMatcher,\n                (description) => {\n                  return normalizeDescription(description, canonicalForm);\n                },\n              );\n            }\n          }\n        } :\n        null,\n      true,\n    );\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Normalizes labeled links in `@see` tags to a canonical `{@link}` form.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/normalize-see-links.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          canonicalForm: {\n            description: 'The canonical `{@link}` form: `\"pipe\"` produces `{@link url|label}`, while `\"prefix\"` produces `[label]{@link url}`. Defaults to `\"pipe\"`.',\n            enum: [\n              'pipe',\n              'prefix',\n            ],\n            type: 'string',\n          },\n          enableFixer: {\n            description: 'Whether to enable the fixer. Defaults to `true`.',\n            type: 'boolean',\n          },\n          wrapBareUrls: {\n            description: 'Whether to wrap an `@see` description containing only a lowercase `http:` or `https:` URL (for example, `@see https://example.com`) in a plain `{@link https://example.com}`. Defaults to `false`.',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C,MAAM,iBAAiB,GAAG,6CAA6C;AACvE,MAAM,eAAe,GAAG,mDAAmD;AAC3E,MAAM,aAAa,GAAG,gDAAgD;AAEtE,MAAM,wBAAwB,GAAG,0CAA0C;AAC3E,MAAM,sBAAsB,GAAG,iDAAiD;AAChF,MAAM,oBAAoB,GAAG,wCAAwC;AAErE,MAAM,sBAAsB,GAAG,uBAAuB;AACtD,MAAM,qBAAqB,GAAG,yCAAyC;AACvE,MAAM,gBAAgB,GAAG,eAAe;;AAExC;AACA;AACA;AACA;AACA;AACA,MAAM,sBAAsB,GAAG,CAAC,aAAa,EAAE,KAAK,KAAK;EACvD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE;IACjB,OAAO,IAAI;EACb;EAEA,IAAI,aAAa,KAAK,MAAM,EAAE;IAC5B,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;EAC5B;EAEA,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;AAC5B,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAI,MAAM,IAAK;EACnC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,sBAAsB,EAAE,GAAG,CAAC;AAClE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,OAAO,KAAK;EAC/C,IAAI,CAAC,OAAO,EAAE;IACZ,OAAO,IAAI;EACb;EAEA,MAAM,kBAAkB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;EAE7C,OAAO,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAC9C,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAChC,kBAAkB,GAAG,IAAI;AAC7B,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,aAAa,GAAI,MAAM,IAAK;EAChC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,GAAG;AAC9C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK;EACrD,OAAO,OAAO,GACZ,8CAA8C,GAC9C,iCAAiC,aAAa,QAAQ;AAC1D,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,wBAAwB,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;EACvD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;IAC/D,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;IACvC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,eAAe;IAClD,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,eAAe;IAElE,IAAI,KAAK,IAAI,YAAY,IAAI,KAAK,GAAG,UAAU,EAAE;MAC/C,OAAO,IAAI;IACb;EACF;EAEA,OAAO,KAAK;AACd,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAG,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,KAAK;EACnD,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC;EAE9C,OAAO,aAAa,KAAK,MAAM,GAC7B,UAAU,aAAa,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,GAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,aAAa,GAAG;AAC/C,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,oBAAoB,GAAG,CAAC,WAAW,EAAE,aAAa,KAAK;EAC3D,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAC/C,IAAI,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,EACnC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK;IACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;EACjD,CACF,CAAC;EAED,IAAI,aAAa,KAAK,MAAM,EAAE;IAC5B,OAAO,kBAAkB,CAAC,UAAU,CAClC,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,EACjC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK;MACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;IACjD,CACF,CAAC;EACH;EAEA,OAAO,kBAAkB,CAAC,UAAU,CAClC,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,EAC/B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,KAAK;IACzB,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC;EACjD,CACF,CAAC;AACH,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,aAAa,GAAG,MAAM;IACtB,WAAW,GAAG,IAAI;IAClB,YAAY,GAAG;EACjB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM,kBAAkB,GAAG,aAAa,KAAK,MAAM,GACjD,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,GACxE,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC;;EAExE;EACA,MAAM,WAAW,GAAG,EAAE;EACtB;EACA,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC;EAE7B,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE;IAC5B,IAAI,GAAG,CAAC,GAAG,KAAK,KAAK,EAAE;MACrB;IACF;IAEA,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;IACxC,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAC3D,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,GACrC,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,QAAQ,GAAG,cAAc,GACxD,cAAc;IAEhB,IAAI,gBAAgB,GAAG,KAAK;IAC5B,IAAI,mBAAmB,GAAG,KAAK;IAC/B,MAAM,OAAO,GAAG,cAAc,CAAC,cAAc,EAAE,YAAY,CAAC;IAE5D,IAAI,OAAO,EAAE;MACX,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;MAC7B,mBAAmB,GAAG,IAAI;IAC5B;IAEA,KAAK,MAAM,KAAK,IAAI,cAAc,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;MAC9D,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;MACtB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;MAEvB,IACE,wBAAwB,CAAC,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,IACrD,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IACnC,sBAAsB,CAAC,aAAa,EAAE,KAAK,CAAC,EAC5C;QACA,gBAAgB,GAAG,IAAI;MACzB,CAAC,MAAM;QACL,mBAAmB,GAAG,IAAI;MAC5B;IACF;IAEA,KAAK,MAAM,SAAS,IAAI,GAAG,CAAC,UAAU,EAAE;MACtC,IAAI,SAAS,CAAC,GAAG,KAAK,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;QAC/C;MACF;MAEA,IAAI,SAAS,CAAC,MAAM,KAAK,OAAO,EAAE;QAChC,gBAAgB,GAAG,IAAI;QACvB;MACF;MAEA,IAAI,sBAAsB,CACxB,aAAa,EACb,SAAS,CAAC,IACZ,CAAC,EAAE;QACD,gBAAgB,GAAG,IAAI;QACvB;MACF;MAEA,IAAI,SAAS,CAAC,MAAM,KAAK,aAAa,EAAE;QACtC;MACF;MAEA,MAAM;QACJ;MACF,CAAC,GAAG,iDAAmD,SAAU;MAEjE,IACE,wBAAwB,CAAC,cAAc,EAAE,KAAK,CAAC,IAC/C,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EACpD;QACA,gBAAgB,GAAG,IAAI;MACzB,CAAC,MAAM;QACL,mBAAmB,GAAG,IAAI;MAC5B;IACF;IAEA,MAAM,oBAAoB,GAAG,cAAc,CACxC,UAAU,CAAC,IAAI,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CACnD,UAAU,CAAC,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CACjD,UAAU,CAAC,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IAElD,gBAAgB,KAAK,wBAAwB,CAAC,IAAI,CAAC,oBAAoB,CAAC,IACtE,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,CAAC,IACjD,oBAAoB,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAEjD,IAAI,gBAAgB,EAAE;MACpB,KAAK,CAAC,WAAW,CAAC,wCAAwC,EAAE;QAC1D,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;MACtB,CAAC,EAAE,IAAI,CAAC;MACR;IACF;IAEA,IAAI,CAAC,mBAAmB,EAAE;MACxB;IACF;IAEA,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;EACvB;EAEA,KAAK,MAAM,CACT,SAAS,EACT,GAAG,CACJ,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE;IAC1B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;IAEpC,KAAK,CAAC,WAAW,CACf,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,EAC1C;MACE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC,EACD,WAAW,IAAI,SAAS,KAAK,CAAC,GAC5B,MAAM;MACJ,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;QAE/C,IAAI,WAAW,CAAC,IAAI,EAAE;UACpB,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,GACxC,WAAW,CAAC,QAAQ,GAAG,WAAW,CAAC,WAAW;UAChD,WAAW,CAAC,IAAI,GAAG,EAAE;UACrB,WAAW,CAAC,QAAQ,GAAG,EAAE;QAC3B;QAEA,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC;QAElD,IAAI,cAAc,EAAE;UAClB,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE;YACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;cACvD;YACF;YAEA,MAAM,CAAC,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAC3D,cAAc,EACd,MAAM;cACJ,OAAO,aAAa,CAAC,cAAc,CAAC;YACtC,CACF,CAAC;YACD;UACF;UAEA;QACF;QAEA,KACE,IAAI,SAAS,GAAG,CAAC,EACjB,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EACpC,SAAS,EAAE,EACX;UACA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,WACtC,CAAC,EAAE;YACD;UACF;UAEA,KAAK,CAAC,iBAAiB,CACrB,UAAU,EACV,kBAAkB,EACjB,WAAW,IAAK;YACf,OAAO,oBAAoB,CAAC,WAAW,EAAE,aAAa,CAAC;UACzD,CACF,CAAC;QACH;MACF;IACF,CAAC,GACD,IAAI,EACN,IACF,CAAC;EACH;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,wEAAwE;MACrF,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,aAAa,EAAE;UACb,WAAW,EAAE,4IAA4I;UACzJ,IAAI,EAAE,CACJ,MAAM,EACN,QAAQ,CACT;UACD,IAAI,EAAE;QACR,CAAC;QACD,WAAW,EAAE;UACX,WAAW,EAAE,kDAAkD;UAC/D,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,WAAW,EAAE,oMAAoM;UACjN,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}

package/dist/rules.d.ts

@@ -1305,6 +1305,10 @@ export interface Rules {
            * Whether to enable the fixer. Defaults to `true`.
            */
           enableFixer?: boolean;
+          /**
+           * Whether to wrap an `@see` description containing only a lowercase `http:` or `https:` URL (for example, `@see https://example.com`) in a plain `{@link https://example.com}`. Defaults to `false`.
+           */
+          wrapBareUrls?: boolean;
         }
       ];
 

package/package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.88.0",
+    "@es-joy/jsdoccomment": "~0.89.0",
     "@es-joy/resolve.exports": "1.2.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.7",
@@ -17,13 +17,13 @@
     "object-deep-merge": "^2.0.1",
     "parse-imports-exports": "^0.2.4",
     "semver": "^7.8.5",
-    "spdx-expression-parse": "^4.0.0",
+    "spdx-expression-parse": "^5.0.0",
     "to-valid-identifier": "^1.0.0"
   },
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.18.4",
-    "@babel/cli": "8.0.1",
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@babel/cli": "8.0.4",
     "@babel/core": "8.0.1",
     "@babel/eslint-parser": "8.0.1",
     "@babel/plugin-transform-flow-strip-types": "8.0.1",
@@ -42,18 +42,18 @@
     "@types/estree": "^1.0.9",
     "@types/json-schema": "^7.0.15",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^26.1.0",
+    "@types/node": "^26.1.1",
     "@types/semver": "^7.7.1",
     "@types/spdx-expression-parse": "^4.0.0",
-    "@typescript-eslint/types": "8.62.1",
+    "@typescript-eslint/types": "8.65.0",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-istanbul": "^8.0.0",
     "babel-plugin-transform-import-meta": "^3.0.0",
-    "c8": "^11.0.0",
+    "c8": "^12.0.0",
     "camelcase": "^9.0.0",
     "chai": "^6.2.2",
     "decamelize": "^6.0.1",
-    "eslint": "10.6.0",
+    "eslint": "10.7.0",
     "eslint-config-canonical": "^47.4.2",
     "gitdown": "^4.1.1",
     "glob": "^13.0.6",
@@ -62,18 +62,18 @@
     "jsdoc-type-pratt-parser": "^7.2.0",
     "json-schema": "^0.4.0",
     "json-schema-to-typescript": "^15.0.4",
-    "lint-staged": "^17.0.8",
+    "lint-staged": "^17.2.0",
     "mocha": "^11.7.6",
     "open-editor": "^6.0.0",
     "playwright": "^1.61.1",
     "replace": "^1.2.2",
     "rimraf": "^6.1.3",
     "rollup": "^4.62.2",
-    "semantic-release": "^25.0.5",
-    "sinon": "^22.0.0",
+    "semantic-release": "^25.0.8",
+    "sinon": "^22.1.0",
     "ts-api-utils": "^2.5.0",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.62.1"
+    "typescript-eslint": "8.65.0"
   },
   "engines": {
     "node": "^22.13.0 || >=24"
@@ -179,5 +179,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "63.1.0"
+  "version": "63.2.1"
 }

package/src/rules/normalizeSeeLinks.js

@@ -10,6 +10,7 @@ const pipeLinkAttemptRegex = /\{@link[^\}\r\n]*\|[^\}\r\n]*(?:\}|$)/v;
 
 const scopedPackageNameRegex = /^@[\w.\-]+\/[\w.\-]+/v;
 const markdownCodeSpanRegex = /(?<!\\)(`+)(?!`)[\s\S]*?(?<!`)\1(?!`)/gv;
+const bareHttpUrlRegex = /^https?:\S+$/v;
 
 /**
  * @param {'pipe'|'prefix'} canonicalForm
@@ -36,6 +37,42 @@ const encodeLinkTarget = (target) => {
   return encodeURI(target).replaceAll(/%25(?=[\dA-F]{2})/giv, '%');
 };
 
+/**
+ * @param {string} description
+ * @param {boolean} enabled
+ * @returns {string|null}
+ */
+const getBareHttpUrl = (description, enabled) => {
+  if (!enabled) {
+    return null;
+  }
+
+  const trimmedDescription = description.trim();
+
+  return bareHttpUrlRegex.test(trimmedDescription) &&
+    URL.canParse(trimmedDescription) ?
+    trimmedDescription : null;
+};
+
+/**
+ * @param {string} target
+ * @returns {string}
+ */
+const formatBareUrl = (target) => {
+  return `{@link ${encodeLinkTarget(target)}}`;
+};
+
+/**
+ * @param {string|undefined} bareUrl
+ * @param {'pipe'|'prefix'} canonicalForm
+ * @returns {string}
+ */
+const getExpectedMessage = (bareUrl, canonicalForm) => {
+  return bareUrl ?
+    'Expected bare @see URL to use a {@link} tag.' :
+    `Expected @see link to use the ${canonicalForm} form.`;
+};
+
 /**
  * @param {string} description
  * @param {number} index
@@ -107,6 +144,7 @@ export default iterateJsdoc(({
   const {
     canonicalForm = 'pipe',
     enableFixer = true,
+    wrapBareUrls = false,
   } = context.options[0] || {};
 
   const descriptionMatcher = canonicalForm === 'pipe' ?
@@ -115,6 +153,8 @@ export default iterateJsdoc(({
 
   /** @type {import('comment-parser').Spec[]} */
   const fixableTags = [];
+  /** @type {Map<import('comment-parser').Spec, string>} */
+  const bareUrlTags = new Map();
 
   for (const tag of jsdoc.tags) {
     if (tag.tag !== 'see') {
@@ -129,6 +169,12 @@ export default iterateJsdoc(({
 
     let hasAmbiguousLink = false;
     let hasNoncanonicalLink = false;
+    const bareUrl = getBareHttpUrl(rawDescription, wrapBareUrls);
+
+    if (bareUrl) {
+      bareUrlTags.set(tag, bareUrl);
+      hasNoncanonicalLink = true;
+    }
 
     for (const match of rawDescription.matchAll(markdownLinkRegex)) {
       const label = match[1];
@@ -208,8 +254,10 @@ export default iterateJsdoc(({
     reportIdx,
     tag,
   ] of fixableTags.entries()) {
+    const bareUrl = bareUrlTags.get(tag);
+
     utils.reportJSDoc(
-      `Expected @see link to use the ${canonicalForm} form.`,
+      getExpectedMessage(bareUrl, canonicalForm),
       {
         line: tag.source[0].number,
       },
@@ -225,6 +273,26 @@ export default iterateJsdoc(({
               firstTokens.postName = '';
             }
 
+            const fixableBareUrl = bareUrlTags.get(fixableTag);
+
+            if (fixableBareUrl) {
+              for (const source of fixableTag.source) {
+                if (!source.tokens.description.includes(fixableBareUrl)) {
+                  continue;
+                }
+
+                source.tokens.description = source.tokens.description.replace(
+                  fixableBareUrl,
+                  () => {
+                    return formatBareUrl(fixableBareUrl);
+                  },
+                );
+                break;
+              }
+
+              continue;
+            }
+
             for (
               let sourceIdx = 0;
               sourceIdx < fixableTag.source.length;
@@ -274,6 +342,10 @@ export default iterateJsdoc(({
             description: 'Whether to enable the fixer. Defaults to `true`.',
             type: 'boolean',
           },
+          wrapBareUrls: {
+            description: 'Whether to wrap an `@see` description containing only a lowercase `http:` or `https:` URL (for example, `@see https://example.com`) in a plain `{@link https://example.com}`. Defaults to `false`.',
+            type: 'boolean',
+          },
         },
         type: 'object',
       },

package/src/rules.d.ts

@@ -1305,6 +1305,10 @@ export interface Rules {
            * Whether to enable the fixer. Defaults to `true`.
            */
           enableFixer?: boolean;
+          /**
+           * Whether to wrap an `@see` description containing only a lowercase `http:` or `https:` URL (for example, `@see https://example.com`) in a plain `{@link https://example.com}`. Defaults to `false`.
+           */
+          wrapBareUrls?: boolean;
         }
       ];