fix: use v flag in regexes; match emojis for sentence terminator; fixes #1433 (#1437)

BREAKING CHANGE:

Uses `v` flag instead of `u` flag by default for regular expressions

Author: brettz9

.README/rules/check-examples.md

@@ -37,15 +37,15 @@ syntax highlighting). The following options determine whether a given
   exists or matches, the whole matching expression will be used.
   An example might be ````"^```(?:js|javascript)([\\s\\S]*)```\s*$"````
   to only match explicitly fenced JavaScript blocks. Defaults to only
-  using the `u` flag, so to add your own flags, encapsulate your
+  using the `v` flag, so to add your own flags, encapsulate your
   expression as a string, but like a literal, e.g., ````/```js.*```/gi````.
   Note that specifying a global regular expression (i.e., with `g`) will
   allow independent linting of matched blocks within a single `@example`.
 * `rejectExampleCodeRegex` - Regex blacklist which rejects
   non-lintable examples (has priority over `exampleCodeRegex`). An example
   might be ```"^`"``` to avoid linting fenced blocks which may indicate
   a non-JavaScript language. See `exampleCodeRegex` on how to add flags
-  if the default `u` is not sufficient.
+  if the default `v` is not sufficient.
 
 If neither is in use, all examples will be matched. Note also that even if
 `captionRequired` is not set, any initial `<caption>` will be stripped out

.README/rules/check-values.md

@@ -34,16 +34,16 @@ If present as an array, will be used in place of SPDX identifiers.
 
 ### `licensePattern`
 
-A string to be converted into a `RegExp` (with `u` flag) and whose first
+A string to be converted into a `RegExp` (with `v` 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\r]*)/gu`, i.e., the SPDX expression
+matched will be used). Defaults to `/([^\n\r]*)/gv`, 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`.
+Defaults to using the `v` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^mit$/vi`.
 
 ### `numericOnlyVariation`
 

.README/rules/match-description.md

@@ -8,7 +8,7 @@ The default is this basic expression to match English sentences (Support
 for Unicode upper case may be added in a future version when it can be handled
 by our supported Node versions):
 
-``^\n?([A-Z`\\d_][\\s\\S]*[.?!`]\\s*)?$``
+``^\n?([A-Z`\\d_][\\s\\S]*[.?!`\\p{RGI_Emoji}]\\s*)?$``
 
 Applies by default to the jsdoc block description and to the following tags:
 
@@ -19,9 +19,9 @@ Applies by default to the jsdoc block description and to the following tags:
 
 In addition, 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
+The default (and all regex options) defaults to using (only) the `v` flag, so
 to add your own flags, encapsulate your expression as a string, but like a
-literal, e.g., `/[A-Z].*\\./ui`.
+literal, e.g., `/[A-Z].*\\./vi`.
 
 Note that `/` delimiters are optional, but necessary to add flags (besides
 `u`).

.README/rules/require-param.md

@@ -307,7 +307,7 @@ export const bboxToObj = function ({x, y, width, height}) {
 ```
 
 By default `checkTypesPattern` is set to
-`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/u`,
+`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/v`,
 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
@@ -317,8 +317,8 @@ 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`.
+Defaults to using (only) the `v` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^object$/vi`.
 
 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

docs/rules/check-examples.md

@@ -56,15 +56,15 @@ syntax highlighting). The following options determine whether a given
   exists or matches, the whole matching expression will be used.
   An example might be ````"^```(?:js|javascript)([\\s\\S]*)```\s*$"````
   to only match explicitly fenced JavaScript blocks. Defaults to only
-  using the `u` flag, so to add your own flags, encapsulate your
+  using the `v` flag, so to add your own flags, encapsulate your
   expression as a string, but like a literal, e.g., ````/```js.*```/gi````.
   Note that specifying a global regular expression (i.e., with `g`) will
   allow independent linting of matched blocks within a single `@example`.
 * `rejectExampleCodeRegex` - Regex blacklist which rejects
   non-lintable examples (has priority over `exampleCodeRegex`). An example
   might be ```"^`"``` to avoid linting fenced blocks which may indicate
   a non-JavaScript language. See `exampleCodeRegex` on how to add flags
