简介

eslint-plugin-regexp是一个用于查找正则表达式错误和违反正则表达式风格指南的ESLint插件。

<!--PACKAGE_STATUS_START-->

<!--PACKAGE_STATUS_END-->

:name_badge: 特性

这个ESLint插件提供了与更好地使用正则表达式相关的检查规则，帮助您避免在使用正则表达式时出现问题。

• 发现正则表达式的错误用法，并提供提示。
• 强制执行一致的正则表达式风格。
• 提供编写优化正则表达式的提示。
• 80条针对正则表达式语法和特性的插件规则。

您可以在在线演示中进行检查。

<!--DOCS_IGNORE_START-->

:book: 文档

请查看文档。

:cd: 安装

npm install --save-dev eslint eslint-plugin-regexp

要求

• ESLint v8.44.0及以上版本
• Node.js v18.x, v20.x及以上版本

<!--DOCS_IGNORE_END-->

:book: 使用方法

<!--USAGE_SECTION_START-->

在您的eslint.config.js或.eslintrc配置文件的plugins部分添加regexp（您可以省略eslint-plugin-前缀），然后使用两种可用配置之一（recommended或all）或配置您想要的规则：

推荐配置（新配置）

plugin.configs["flat/recommended"]配置启用了一部分规则，这些规则对大多数用户来说应该是最有用的。 更多详情请参见lib/configs/rules/recommended.ts。

// eslint.config.js
import * as regexpPlugin from "eslint-plugin-regexp"

export default [
    regexpPlugin.configs["flat/recommended"],
];

推荐配置（旧配置）

plugin:regexp/recommended配置启用了一部分规则，这些规则对大多数用户来说应该是最有用的。 更多详情请参见lib/configs/rules/recommended.ts。

// .eslintrc.js
module.exports = {
    "plugins": [
        "regexp"
    ],
    "extends": [
         // 在这里添加更多通用规则集，例如：
         // 'eslint:recommended',
        "plugin:regexp/recommended"
    ]
}

高级配置

覆盖/添加特定规则配置。另请参见：http://eslint.org/docs/user-guide/configuring。

// eslint.config.js
import * as regexpPlugin from "eslint-plugin-regexp"

export default [
    {
        plugins: { regexp: regexpPlugin },
        rules: {
            // 在此处覆盖/添加规则设置，例如：
            "regexp/rule-name": "error"
        }
    }
];

// .eslintrc.js
module.exports = {
    "plugins": [
        "regexp"
    ],
    "rules": {
        // 在此处覆盖/添加规则设置，例如：
        "regexp/rule-name": "error"
    }
}

使用全部配置

plugin.configs["flat/all"] / plugin:regexp/all配置启用所有规则。它适用于测试，而不是生产环境，因为它会随着插件的每个小版本和主版本而变化。使用时请自行承担风险。 更多详情请参见lib/configs/rules/all.ts。

<!--USAGE_SECTION_END-->

:white_check_mark: 规则

<!-- begin auto-generated rules list -->

💼 表示在配置中启用。
⚠️ 表示在配置中设置为警告。
🟢 表示在flat/recommended配置中设置。
🔵 表示在recommended配置中设置。
🔧 表示可以通过--fix CLI选项自动修复。
💡 表示可以通过编辑器建议手动修复。

可能的错误

