README.md

eslint-config-iroot

Installation

Install eslint-config-iroot via yarn or npm.

$ yarn add eslint-config-iroot -D

<!-- universal dependency -->
$ yarn add eslint prettier -D

Vue project

$ yarn add eslint-plugin-vue -D

React project

$ yarn add eslint-plugin-react eslint-plugin-react-hooks -D

Typescript need additional installation

$ yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser -D

Rules

• @clings/eslint-plugin-node
• eslint-config-airbnb-base
• eslint-config-prettier
• eslint-plugin-import
• eslint-plugin-jsx-a11y
• eslint-plugin-prettier

Rules Details

🔗 base

🔗 typescript

🔗 vue

🔗 react

module.exports = {
  root: true,
  extends: ['iroot/base'],
  extends: ['iroot/typescript'],
  extends: ['iroot/vue'],
  extends: ['iroot/react']
  // choose one
  // typescript extends base
}

// typescript extends base  For example, the ts-react project 'extends': ['iroot/react'],
// when initializing, ts/js are set automatically so there is no need to inherit typescript