fix: default to u flag for checkTypesPattern option for `require-…

…param`, `check-param-names`; for `check-values`, default to `u` flag and allow slashed regexes with own flags; for `match-description`, allow slashed regexs with own flags; for all of the previous (and `check-examples`) allows newlines

.README/rules/check-values.md

@@ -28,9 +28,14 @@ If present as an array, will be used in place of SPDX identifiers.
 A string to be converted into a `RegExp` (with `u` flag) and whose first
 parenthetical grouping, if present, will match the portion of the license
 description to check (if no grouping is present, then the whole portion
-matched will be used). Defaults to `([^\n]*)`, i.e., the SPDX expression
+matched will be used). Defaults to `/([^\n]*)/gu`, i.e., the SPDX expression
 is expected before any line breaks.
 
+Note that the `/` delimiters are optional, but necessary to add flags.
+
+Defaults to using the `u` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^mit$/ui`.
+
 |||
 |---|---|
 |Context|everywhere|

.README/rules/match-description.md

@@ -11,6 +11,16 @@ by our supported Node versions):
 Applies to the jsdoc block description and `@description` (or `@desc`)
 by default but the `tags` option (see below) may be used to match other tags.
 
+The default (and all regex options) defaults to using (only) the `u` flag, so
+to add your own flags, encapsulate your expression as a string, but like a
+literal, e.g., `/[A-Z].*\\./ui`.
+
+Note that `/` delimiters are optional, but necessary to add flags (besides
+`u`).
+
+Also note that the default or optional regular expressions is *not*
+case-insensitive unless one opts in to add the `i` flag.
+
 #### Options
 
 ##### `matchDescription`
@@ -24,9 +34,6 @@ You can supply your own expression to override the default, passing a
 }
 ```
 
-As with the default, the supplied regular expression will be applied with the
-Unicode (`"u"`) flag and is *not* case-insensitive.
-
 ##### `tags`
 
 If you want different regular expressions to apply to tags, you may use

.README/rules/require-param.md

@@ -305,7 +305,7 @@ export const bboxToObj = function ({x, y, width, height}) {
 ```
 
 By default `checkTypesPattern` is set to
-`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/`,
+`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/u`,
 meaning that destructuring will be required only if the type of the `@param`
 (the text between curly brackets) is a match for "Object" or "Array" (with or
 without initial caps), "PlainObject", or "GenericObject", "GenericArray" (or
@@ -315,6 +315,9 @@ parameters.
 
 Note that the `/` delimiters are optional, but necessary to add flags.
 
+Defaults to using (only) the `u` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^object$/ui`.
+
 You could set this regular expression to a more expansive list, or you
 could restrict it such that even types matching those strings would not
 need destructuring.

README.md

@@ -5333,9 +5333,14 @@ If present as an array, will be used in place of SPDX identifiers.
 A string to be converted into a `RegExp` (with `u` flag) and whose first
 parenthetical grouping, if present, will match the portion of the license
 description to check (if no grouping is present, then the whole portion
-matched will be used). Defaults to `([^\n]*)`, i.e., the SPDX expression
+matched will be used). Defaults to `/([^\n]*)/gu`, i.e., the SPDX expression
 is expected before any line breaks.
 
+Note that the `/` delimiters are optional, but necessary to add flags.
+
+Defaults to using the `u` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^mit$/ui`.
+
 |||
 |---|---|
 |Context|everywhere|
@@ -5944,6 +5949,16 @@ by our supported Node versions):
 Applies to the jsdoc block description and `@description` (or `@desc`)
 by default but the `tags` option (see below) may be used to match other tags.
 
+The default (and all regex options) defaults to using (only) the `u` flag, so
+to add your own flags, encapsulate your expression as a string, but like a
+literal, e.g., `/[A-Z].*\\./ui`.
+
+Note that `/` delimiters are optional, but necessary to add flags (besides
+`u`).
+
+Also note that the default or optional regular expressions is *not*
+case-insensitive unless one opts in to add the `i` flag.
+
 <a name="eslint-plugin-jsdoc-rules-match-description-options-11"></a>
 #### Options
 
@@ -5959,9 +5974,6 @@ You can supply your own expression to override the default, passing a
 }
 ```
 
-As with the default, the supplied regular expression will be applied with the
-Unicode (`"u"`) flag and is *not* case-insensitive.
-
 <a name="eslint-plugin-jsdoc-rules-match-description-options-11-tags-2"></a>
 ##### <code>tags</code>
 
@@ -12181,7 +12193,7 @@ export const bboxToObj = function ({x, y, width, height}) {
 ```
 
 By default `checkTypesPattern` is set to
-`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/`,
+`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/u`,
 meaning that destructuring will be required only if the type of the `@param`
 (the text between curly brackets) is a match for "Object" or "Array" (with or
 without initial caps), "PlainObject", or "GenericObject", "GenericArray" (or
@@ -12191,6 +12203,9 @@ parameters.
 
 Note that the `/` delimiters are optional, but necessary to add flags.
 
+Defaults to using (only) the `u` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^object$/ui`.
+
 You could set this regular expression to a more expansive list, or you
 could restrict it such that even types matching those strings would not
 need destructuring.

src/iterateJsdoc.js

@@ -212,6 +212,10 @@ const getUtils = (
     } : null, tag);
   };
 
