Via Profit Eslint configuration

ESlint configuration for a via-profit-services packages

Peer Dependencies

• eslint
• eslint-config-prettier
• eslint-import-resolver-webpack
• eslint-import-resolver-node
• eslint-plugin-import
• eslint-plugin-node
• eslint-plugin-prettier
• eslint-plugin-promise
• prettier
• @typescript-eslint/parser
• @typescript-eslint/eslint-plugin

Installation

1. Install peer dependencies:

$ yarn add --dev \
@typescript-eslint/eslint-plugin \
@typescript-eslint/parser \
eslint \
eslint-config-prettier \
eslint-import-resolver-webpack \
eslint-import-resolver-node \
eslint-plugin-import \
eslint-plugin-node \
eslint-plugin-prettier \
eslint-plugin-promise \
prettier

2. Install the common package:

$ yarn add --dev @via-profit-services/eslint-config

3. Make the eslint config file .eslintrc in project root with following contents:

{
  "extends": ["@via-profit-services/eslint-config"]
}

4. Make the pretier config file .prettierrc in project root with following contents:

{
  "trailingComma": "all",
  "tabWidth": 2,
  "semi": true,
  "singleQuote": true,
  "bracketSpacing": true,
  "arrowParens": "avoid",
  "printWidth": 100
}

For React environment

Install packages:

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

{
  "extends": ["@via-profit-services/eslint-config/react"]
}

5. Make the .eslintignore file in project root with following contents:

/scripts/**
/src/@types/**
/dist/**
/build/**
.eslintrc

6. Do not forgot restart your IDE