eslint-plugin-jsdoc 51.4.1 → 52.0.1

package/src/rules/requireDescriptionCompleteSentence.js

@@ -14,7 +14,7 @@ const otherDescriptiveTags = new Set([
  * @returns {string[]}
  */
 const extractParagraphs = (text) => {
-  return text.split(/(?<![;:])\n\n+/u);
+  return text.split(/(?<![;:])\n\n+/v);
 };
 
 /**
@@ -25,12 +25,12 @@ const extractParagraphs = (text) => {
 const extractSentences = (text, abbreviationsRegex) => {
   const txt = text
     // Remove all {} tags.
-    .replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gu, '')
+    .replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gv, '')
 
     // Remove custom abbreviations
     .replace(abbreviationsRegex, '');
 
-  const sentenceEndGrouping = /([.?!])(?:\s+|$)/ug;
+  const sentenceEndGrouping = /([.?!])(?:\s+|$)/gv;
 
   const puncts = [
     ...txt.matchAll(sentenceEndGrouping),
@@ -39,11 +39,11 @@ const extractSentences = (text, abbreviationsRegex) => {
   });
 
   return txt
-    .split(/[.?!](?:\s+|$)/u)
+    .split(/[.?!](?:\s+|$)/v)
 
     // Re-add the dot.
     .map((sentence, idx) => {
-      return !puncts[idx] && /^\s*$/u.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;
+      return !puncts[idx] && /^\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;
     });
 };
 
@@ -58,11 +58,11 @@ const isNewLinePrecededByAPeriod = (text) => {
   const lines = text.split('\n');
 
   return !lines.some((line) => {
-    if (lastLineEndsSentence === false && /^[A-Z][a-z]/u.test(line)) {
+    if (lastLineEndsSentence === false && /^[A-Z][a-z]/v.test(line)) {
       return true;
     }
 
-    lastLineEndsSentence = /[.:?!|]$/u.test(line);
+    lastLineEndsSentence = /[.:?!\|]$/v.test(line);
 
     return false;
   });
@@ -108,11 +108,11 @@ const validateDescription = (
   description, reportOrig, jsdocNode, abbreviationsRegex,
   sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd,
 ) => {
-  if (!description || (/^\n+$/u).test(description)) {
+  if (!description || (/^\n+$/v).test(description)) {
     return false;
   }
 
-  const descriptionNoHeadings = description.replaceAll(/^\s*#[^\n]*(\n|$)/gmu, '');
+  const descriptionNoHeadings = description.replaceAll(/^\s*#[^\n]*(\n|$)/gmv, '');
 
   const paragraphs = extractParagraphs(descriptionNoHeadings).filter(Boolean);
 
@@ -122,28 +122,28 @@ const validateDescription = (
     const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {
       let text = sourceCode.getText(jsdocNode);
 
-      if (!/[.:?!]$/u.test(paragraph)) {
+      if (!/[.:?!]$/v.test(paragraph)) {
         const line = paragraph.split('\n').findLast(Boolean);
         text = text.replace(new RegExp(`${escapeStringRegexp(
           /** @type {string} */
           (line),
-        )}$`, 'mu'), `${line}.`);
+        )}$`, 'mv'), `${line}.`);
       }
 
       for (const sentence of sentences.filter((sentence_) => {
-        return !(/^\s*$/u).test(sentence_) && !isCapitalized(sentence_) &&
+        return !(/^\s*$/v).test(sentence_) && !isCapitalized(sentence_) &&
           !isTable(sentence_);
       })) {
         const beginning = sentence.split('\n')[0];
 
         if ('tag' in tag && tag.tag) {
-          const reg = new RegExp(`(@${escapeStringRegexp(tag.tag)}.*)${escapeStringRegexp(beginning)}`, 'u');
+          const reg = new RegExp(`(@${escapeStringRegexp(tag.tag)}.*)${escapeStringRegexp(beginning)}`, 'v');
 
           text = text.replace(reg, (_$0, $1) => {
             return $1 + capitalize(beginning);
           });
         } else {
-          text = text.replace(new RegExp('((?:[.?!]|\\*|\\})\\s*)' + escapeStringRegexp(beginning), 'u'), '$1' + capitalize(beginning));
+          text = text.replace(new RegExp('((?:[.?!]|\\*|\\})\\s*)' + escapeStringRegexp(beginning), 'v'), '$1' + capitalize(beginning));
         }
       }
 
