@wordpress/eslint插件

ESLint公司插件,包括WordPress开发的配置和自定义规则。

安装

安装模块

npm install@wordpress/eslint-plugin--保存-dev

注释:此软件包要求Node.js版本具有长期支持状态(请检查活动LTS或维护LTS版本). 它与旧版本不兼容。

用法

要选择默认配置,请扩展您自己的项目.eslintrc文件文件:

{“扩展”:[“插件:@wordpress/eslint-plugin/推荐”]}

请参阅关于可共享配置的ESLint文档了解更多信息。

这个推荐预设将包括管理ES2015+环境的规则,并包括来自eslint-plugin-jsdoc软件,eslint-plugin-jsx-a11y公司,eslint-plugin反应和其他类似插件。

此预设提供了与eslint-plugin-prettier静电针运行的包更漂亮代码格式化程序并将差异报告为单个ESLint问题。您可以通过安装更漂亮单独包装:

npm安装更漂亮--保存-dev

最后,此规则集还包括与@typescript-eslint/eslint-plugin类型脚本使ESLint能够支持类型脚本语言。您可以通过安装打字稿单独包装:

npm安装类型脚本--保存-dev

还有建议使用成型希望确保更漂亮类型脚本集成从未激活。此预设已启用本机ESLint代码格式规则。

规则集

或者,您可以选择只使用插件提供的更精细的规则集。其中包括:

  • 习俗–WordPress开发的自定义规则。
  • 电子系统5–传统ES5环境的规则。
  • esnext公司–ES2015+环境的规则。
  • 国际18n——国际化规则。
  • jsdoc公司–JSDoc注释规则。
  • jsx-a11y–JSX中的可访问性规则。
  • 反应–React组件的规则。
  • 试验-e2e–用Puppeter编写的端到端测试规则。
  • 测试单元–用Jest编写的单元测试规则。
  • 测试塑性–用Playwright编写的端到端测试规则。

例如,如果您的项目不使用React,您可以考虑使用以下内容扩展项目中仅包括ESNext规则延伸定义:

{“扩展”:[“插件:@wordpress/eslint-plugin/esnext”]}

这些规则可以附加使用,因此您可以扩展这两个规则esnext公司习俗规则集,但省略反应jsx-a11y配置。

粒度规则集不会定义任何环境全局变量。因此,如果项目需要它们,您需要自己定义它们。

规则

规则 描述 推荐
数据-存储-字符串 不鼓励将字符串文本传递给引用数据存储。
依赖组 强制依赖关系文档块格式。
i18n-省略号 不允许在可翻译字符串中使用三个点。
i18n-连字符范围 不允许在可翻译字符串中使用连字符数字范围。
i18n-不可压垮白人 不允许在可翻译字符串中使用可折叠空格。
i18n-无空白空白 不允许在可翻译字符串中使用前导或尾随空格。
仅限i18n-无支架 防止在可翻译字符串中仅使用占位符。
i18n-无变量 强制字符串文字作为转换函数参数。
i18n文本域 强制传递有效的文本域。
i18n-翻译注释 强制添加翻译人员注释。
无碱控制-带标签-无id 不允许将BaseControl组件与标签属性集一起使用,但忽略id属性。
无语言的get-range-at 不允许使用unguarded获取范围电话。
无-无-wp-api 禁止从中使用不安全的API@文字出版社/*包装sl
禁止使用车辆-提前归还 如果在返回之前未使用,则不允许分配变量值。
无wp-process-env 不允许通过旧版本使用WordPress变量处理env喜欢处理版本。脚本_取消.
反应无安全超时 不允许不安全设置超时组件中。
有效打印 强制使用有效的sprintf。
wp-global使用 强制正确使用WordPress全局变量,如全球这个。脚本_取消.

遗产

如果您使用WordPress.jshintrc文件JSHint配置,并且您希望第一步迁移到等效的ESLint,也可以定义您自己的项目.eslintrc文件文件为:

{“扩展”:[“插件:@wordpress/eslint-plugin/jshint”]}

参与此包

这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值法并由使用WordPress(文字出版社)以及其他软件项目。

要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容贡献者指南.