@18f/eslint-plugin-identity 中文文档教程
@18f/eslint-plugin-identity
用于 Login.gov JavaScript 标准的 ESLint 插件和可共享配置。
这些配置在很大程度上继承自 TTS JavaScript 编码标准，预先捆绑了推荐的规则集并扩展以提供对登录的支持。特定于政府的实施选择（Babel、React、Mocha）。
Installation
使用 NPM 或 Yarn 安装。 ESLint 作为对等依赖项是必需的，如果尚未安装，则应安装。
npm install --save-dev @18f/eslint-plugin-identity eslint
如果您的项目中安装了以下任何软件包，则配置会自动包含其他行为：
- If
@babel/coreis installed,@babel/eslint-parseris used as the parser. - If
mochais installed, the Mocha environment and Mocha-specific rules are enabled. - If
reactorpreactis installed, JSX and React rules are enabled. - If
prettieris installed, Prettier rules are enabled.
Usage
目前，一个配置可供使用：推荐 规则集。
因为该模块是作为 ESLint 插件发布的，所以您应该在 ESLint 配置：
{
"extends": ["plugin:@18f/eslint-plugin-identity/recommended"],
"plugins": ["@18f/eslint-plugin-identity"]
}
Frequently Asked Questions
Why are the configurations published under an ESLint plugin?
将包发布为 ESLint 插件的优点是允许在与配置相同的包中实现和使用自定义规则。
License
本项目在美国属于公共领域，通过 CC0 1.0 Universal public 放弃全球作品的版权和相关权利域奉献。
所有对该项目的贡献都将在 CC0 奉献精神下发布。 通过提交拉取请求或问题，您同意遵守此版权利益放弃。
@18f/eslint-plugin-identity
ESLint plugin and shareable configurations for Login.gov JavaScript standards.
These configurations largely inherit from the TTS JavaScript coding standards, pre-bundled with recommended rulesets and extended to provide support for Login.gov-specific implementation choices (Babel, React, Mocha).
Installation
Install using NPM or Yarn. ESLint is required as a peer dependency and should be installed if it is not already.
npm install --save-dev @18f/eslint-plugin-identity eslint
The configuration automatically includes additional behavior if any of the following packages are installed in your project:
- If
@babel/coreis installed,@babel/eslint-parseris used as the parser. - If
mochais installed, the Mocha environment and Mocha-specific rules are enabled. - If
reactorpreactis installed, JSX and React rules are enabled. - If
prettieris installed, Prettier rules are enabled.
Usage
Currently, one configuration is made available for use: the recommended ruleset.
Because the module is published as an ESLint plugin, you should configure it as both a plugins and an extends in your ESLint configuration:
{
"extends": ["plugin:@18f/eslint-plugin-identity/recommended"],
"plugins": ["@18f/eslint-plugin-identity"]
}
Frequently Asked Questions
Why are the configurations published under an ESLint plugin?
Publishing the package as an ESLint plugin has the advantage of allowing for custom rules to be implemented and used within the same package as the configurations.
License
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.
