@magijs/lint

lint

配置原则

我们依据以下三条原则，研读了 ESLint 所有的配置项，定制出了心目中的「完美」ESLint 配置。

1. 能够帮助发现代码错误的规则，全部开启
2. 配置不应该依赖于某个具体项目，而应尽可能的合理
3. 帮助保持团队的代码风格统一，而不是限制开发体验

配置解读

我们对每一条配置，都有详尽的注释，这样不仅方便了我们自己查阅某项配置的意义和原因，也使大家更容易配置出自己心目中的规则：

• 每一条配置都有注释说明此配置的用途
• 对于理解困难的配置，都在注释中有举例
• 对于有争议的配置，都在注释中说明了为什么要这么配置的原因
• 对于关闭掉的配置，都在注释中有对应的原因说明，以及 @off 的标识
• 对于能够 autofix 的配置，都在注释中有标注 @autofix

使用

安装

yarn add @magijs/lint@latest

执行命令

# 执行eslint检查js代码规范
zalint eslint

# 执行stylelint检查样式规范
zalint stylelint

# 生成报告，同时执行eslint和stylelint
zalint report

指定静态扫描目录

# 指定扫描client目录
zalint eslint client

# 指定扫描client目录
zalint stylelint client

# 指定扫描client目录
zalint report client

自定义配置规则

zalintrc.json 配置文件，并且上传配置数据

{
  "eslintrc": {
    "rules": {
      "indent": "error"
    }
  },
  "stylelintrc": {
    "rules": {}
  },
  "prettierrc": {
    "rules": {
      "arrowParens": "always"
    }
  }
}

link

https://alloyteam.github.io/eslint-config-alloy/?language=zh-CN