npm 包 eslint-config-hapjs 使用教程

1. 什么是 eslint-config-hapjs

eslint-config-hapjs 是针对 Hap 应用开发的 eslint 规则集，基于 eslint-config-airbnb 和 eslint-config-standard 扩展定制。

2. 安装

全局安装：

npm install -g eslint-config-hapjs

或者本地安装：

npm install -D eslint-config-hapjs

3. 使用方法

在项目的根目录下创建 .eslintrc.js 文件，写入如下内容：

module.exports = {
  extends: ['hapjs'],
  rules: {
    // 这里可以添加项目独有的规则
  }
};

这里的 extends 就是引入 eslint-config-hapjs。

同时，也可以结合 Prettier 使用，做到更加规范的代码格式化：

module.exports = {
  extends: ['hapjs', 'prettier'],
  plugins: ['prettier'],
  rules: {
    'prettier/prettier': 'error',
    // 这里可以添加项目独有的规则
  }
};

4. 规则说明

eslint-config-hapjs 所包含的规则，具体参见：

• eslint-config-airbnb
• eslint-config-standard
• eslint-plugin-import
• eslint-plugin-node
• eslint-plugin-promise
• eslint-plugin-react
• eslint-plugin-react-native

5. 示例代码

以下是一个简单的例子，用于演示如何结合 eslint-config-hapjs 使用 ESLint。

// app.js
const foo = () => {
  console.log('这是一条不被允许的警告');
};

foo();

执行命令 eslint app.js 后，会得到如下输出：

error  Missing space before function parentheses  prettier/prettier
warning  Unexpected console statement  no-console
warning  'foo' is assigned a value but never used  no-unused-vars

这里包含了使用 eslint-config-hapjs 后的一些规则提示，其中包含了未经允许的 console 输出警告等。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005768181e8991b448eaa20