eslint-config-tinyuen

An Eslint Shareable Config for Javascript Standard Style. Help You Create a .eslintrc file Faster and Easily.

Base on Eslint Airbnb

😃 Support

• Javascript
• Typescript
• React
• Vue
• Typescript + React
• Typescript + Vue

⚙ Install

You need to install different packages for different Scenes. Refer to the command line below：

Javascript

npm install --save-dev eslint babel-eslint eslint-plugin-babel eslint-plugin-import eslint-config-tinyuen

Typescript

npm install --save-dev eslint typescript eslint-plugin-babel eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-tinyuen

React

npm install --save-dev eslint babel-eslint eslint-plugin-babel eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-config-tinyuen

Vue

npm install --save-dev eslint babel-eslint eslint-plugin-babel eslint-plugin-import eslint-plugin-vue vue-eslint-parser eslint-config-tinyuen

Typescript + React

npm install --save-dev eslint typescript eslint-plugin-babel eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-config-tinyuen

Typescript + Vue

npm install --save-dev eslint typescript eslint-plugin-babel eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-vue vue-eslint-parser eslint-config-tinyuen

🚀 Usage

Create your own .eslintrc file and use extends option. you can also overwrite some rules by rules option.

Like this => extends: ["eslint-config-tinyuen"], and the prefix eslint-config- can be omitted.

// Javascript Example 
{
  "extends": ["tinyuen"],
  "rules": {}
}

// React Example 
{
  "extends": ["tinyuen/react"],
  "rules": {}
}

// Vue Example 
{
  "extends": ["tinyuen/vue"],
  "rules": {}
}

// Typescript Example 
{
  "extends": ["tinyuen/typescript"],
  "rules": {}
}

// Typescript + React Example 
{
  "extends": ["tinyuen/typescript-react"],
  "rules": {}
}

// Typescript + Vue Example 
{
  "extends": ["tinyuen/typescript-vue"],
  "rules": {}
}

🔍 Reference

• Document Of Eslint Rules
• Eslint Airbnb