packages/eslint-config-proton/README.md

   1 # Proton ESLint config
   2
   3 Modern ESLint config for a more civilized age.
   4
   5 ## How to use
   6
   7 Add the following to the `package.json` dev dependencies.
   8
   9 ```json
  10 "@proton/eslint-config-proton": "workspace:^",
  11 ```
  12
  13 Then, use the following `.eslintrc` config.
  14
  15 ```js
  16 module.exports = {
  17     extends: ['@proton/eslint-config-proton'],
  18     parser: '@typescript-eslint/parser',
  19     parserOptions: {
  20         tsconfigRootDir: __dirname,
  21         project: './tsconfig.json',
  22     },
  23     ignorePatterns: ['.eslintrc.js'],
  24 };
  25 ```