README.md

eslint-config-collaborne

ES lint configuration for Collaborne projects

Usage

1. Install dependencies

   npm install --save-dev \
       eslint-config-collaborne \
       eslint@7 \
       eslint-plugin-disable@2 \
       eslint-plugin-import@2 \
       eslint-plugin-node@11 \
       eslint-plugin-prettier@3 \
       eslint-plugin-promise@4 \
       prettier@2

2. Add .prettierrc (configuration for prettier)

   {
     "singleQuote": true,
     "jsxSingleQuote": false,
     "semi": true,
     "tabWidth": 2,
     "useTabs": true,
     "bracketSpacing": true,
     "jsxBracketSameLine": false,
     "arrowParens": "avoid",
     "trailingComma": "all"
   }

3. Add .eslintignore

   node_modules
   

4. Add .eslintrc.json

   {
     "extends": "collaborne"
   }

5. Add linting scripts in package.json

   {
     // ...
     "scripts": {
       // ...
       "lint": "npm run lint:ts",
       "lint:ts": "eslint --report-unused-disable-directives $(node -p 'require("./tsconfig.json").include.map(include => `'\${include}.\{js,ts,tsx\}'`).join(" ")')"
       // ...
     }
     // ...
   }

   Note: This requires that tsconfig.json contains a include property, which should only directories, and in the format dir/**/*.

Additional configuration

• Always use overrides to configure additional rules
• Try to document the reason for a override configuration in the commit message for traceability, and consider reporting the rule here as a future addition with the rationale