eslint-config-greenpie

Pretty tough ESLint config

This package provides GreenPie's .eslintrc as an extensible shared config.

Usage

Install configurations

• npm install eslint-config-greenpie --save-dev

And then extend your local eslint config by this one

{
  "extends": ["eslint-config-greenpie"]
}

Rulesets

Currently, here are four rulesets to extend

Extension	Description
eslint-config-greenpie	Includes base, formatting and typescript rules
eslint-config-greenpie/base	Common ESLint rules
eslint-config-greenpie/stylistic/js	Stylistic JS rules
eslint-config-greenpie/stylistic/ts	Stylistic TS rules
eslint-config-greenpie/stylistic/plus	Stylistic Plus rules
eslint-config-greenpie/typescript	TypeScript-related rules
eslint-config-greenpie/vue	Rules for Vue projects
eslint-config-greenpie/jest	Rules for test files using Jest

Base rules

For using base rules, it requires eslint plugin installed

• npm install eslint --save-dev

Formatting rules (JavaScript)

For using formatting rules for JS, it requires @stylistic/eslint-plugin-js plugin installed

• npm install @stylistic/eslint-plugin-js --save-dev

TypeScript

For TypeScript related rules, it requires a plugin and parser installed

• npm install @typescript-eslint/eslint-plugin --save-dev
• npm install @typescript-eslint/parser --save-dev

Formatting rules (TypeScript)

For using formatting rules for TS, it requires @stylistic/eslint-plugin-ts plugin installed

• npm install @stylistic/eslint-plugin-ts --save-dev

Vue

For Vue-related rules, it requires a plugin installed

• npm install eslint-plugin-vue --save-dev

Also, if you're planning to use TypeScript alongside Vue, you will probably need to configure another parser for the <script> tag.

Jest (or a similar tool like Vitest)

Additional configuration for Jest requires eslint-plugin-jest plugin

• npm install eslint-plugin-jest --save-dev

Links

• Registry
• Basic ESLint rules
• TypeScript rules
• Vue rules
• Jest rules