前言：@coorpacademy/eslint-plugin-coorpacademy 是一个开源的 npm 包，旨在帮助开发者在项目中使用 ESLint 进行代码规范检查。该包是由 Coorpacademy（一家在线学习平台）开发的标准 JavaScript 代码风格规范。
安装
首先，你需要在项目中安装 @coorpacademy/eslint-plugin-coorpacademy 这个 npm 包。在命令行中输入以下命令即可：
npm install @coorpacademy/eslint-plugin-coorpacademy --save-dev
或者使用 yarn 安装：
yarn add @coorpacademy/eslint-plugin-coorpacademy --dev
配置
接下来，在项目的根目录中创建一个 .eslintrc.json 文件，并添加以下配置：
-- -------------------- ---- ------- - ---------- ------------------------------- ---------- ----------------------- -------- - --------------------------------------- -------- --------------------------------------------- --------- -------- ---------------------------------------- --------- -------------- ----------------------------------------------- ------- - -展开代码
通过以上配置，你可以启用 @coorpacademy/eslint-plugin-coorpacademy 中的四条检查规则：
@coorpacademy/coorpacademy/camelcase: 对象的属性名必须使用驼峰命名法。@coorpacademy/coorpacademy/consistent-this: 关键字this必须被声明为self。@coorpacademy/coorpacademy/func-style: 函数声明必须使用函数表达式。@coorpacademy/coorpacademy/newline-after-var: 变量声明后必须有一个空行。
当然，你可以根据自己的项目需要，调整其中的参数。如果你想要添加新的规则，只需要在 rules 中添加即可：
-- -------------------- ---- ------- - -------- - --------------------------------------- -------- --------------------------------------------- --------- -------- ---------------------------------------- --------- -------------- ----------------------------------------------- -------- -------------------- -------- ------------------- ------- - -展开代码
使用示例
-- -------------------- ---- ------- ----- ------ - ----------------- - --------- - ----- ------------- - ------- - ------------------- --------- - --------- - ------ ---------- - - ----- -- - --- --------------- --------------------------展开代码
如果你现在运行 eslint your-file-name.js 命令，你应该可以看到类似这样的输出：
/path/to/your/file.js 1:7 error Property name "name" must use camelCase @coorpacademy/coorpacademy/camelcase 6:3 error Expected 'this' to be named 'self' @coorpacademy/coorpacademy/consistent-this 9:3 error Function declaration must use function expression @coorpacademy/coorpacademy/func-style
这是因为上面代码中，我们使用了不符合 @coorpacademy/eslint-plugin-coorpacademy 规范的变量命名、关键字 this 和函数声明方式。
修改之后的示例：
-- -------------------- ---- ------- ----- ------ - ----------------- - ---------- - ----- ------------- - ------- - ------------------- --------- - --------- - ------ ----------- - - ----- ---- - --- --------------- ----------------------------展开代码
再次运行 eslint your-file-name.js 命令，你会发现没有错误信息输出，代码符合了规范。
结束语
@coorpacademy/eslint-plugin-coorpacademy 为我们提供了一种规范的代码风格。如果你认真学习并使用它，在长期的项目开发中，它能够帮你提高代码质量以及开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/158619
