📜  eslint-config-standard (1)

📅  最后修改于: 2023-12-03 15:14:54.309000             🧑  作者: Mango

Eslint-config-standard

介绍

Eslint-config-standard 是一个 eslint 的扩展插件,基于 StandardJS 的规则,帮助开发者强制使用一些通用的代码风格,提高代码质量和可维护性。

特点
  • 简单易用:简洁的规则,易于上手。
  • 灵活配置:可以添加和修改规则,适应不同的项目需要。
  • 覆盖面广:支持多种脚本类型,如 es6、node、browser等。
  • 高度可定制化:可以与其他插件结合使用,定制更多规则。
安装

目前,我们支持 npm 包管理器安装。

npm install eslint-config-standard --save-dev
配置

在项目根目录下新建一个 '.eslintrc.js' 文件,override 对象里面为项目着重测试的规则,extend 继承其他的Eslint配置项,settings指定了全局变量的命名:

module.exports = {
  'extends': [
    'standard'
  ],
  'rules': {
    'semi': [2, 'always'], // 必须加分号
    'indent': ['error', 2], // 2个空格
    'no-unused-vars': 'off', // 关闭未使用变量警告
  },
  'settings': {
    'some-global': 'readonly',
    'import/resolver': {
        'eslint-import-resolver-my-custom-alias': true
    },
    'import/extensions': [
        '.js'
    ]
  }
};
如何使用

Eslint默认使用客户端CLI模式,通过node.js运行,cli所需的参数可以通过CLI输入,也可以在配置文件中指定。

脚本
"scripts": {
    "lint": "eslint ./ --ext .js,.vue",
}

现在我们就可以通过 npm run lint 执行lint。

结语

Eslint-config-standard 的优势在于其保证所有代码格式的一致性,从而使得优化和修改变得更加容易,使出色的开发实践成为可能。如果你刚开始学习javascript,那么你应该认真考虑使用 Eslint-config-standard,这将会是一个好的开始,让你养成好的代码习惯。