-  if the default `u` is not sufficient.
+  if the default `v` is not sufficient.
 
 If neither is in use, all examples will be matched. Note also that even if
 `captionRequired` is not set, any initial `<caption>` will be stripped out

docs/rules/check-values.md

@@ -52,16 +52,16 @@ If present as an array, will be used in place of SPDX identifiers.
 <a name="check-values-options-licensepattern"></a>
 ### <code>licensePattern</code>
 
-A string to be converted into a `RegExp` (with `u` flag) and whose first
+A string to be converted into a `RegExp` (with `v` 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\r]*)/gu`, i.e., the SPDX expression
+matched will be used). Defaults to `/([^\n\r]*)/gv`, 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`.
+Defaults to using the `v` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^mit$/vi`.
 
 <a name="user-content-check-values-options-numericonlyvariation"></a>
 <a name="check-values-options-numericonlyvariation"></a>

docs/rules/match-description.md

@@ -20,7 +20,7 @@ The default is this basic expression to match English sentences (Support
 for Unicode upper case may be added in a future version when it can be handled
 by our supported Node versions):
 
-``^\n?([A-Z`\\d_][\\s\\S]*[.?!`]\\s*)?$``
+``^\n?([A-Z`\\d_][\\s\\S]*[.?!`\\p{RGI_Emoji}]\\s*)?$``
 
 Applies by default to the jsdoc block description and to the following tags:
 
@@ -31,9 +31,9 @@ Applies by default to the jsdoc block description and to the following tags:
 
 In addition, 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
+The default (and all regex options) defaults to using (only) the `v` flag, so
 to add your own flags, encapsulate your expression as a string, but like a
-literal, e.g., `/[A-Z].*\\./ui`.
+literal, e.g., `/[A-Z].*\\./vi`.
 
 Note that `/` delimiters are optional, but necessary to add flags (besides
 `u`).
@@ -970,7 +970,7 @@ function quux (foo) {
  * - the `loadScript` option is set to `true`.
  * @param enabled `true` to enable, `false` to disable. Default: `true`.
  */
-// "jsdoc/match-description": ["error"|"warn", {"contexts":["any"],"mainDescription":"/^[A-Z`-].*\\.$/us","matchDescription":"^([A-Z`-].*(\\.|:)|-\\s.*)$","tags":{"param":true,"returns":true}}]
+// "jsdoc/match-description": ["error"|"warn", {"contexts":["any"],"mainDescription":"/^[A-Z`\\-].*\\.$/vs","matchDescription":"^([A-Z`\\-].*(\\.|:)|-\\s.*)$","tags":{"param":true,"returns":true}}]
 
 /**
  * @constructor
@@ -998,5 +998,10 @@ function foo(): void;
 function quux () {
 }
 // "jsdoc/match-description": ["error"|"warn", {"nonemptyTags":false}]
+
+/**
+ * Example text. 🙂
+ */
+export const example = () => { };
 ````
 

docs/rules/match-name.md

@@ -183,7 +183,7 @@ function quux () {}
  * @template
  */
 // "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^$/","tags":["template"]}]}]
-// Message: Only allowing names not matching `/^$/u` but found "".
+// Message: Only allowing names not matching `/^$/v` but found "".
 ````
 
 

docs/rules/require-param.md

@@ -362,7 +362,7 @@ export const bboxToObj = function ({x, y, width, height}) {
 ```
 
 By default `checkTypesPattern` is set to
-`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/u`,
+`/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/v`,
 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
@@ -372,8 +372,8 @@ 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`.
+Defaults to using (only) the `v` flag, so to add your own flags, encapsulate
+your expression as a string, but like a literal, e.g., `/^object$/vi`.
 
 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

eslint.config.js

@@ -39,6 +39,12 @@ export default [
       'linebreak-style': 0,
       'no-inline-comments': 0,
       'prefer-named-capture-group': 0,
+      'require-unicode-regexp': [
+        'error',
+        {
+          requireFlag: 'v',
+        },
+      ],
       'unicorn/import-index': 0,
       'unicorn/no-array-reduce': 0,
       'unicorn/no-unsafe-regex': 0,