@wttsolutions/eslint-config v0.1.24

n# Centralized eslint (+react), prettier, typescript configs

Setup

yarn add --dev @wttsolutions/eslint-config@^0.1

// reivew & install project peer dependencies (eslint, react, prettier, typescript...)
npx check-peer-dependencies --findSolutions

Create .eslintrc.js:

module.exports = {
  "extends": [
    "@wttsolutions/eslint-config",
    //optional "@wttsolutions/eslint-config/.eslintrc-react.js",
    //optional "@wttsolutions/eslint-config/.eslintrc-ts.js"
  ],
  rules: {
    // "no-var": "off"
  }
}

(Optional) Create prettier.config.js:

module.exports = {
  ...require('@wttsolutions/eslint-config/prettier.config.js'),

  // custom rules
  // singleQuote: false,
}

(Optional) Create tsconfig.json with custom options:

{
  "extends": "./node_modules/@wttsolutions/eslint-config/tsconfig.json",

  "compilerOptions": {
    "removeComments": false
  }
}

Note: extends works via local path only because of bug in ts

Modify the package.json according project requirements:

...
"scripts": {
  ...
  "prettify": "prettier --check src/**/*.{js,jsx,ts,tsx}",
  "prettify:fix": "prettier --write src/**/*.{js,jsx,ts,tsx}",
  "lint": "eslint src",
  "lint:fix": "eslint --fix src"
}
...

Configure your code editor to make him automatically prettify and lint code by the .eslintrc.js and prettier.config.js configs. Assummed that you shouldn't run linting scripts manually in most cases.

UPDATING THIS PACKAGE (internal)

1. Login to npm

Make sure you have wright permissions to the https://github.com/wttsolutions/eslint-config repository and your npmjs.com acccount included into the npmjs.com -> wttsolutions -> develpers team members.

yarn login

2. Update package & version

yarn version:patch
git commit ....
git push
yarn publ

Note: when running yarn publ DON'T modify the version (it's already updated by yarn version:patch

How it works

1. prettier formats code
2. eslint applies linting rules to code
3. developer see the remained eslint errors in the code editor and fix them manually

TODO

• add stylelint
• update to eslint v9 after dependept packages support it. In particular:
  • babel/eslint/babel-eslint-parser/package.json at main · babel/babel https://github.com/babel/babel/blob/main/eslint/babel-eslint-parser/package.json
  • https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb/package.json and probably others (try yarn add eslint@^9.0.0 and see all warnings) (see also config-base-9.js)

Note

using eslint & typescript as OWN dependencies (not peer) to make this package works more independently from project where it would be used & keep all plugins compatible