名称	描述	💼	⚠️	🔧	💡
no-contradiction-with-assertion	禁止与断言相矛盾的元素	🟢 🔵			💡
no-control-character	禁止控制字符				💡
no-dupe-disjunctions	禁止重复的分支	🟢 🔵			💡
no-empty-alternative	禁止没有元素的分支		🟢 🔵		💡
no-empty-capturing-group	禁止捕获空内容的捕获组	🟢 🔵
no-empty-character-class	禁止不匹配任何字符的字符类	🟢 🔵
no-empty-group	禁止空组	🟢 🔵
no-empty-lookarounds-assertion	禁止空的先行断言或后行断言	🟢 🔵
no-escape-backspace	禁止转义退格符（[\b]）	🟢 🔵			💡
no-invalid-regexp	禁止在 RegExp 构造函数中使用无效的正则表达式字符串	🟢 🔵
no-lazy-ends	禁止在表达式末尾使用惰性量词		🟢 🔵		💡
no-misleading-capturing-group	禁止行为不符合预期的捕获组	🟢 🔵			💡
no-misleading-unicode-character	禁止在字符类和量词中使用多码点字符	🟢 🔵		🔧	💡
no-missing-g-flag	禁止在用于 String#matchAll 和 String#replaceAll 的模式中缺少 g 标志	🟢 🔵		🔧
no-optional-assertion	禁止可选断言	🟢 🔵
no-potentially-useless-backreference	禁止引用可能未匹配的组的反向引用		🟢 🔵
no-super-linear-backtracking	禁止指数级和多项式回溯	🟢 🔵		🔧
no-super-linear-move	禁止导致二次方移动的量词
no-useless-assertions	禁止已知总是接受（或拒绝）的断言	🟢 🔵			💡
no-useless-backreference	禁止正则表达式中无用的反向引用	🟢 🔵
no-useless-dollar-replacements	禁止替换字符串中无用的 $ 替换	🟢 🔵
strict	禁止不严格有效的正则表达式	🟢 🔵		🔧	💡

最佳实践

名称	描述	💼	⚠️	🔧	💡
confusing-quantifier	禁止使用容易混淆的量词		🟢 🔵
control-character-escape	强制控制字符的一致转义	🟢 🔵		🔧
negation	强制对否定使用转义	🟢 🔵		🔧
no-dupe-characters-character-class	禁止在正则表达式字符类中使用重复字符	🟢 🔵		🔧
no-empty-string-literal	禁止在字符类中使用空字符串字面量	🟢 🔵
no-extra-lookaround-assertions	禁止不必要的嵌套环视断言	🟢 🔵		🔧
no-invisible-character	禁止使用不可见的原始字符	🟢 🔵		🔧
no-legacy-features	禁止使用遗留的正则表达式特性	🟢 🔵
no-non-standard-flag	禁止使用非标准标志	🟢 🔵
no-obscure-range	禁止使用晦涩的字符范围	🟢 🔵
no-octal	禁止使用八进制转义序列				💡
no-standalone-backslash	禁止使用独立的反斜杠（\）
no-trivially-nested-assertion	禁止使用简单嵌套的断言	🟢 🔵		🔧
no-trivially-nested-quantifier	禁止使用可以重写为单个量词的嵌套量词	🟢 🔵		🔧
no-unused-capturing-group	禁止未使用的捕获组	🟢 🔵		🔧	💡
no-useless-character-class	禁止只有一个字符的字符类	🟢 🔵		🔧
no-useless-flag	禁止不必要的正则表达式标志		🟢 🔵	🔧
no-useless-lazy	禁止不必要的非贪婪量词	🟢 🔵		🔧
no-useless-quantifier	禁止可以移除的量词	🟢 🔵		🔧	💡
no-useless-range	禁止不必要的字符范围	🟢 🔵		🔧
no-useless-set-operand	禁止表达式字符类中不必要的元素	🟢 🔵		🔧
no-useless-string-literal	禁止在 \q{...} 中使用单个字符的字符串分离	🟢 🔵		🔧
no-useless-two-nums-quantifier	禁止不必要的 {n,m} 量词	🟢 🔵		🔧
no-zero-quantifier	禁止最大值为零的量词	🟢 🔵			💡
optimal-lookaround-quantifier	禁止环视的备选项以非常量量词结尾		🟢 🔵		💡
optimal-quantifier-concatenation	要求连接的量词使用最优量词	🟢 🔵		🔧
prefer-escape-replacement-dollar-char	强制转义替换字符串中的 $ 字符（$$）
prefer-predefined-assertion	优先使用预定义断言而非等效的环视	🟢 🔵		🔧
prefer-quantifier	强制使用量词			🔧
prefer-range	强制使用字符类范围	🟢 🔵		🔧
prefer-regexp-exec	如果未提供全局标志，强制使用 RegExp#exec 而不是 String#match
prefer-regexp-test	强制使用 RegExp#test 而不是 String#match 和 RegExp#exec			🔧
prefer-set-operation	优先使用字符类集合操作而不是前瞻/后顾断言	🟢 🔵		🔧
require-unicode-regexp	强制使用 u 标志			🔧
require-unicode-sets-regexp	强制使用 v 标志			🔧
simplify-set-operations	要求简化集合操作	🟢 🔵		🔧
sort-alternatives	如果顺序无关紧要，则对备选项进行排序			🔧
use-ignore-case	如果能简化模式，则使用 i 标志	🟢 🔵		🔧

