Package Exports

@cuiko/eslint-config

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@cuiko/eslint-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-config

Based on eslint-config-for.

Eslint
TypeScript
React
Vue
Prettier
Jest

Install

# npm
npm i @cuiko/eslint-config -D
# yarn
yarn add @cuiko/eslint-config -D

Dependencies

1. Eslint Support

# npm
npm i eslint -D
# yarn
yarn add eslint -D

If you're using babel, you also need to install babel-eslint.

# npm
npm i babel-eslint -D
# yarn
yarn add babel-eslint -D

2. TypeScript Support

# npm
npm i @typescript-eslint/eslint-plugin @typescript-eslint/parser -D
# yarn
yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser -D

3. React Support

# npm
npm i eslint-plugin-react -D
# yarn
yarn add eslint-plugin-react -D

4. Vue Support

# npm
npm i eslint-plugin-vue vue-eslint-parser -D
# yarn
yarn add eslint-plugin-vue vue-eslint-parser -D

5. Prettier Support

If your IDE have been supported, you don't have to execute the following command.

# npm
npm i prettier -D
# yarn
yarn add prettier -D

Exec Eslint with Prettier

# npm
npm i prettier eslint-plugin-prettier -D
# yarn
yarn add prettier eslint-plugin-prettier -D

Prettier Extend

# npm
npm i prettier eslint-config-prettier -D
# yarn
yarn add prettier eslint-config-prettier -D

Usage

1. Use Prettier Config

// .prettierrc.js
module.exports = {
  ...require('@cuiko/eslint-config/prettier-config')
}

Use Prettier Plugin

Exec Eslint with Prettier

// .eslintrc.js
module.exports = {
  extends: ['@cuiko/eslint-config/prettier-plugin'],
}

Use Prettier Extend

Prettier Extend

// .eslintrc.js
module.exports = {
  extends: ['@cuiko/eslint-config/prettier-extend'],
}

2. Use React Config

// .eslintrc.js
module.exports = {
  extends: ['@cuiko/eslint-config', '@cuiko/eslint-config/react'],
}

3. Use Vue Config

// .eslintrc.js
module.exports = {
  extends: ['@cuiko/eslint-config', '@cuiko/eslint-config/vue'],
}

4. Use TypeScript Config

// .eslintrc.js
// 当与 react/vue 组合使用时, typescript 的配置引用要在前两者后面
module.exports = {
  extends: ['@cuiko/eslint-config', '@cuiko/eslint-config/typescript'],
}