@@ -181,20 +181,20 @@ const validateDescription = (
     };
 
     if (sentences.some((sentence) => {
-      return (/^[.?!]$/u).test(sentence);
+      return (/^[.?!]$/v).test(sentence);
     })) {
       report('Sentences must be more than punctuation.', null, tag);
     }
 
     if (sentences.some((sentence) => {
-      return !(/^\s*$/u).test(sentence) && !isCapitalized(sentence) && !isTable(sentence);
+      return !(/^\s*$/v).test(sentence) && !isCapitalized(sentence) && !isTable(sentence);
     })) {
       report('Sentences should start with an uppercase character.', fix, tag);
     }
 
     const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, '');
 
-    if (!/(?:[.?!|]|```)\s*$/u.test(paragraphNoAbbreviations)) {
+    if (!/(?:[.?!\|]|```)\s*$/v.test(paragraphNoAbbreviations)) {
       report('Sentences must end with a period.', fix, tag);
       return true;
     }
@@ -224,8 +224,8 @@ export default iterateJsdoc(({
 
   const abbreviationsRegex = abbreviations.length ?
     new RegExp('\\b' + abbreviations.map((abbreviation) => {
-      return escapeStringRegexp(abbreviation.replaceAll(/\.$/ug, '') + '.');
-    }).join('|') + '(?:$|\\s)', 'gu') :
+      return escapeStringRegexp(abbreviation.replaceAll(/\.$/gv, '') + '.');
+    }).join('|') + '(?:$|\\s)', 'gv') :
     '';
 
   let {
@@ -233,7 +233,7 @@ export default iterateJsdoc(({
   } = utils.getDescription();
 
   const indices = [
-    ...description.matchAll(/```[\s\S]*```/gu),
+    ...description.matchAll(/```[\s\S]*```/gv),
   ].map((match) => {
     const {
       index,
@@ -289,7 +289,7 @@ export default iterateJsdoc(({
   tagsWithNames.some((tag) => {
     const desc = /** @type {string} */ (
       utils.getTagDescription(tag)
-    ).replace(/^- /u, '').trimEnd();
+    ).replace(/^- /v, '').trimEnd();
 
     return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
   });

package/src/rules/requireHyphenBeforeParamDescription.js

@@ -29,7 +29,7 @@ export default iterateJsdoc(({
       return;
     }
 
-    const startsWithHyphen = (/^\s*-/u).test(desc);
+    const startsWithHyphen = (/^\s*-/v).test(desc);
     let lines = 0;
     for (const {
       tokens,
@@ -54,7 +54,7 @@ export default iterateJsdoc(({
             } of jsdocTag.source) {
               if (tokens.description) {
                 tokens.description = tokens.description.replace(
-                  /^(\s*)/u, '$1- ',
+                  /^(\s*)/v, '$1- ',
                 );
                 break;
               }
@@ -74,7 +74,7 @@ export default iterateJsdoc(({
           } of jsdocTag.source) {
             if (tokens.description) {
               tokens.description = tokens.description.replace(
-                /^\s*-\s*/u, '',
+                /^\s*-\s*/v, '',
               );
               break;
             }

package/src/rules/requireJsdoc.js

@@ -444,7 +444,7 @@ export default {
          */
         const underMinLine = (count) => {
           return count !== undefined && count >
-            (sourceCode.getText(node).match(/\n/gu)?.length ?? 0) + 1;
+            (sourceCode.getText(node).match(/\n/gv)?.length ?? 0) + 1;
         };
 
         if (underMinLine(minLineCount)) {

package/src/rules/requireReturnsCheck.js

@@ -81,7 +81,7 @@ export default iterateJsdoc(({
   const type = tag.type.trim();
 
   // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions
-  if (/asserts\s/u.test(type)) {
+  if (/asserts\s/v.test(type)) {
     return;
   }
 

package/src/rules/requireTemplate.js

@@ -31,7 +31,7 @@ export default iterateJsdoc(({
       const {
         name,
       } = tag;
-      const names = name.split(/,\s*/u);
+      const names = name.split(/,\s*/v);
       if (names.length > 1) {
         report(`Missing separate @template for ${names[1]}`, null, tag);
       }
@@ -126,7 +126,7 @@ export default iterateJsdoc(({
         type,
         value,
       } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (nde);
-      if (type === 'JsdocTypeName' && (/^[A-Z]$/u).test(value)) {
+      if (type === 'JsdocTypeName' && (/^[A-Z]$/v).test(value)) {
         usedNames.add(value);
         if (!usedNameToTag.has(value)) {
           usedNameToTag.set(value, potentialTag);

package/src/rules/tagLines.js

@@ -228,11 +228,11 @@ export default iterateJsdoc(({
       description,
       lastDescriptionLine,
     } = utils.getDescription();
-    if (!(/\S/u).test(description)) {
+    if (!(/\S/v).test(description)) {
       return;
     }
 
-    const trailingLines = description.match(/\n+$/u)?.[0]?.length;
+    const trailingLines = description.match(/\n+$/v)?.[0]?.length;
     const trailingDiff = (trailingLines ?? 0) - startLines;
     if (trailingDiff > 0) {
       utils.reportJSDoc(

package/src/rules/textEscaping.js

@@ -2,15 +2,15 @@ import iterateJsdoc from '../iterateJsdoc.js';
 
 // We could disallow raw gt, quot, and apos, but allow for parity; but we do
 //  not allow hex or decimal character references
-const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/u;
-const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/u;
+const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/v;
+const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/v;
 
 /**
  * @param {string} desc
  * @returns {string}
  */
 const htmlReplacer = (desc) => {
-  return desc.replaceAll(new RegExp(htmlRegex, 'gu'), (_) => {
+  return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {
     if (_ === '<') {
       return '&lt;';
     }
@@ -24,7 +24,7 @@ const htmlReplacer = (desc) => {
  * @returns {string}
  */
 const markdownReplacer = (desc) => {
-  return desc.replaceAll(new RegExp(markdownRegex, 'gu'), (_, backticks, encapsed) => {
+  return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {
     const bookend = '`'.repeat(backticks.length);
     return `\\${bookend}${encapsed}${bookend}`;
   });

package/src/rules/validTypes.js

@@ -17,7 +17,7 @@ const jsdocTypePrattKeywords = new Set([
   'typeof',
 ]);
 
-const asExpression = /as\s+/u;
+const asExpression = /as\s+/v;
 
 const suppressTypes = new Set([
   // https://github.com/google/closure-compiler/wiki/@suppress-annotations

package/eslint.config.js

@@ -1,86 +0,0 @@
-import jsdoc from './src/index.js';
-import {
-  recommended as canonical,
-} from 'eslint-config-canonical/canonical';
-import {
-  recommended as canonicalJsdoc,
-} from 'eslint-config-canonical/jsdoc';
-import globals from 'globals';
-
-const common = {
-  linterOptions: {
-    reportUnusedDisableDirectives: 'off',
-  },
-};
-
-export default [
-  ...canonical,
-  ...canonicalJsdoc,
-  ...jsdoc.configs['examples-and-default-expressions'],
-  {
-    // Must be by itself
-    ignores: [
-      'dist/**', '.ignore/**', '**/*.d.ts',
-    ],
-  },
-  {
-    ...common,
-    languageOptions: {
-      ecmaVersion: 'latest',
-      globals: globals.node,
-      sourceType: 'module',
-    },
-    rules: {
-      '@stylistic/array-element-newline': 0,
-      '@stylistic/no-extra-parens': 0,
-      'filenames/match-regex': 0,
-      'import/extensions': 0,
-      'import/no-useless-path-segments': 0,
-      'linebreak-style': 0,
-      'no-inline-comments': 0,
-      'prefer-named-capture-group': 0,
-      'unicorn/import-index': 0,
-      'unicorn/no-array-reduce': 0,
-      'unicorn/no-unsafe-regex': 0,
-      'unicorn/prefer-array-some': 0,
-      'unicorn/prevent-abbreviations': 0,
-    },
-  },
-  {
-    ...common,
-    files: [
-      '.ncurc.cjs',
-    ],
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          impliedStrict: false,
-        },
-      },
-      sourceType: 'script',
-    },
-    rules: {
-      'canonical/filename-match-regex': 0,
-      'import/no-commonjs': 0,
-      strict: [
-        'error',
-        'global',
-      ],
-    },
-  },
-  {
-    ...common,
-    files: [
-      'test/**/*.js',
-    ],
-    languageOptions: {
-      ecmaVersion: 'latest',
-      globals: globals.mocha,
-      sourceType: 'module',
-    },
-    rules: {
-      'no-restricted-syntax': 0,
-      'unicorn/prevent-abbreviations': 0,
-    },
-  },
-];

package/pnpm-workspace.yaml

@@ -1,3 +0,0 @@
-ignoredBuiltDependencies:
-  - core-js
-  - core-js-pure