风格问题

名称	描述	💼	⚠️	🔧	💡
grapheme-string-literal	强制在字符串字面量中使用单个字素
hexadecimal-escape	强制一致使用十六进制转义			🔧
letter-case	强制使用你喜欢的大小写			🔧
match-any	强制使用匹配任意字符的风格	🟢 🔵		🔧
no-useless-escape	禁止在正则表达式中使用不必要的转义字符	🟢 🔵		🔧
no-useless-non-capturing-group	禁止不必要的非捕获组	🟢 🔵		🔧
prefer-character-class	强制使用字符类	🟢 🔵		🔧
prefer-d	强制使用 \d	🟢 🔵		🔧
prefer-lookaround	优先使用前瞻/后顾而不是不进行替换的捕获组			🔧
prefer-named-backreference	强制使用命名的反向引用			🔧
prefer-named-capture-group	强制使用命名的捕获组
prefer-named-replacement	强制使用命名替换			🔧
prefer-plus-quantifier	强制使用 + 量词	🟢 🔵		🔧
prefer-question-quantifier	强制使用 ? 量词	🟢 🔵		🔧
prefer-result-array-groups	强制使用结果数组的 groups			🔧
prefer-star-quantifier	强制使用 * 量词	🟢 🔵		🔧
prefer-unicode-codepoint-escapes	强制使用 Unicode 码点转义	🟢 🔵		🔧
prefer-w	强制使用 \w	🟢 🔵		🔧
sort-character-class-elements	强制字符类中元素的顺序			🔧
sort-flags	要求正则表达式标志按顺序排序	🟢 🔵		🔧
unicode-escape	强制一致使用 Unicode 转义或 Unicode 码点转义			🔧
unicode-property	强制 Unicode 属性命名的一致性			🔧

<!-- 自动生成的规则列表结束 --> <!--REMOVED_RULES_START-->

已移除

• :no_entry: 这些规则在之前的主要版本中被移除，此前它们已被弃用一段时间。

规则 ID	替代规则	移除版本
no-assertion-capturing-group	regexp/no-empty-capturing-group	v2.0.0
no-useless-exactly-quantifier	regexp/no-useless-quantifier, regexp/no-zero-quantifier	v2.0.0
no-useless-non-greedy	regexp/no-useless-lazy	v2.0.0
order-in-character-class	regexp/sort-character-class-elements	v2.0.0
prefer-t	regexp/control-character-escape	v2.0.0

<!--REMOVED_RULES_END-->

:gear: 设置

请参阅 设置。

<!--DOCS_IGNORE_START-->

:traffic_light: 语义化版本控制策略

eslint-plugin-regexp 遵循 语义化版本控制 和 ESLint 的语义化版本控制策略。

:beers: 贡献

欢迎贡献！

请使用 GitHub 的 Issues/PRs。

参见 CONTRIBUTING.md。

开发工具

• npm test 运行测试并测量覆盖率。
• npm run update 运行以更新 readme 和推荐配置。
• npm run new [新规则名称] 运行以创建新规则所需的文件。
• npm run docs:watch 在本地启动网站。

:lock: 许可证

有关许可权利和限制（MIT），请参阅 LICENSE 文件。