1.0.0-alpha.13 • Published 3 years ago

zgz-eslint-config-test v1.0.0-alpha.13

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

@zcool/eslint-config

eslint config for zcool

Usage

  1. 安装eslint

    yarn add eslint -D
  2. 如果不同的parser

    1. 如果项目为JavaScript项目,安装babel-eslint
    2. 如果项目为TypeScript项目,安装@typescript-eslint/parser
  3. 安装@zcool/eslint-config

    yarn -D add @zcool/eslint-config
  4. 添加.eslintrc.js文件,并集成不同的配置

    1. 如果当前项目环境为React + JavaScript,添加以下内容:
      module.exports = {
        extends: '@zcool/eslint-config/browser'
      }
    1. 如果当前项目环境为React + TypeScript,添加以下内容:
      module.exports = {
        extends: '@zcool/eslint-config/browser-ts'
      }
    1. 如果当前项目环境为Node.js + CommonJS,添加以下内容:
      module.exports = {
        extends: '@zcool/eslint-config/node'
      }
    1. 如果当前项目环境为Node.js + TypeScript,添加以下内容:
      module.exports = {
        extends: '@zcool/eslint-config/node-ts'
      }
  5. 如果开发环境为vscode,可以安装vscode-eslint插件以获取更好的按开发体验。

TODO

  • separate this package into multiple packages managed by lerna
    • @zcool/eslint-config-browser
    • @zcool/eslint-config-browser-ts
    • @zcool/eslint-config-node
    • @zcool/eslint-config-node-ts
  • migrate babel-eslint to @babel/eslint-parser when it's ready