+  utils.getRegexFromString = (str, requiredFlags) => {
+    return jsdocUtils.getRegexFromString(str, requiredFlags);
+  };
+
   utils.getDescription = () => {
     const descriptions = [];
     let lastDescriptionLine;

src/jsdocUtils.js

@@ -1179,6 +1179,23 @@ const comparePaths = (name) => {
   };
 };
 
+const getRegexFromString = (regexString, requiredFlags) => {
+  const match = regexString.match(/^\/(.*)\/([gimyus]*)$/us);
+  let flags = 'u';
+  let regex = regexString;
+  if (match) {
+    [, regex, flags] = match;
+    if (!flags) {
+      flags = 'u';
+    }
+  }
+
+  const uniqueFlags = [...new Set(flags + (requiredFlags || ''))];
+  flags = uniqueFlags.join('');
+
+  return new RegExp(regex, flags);
+};
+
 export default {
   comparePaths,
   dropPathSegmentQuotes,
@@ -1191,6 +1208,7 @@ export default {
   getIndent,
   getJsdocTagsDeep,
   getPreferredTagName,
+  getRegexFromString,
   getTagsByType,
   getTagStructureForMode,
   hasATag,

src/rules/checkExamples.js

@@ -22,22 +22,6 @@ const countChars = (str, ch) => {
   return (str.match(new RegExp(escapeStringRegexp(ch), 'gu')) || []).length;
 };
 
-const getRegexFromString = (regexString) => {
-  const match = regexString.match(/^\/(.*)\/([gimyus]*)$/u);
-  let flags = 'u';
-  let regex = regexString;
-  if (match) {
-    [, regex, flags] = match;
-    if (!flags) {
-      flags = 'u';
-    }
-    const uniqueFlags = [...new Set(flags)];
-    flags = uniqueFlags.join('');
-  }
-
-  return new RegExp(regex, flags);
-};
-
 const defaultMdRules = {
   // "always" newline rule at end unlikely in sample code
   'eol-last': 0,
@@ -135,10 +119,10 @@ export default iterateJsdoc(({
   const expressionRules = noDefaultExampleRules ? undefined : defaultExpressionRules;
 
   if (exampleCodeRegex) {
-    exampleCodeRegex = getRegexFromString(exampleCodeRegex);
+    exampleCodeRegex = utils.getRegexFromString(exampleCodeRegex);
   }
   if (rejectExampleCodeRegex) {
-    rejectExampleCodeRegex = getRegexFromString(rejectExampleCodeRegex);
+    rejectExampleCodeRegex = utils.getRegexFromString(rejectExampleCodeRegex);
   }
 
   const checkSource = ({

src/rules/checkParamNames.js

@@ -230,10 +230,7 @@ export default iterateJsdoc(({
     disableExtraPropertyReporting = false,
   } = context.options[0] || {};
 
-  const lastSlashPos = checkTypesPattern.lastIndexOf('/');
-  const checkTypesRegex = lastSlashPos === -1 ?
-    new RegExp(checkTypesPattern) :
-    new RegExp(checkTypesPattern.slice(1, lastSlashPos), checkTypesPattern.slice(lastSlashPos + 1));
+  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);
 
   const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param');
   if (!jsdocParameterNamesDeep.length) {

src/rules/checkValues.js

@@ -11,7 +11,7 @@ export default iterateJsdoc(({
   const {
     allowedLicenses = null,
     allowedAuthors = null,
-    licensePattern = '([^\n]*)',
+    licensePattern = '/([^\n]*)/gu',
   } = options;
 
   utils.forEachPreferredTag('version', (jsdocParameter, targetTagName) => {
@@ -47,7 +47,7 @@ export default iterateJsdoc(({
     }
   });
   utils.forEachPreferredTag('license', (jsdocParameter, targetTagName) => {
-    const licenseRegex = new RegExp(licensePattern, 'g');
+    const licenseRegex = utils.getRegexFromString(licensePattern, 'g');
     const match = jsdocParameter.description.match(licenseRegex);
     const license = match && match[1] || match[0];
     if (!license.trim()) {

src/rules/matchDescription.js

@@ -30,9 +30,8 @@ export default iterateJsdoc(({
       tagValue = options.tags[tagName];
     }
 
-    const regex = new RegExp(
+    const regex = utils.getRegexFromString(
       stringOrDefault(tagValue, options.matchDescription),
-      'u',
     );
 
     if (!regex.test(description)) {

src/rules/requireParam.js

@@ -59,10 +59,7 @@ export default iterateJsdoc(({
     useDefaultObjectProperties = false,
   } = context.options[0] || {};
 
-  const lastSlashPos = checkTypesPattern.lastIndexOf('/');
-  const checkTypesRegex = lastSlashPos === -1 ?
-    new RegExp(checkTypesPattern) :
-    new RegExp(checkTypesPattern.slice(1, lastSlashPos), checkTypesPattern.slice(lastSlashPos + 1));
+  const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);
 
   const missingTags = [];
   const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);