简介

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

:name_badge: 特性

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

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

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

:book: 文档

请查看文档。

:cd: 安装

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

要求

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

:book: 使用方法

在您的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。

:white_check_mark: 规则

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

可能的错误

最佳实践

风格问题

已移除

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

:gear: 设置

请参阅 设置。

: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 文件。