eslint-config-cit-yuuu

yuuu eslint 代码规范

使用手册

1.使用内置的规则配置

使用如下命令安装依赖

npm install -D eslint @babel/core @babel/eslint-parser eslint-config-yuuu

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

2. react

使用如下命令安装依赖

npm install -D eslint @babel/core @babel/eslint-parser eslint-plugin-react eslint-config-yuuu

注：react 项目如有报@babel/preset-react 的错误，注意提前配置好.babelrc.js， 不然 jsx 解析会报错！！！

module.exports = {
  presets: [
    [
      "@babel/preset-react",
      {
        development: process.env.BABEL_ENV === "development",
      },
    ],
  ],
};

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
    'yuuu/react',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

3. vue

使用如下命令安装依赖

npm install -D eslint @babel/core @babel/eslint-parser vue-eslint-parser eslint-plugin-vue eslint-config-yuuu

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
    'yuuu/vue',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

4. TypeScript

使用如下命令安装依赖

npm install -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-config-yuuu

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
    'yuuu/typescript',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

5. TypeScript React

使用如下命令安装依赖

npm install -D eslint typescript @babel/core @babel/eslint-parser @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-config-yuuu

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
    'yuuu/react',
    'yuuu/typescript',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

6. 原生微信小程序

使用如下命令安装依赖

npm install -D eslint @babel/core @babel/eslint-parser eslint-config-yuuu

在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：

module.exports = {
  extends: [
    'yuuu',
    'yuuu/minip_',
  ],
  env: {
    // 你的环境变量（包含多个预定义的全局变量）
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量（设置为 false 表示它不允许被重新赋值）
    //
    // myGlobal: false
    // 如果小程序中还有一些全局变量报错，请在这里添加并设置为true即可！！！
  },
  rules: {
    // 咱们自定义规则
    // ...
  },
};

搭配起来更好

prettier 配置

可以参考下载依赖后当前工作空间 node_modules/eslint-config-yuuu/com_config 路径下的.prettierrc.js文件。复制到当前 workplace 跟目录下。

vscode 配置

可以参考下载依赖后当前工作空间 node_modules/eslint-config-yuuu/com_config 路径下的.vscode文件夹，可以 copy 到当前 workplace 根目录下。

或者你直接在项目根目录下执行cp -r node_modules/eslint-config-yuuu/com_config/.* ./

命令行使用方式

保证自己安装了 node 环境，并且安装了 eslint，才可执行以下命令哦！！！

eg:

eslint -c .eslintrc.js --ext .js,.jsx,.ts,.tsx,.vue -o report.json -f json "src/**"

使用 当前目录下.eslintrc.js 配置文件 对当前目录src目录下所有的 js、ts、jsx、tsx、vue等类型文件进行规则扫描，并产出json类型的文件report.json，其中就是此次检验的结果

以上就可以预先统一提取出来几种 eslint 配置脚本(并且最好统一扫描目录 src[团队规则中也应该统一项目目录！！！])：

.eslintrc.js
.react.eslintrc.js
.vue.eslintrc.js
.typescript.eslintrc.js
.typescript.react.eslintrc.js

详细命令请运行eslint -h查看！！！