@lint-spec/eslint-config

前端编码规范 JavaScript TypeScript Node 规范

提供了多套配置文件以支持 JavaScript、TypeScript、React、Vue、Node.js 等多种项目类型。

v2.0.0 版本已升级至 ESLint 9，使用 flat config 格式。

安装

npm i -D @lint-spec/eslint-config eslint

使用

ESLint 9 使用 flat config 格式，需要在项目根目录创建 eslint.config.js 文件：

JavaScript 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config';

export default [...lintSpecConfig];

React 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/react';

export default [...lintSpecConfig];

Vue 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/vue';

export default [...lintSpecConfig];

Node.js 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/node';

export default [...lintSpecConfig];

TypeScript 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/typescript';

export default [...lintSpecConfig];

TypeScript + React 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/typescript/react';

export default [...lintSpecConfig];

TypeScript + Vue 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/typescript/vue';

export default [...lintSpecConfig];

TypeScript + Node.js 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/typescript/node';

export default [...lintSpecConfig];

ES5 项目

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config/es5';

export default [...lintSpecConfig];

配合 Prettier 使用

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config';
import prettierConfig from 'eslint-config-prettier';

export default [
  ...lintSpecConfig,
  prettierConfig,
];

添加忽略配置

ESLint 9 不再使用 .eslintignore 文件，而是在配置中设置：

// eslint.config.js
import lintSpecConfig from '@lint-spec/eslint-config';

export default [
  ...lintSpecConfig,
  {
    ignores: [
      'node_modules/**',
      'dist/**',
      'build/**',
    ],
  },
];

依赖

本包依赖以下包（会自动安装）：

• @eslint/js
• @stylistic/eslint-plugin
• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint-import-resolver-typescript
• eslint-plugin-import-x
• eslint-plugin-jsx-a11y
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-vue
• globals
• vue-eslint-parser