@colorless/eslint-config

ESlint是代码质量检测的工具，它通过静态扫描的方式结合相对应的代码编写规范，让你在开发过程中发现其代码中出现的问题，避免将问题遗留至运行时。想要了解更多信息请移步官网

本项目提供了开箱即用的团队内部的统一代码质量标准，项目中配合git hooks即可在每一次提交代码对其进行质量检测。

规则列表

| 规则 | 说明 | 详细的规则说明 | | ------------------------------ | ------------------------ | ------------------------------------------------- | | @typescript-eslint/recommended | typescript的业界最佳实践 | 详细规则 | | eslint:recommended | 业界javascript的最佳实践 | 详细规则 | | vue/vue3-recommended | vue3官方最佳实践 | 详细规则 |

如何使用

Step.1 安装规范包

pnpm add @colorless/eslint-config -D

Step.2 在eslint的配置文件(..eslintrc.js)中进行配置

module.exports = {
  root: true,
  env: {
    browser: true,
    node: true
  },
  extends: '@colorless/eslint-config'
}

配置说明

本项目提供了两种eslint配置

• vue环境
• typescript环境

vue环境

如果你的项目是一个运行在浏览器端的vue 3项目，则可以使用默认的配置导出，或者指定其配置文件：

module.exports = {
  root: true,
  env: {
    browser: true,
    node: true
  },
  // 包的默认导出是vue3的规范
  extends: '@colorless/eslint-config'
}

typescript环境

如果你的项目是一个纯typescript项目，那么可能不需要其他不必要的lint，那么你可以使用@colorless/eslint-config/typescript这个规范，它将只包含在纯typescript下应该包含的规则

module.exports = {
  root: true,
  env: {
    browser: true,
    node: true
  },
  // 包的默认导出是vue3的规范
  extends: '@colorless/eslint-config/typescript'
}