@pinnacle0/eslint-plugin

@pinnacle0/eslint-plugin

This package provides customized eslint rules for Pinnacle and a baseline config for react/typescript projects.

Usage

This package includes a config which wraps multiple other eslint plugins and presets.

For our config to work properly, @pinnacle0/eslint-plugin has to be installed along with all these plugins and presets ("peer dependencies").

• Install @pinnacle0/eslint-plugin and the required peer dependencies:

  $ yarn add --dev --exact \
    @pinnacle/eslint-plugin \
    eslint \
    @typescript-eslint/parser \
    @typescript-eslint/eslint-plugin \
    eslint-config-prettier \
    eslint-plugin-react \
    eslint-plugin-react-hooks \
    eslint-plugin-import \
    eslint-plugin-eslint-comments
  
  

• Create .eslintrc.js at the project root directory:

  module.exports = {
      extends: ["plugin:@pinnacle0/baseline"],
  };
  

• Add lint script to package.json:

  {
      // ...
      "scripts": {
          // ...
          "lint": "eslint --ext .js,.jsx,.ts,.tsx ."
      }
  }
  

• Run linter:

  $ yarn lint
  

Upgrading

It is recommended to use the latest version of all packages.

• To upgrade, run (use arrow keys and space to select packages):

  $ yarn upgrade-interactive --latest
  

• Commit your changes:

  $ git commit -am "Upgraded dependencies"
  

• To make sure transitive dependencies locked by yarn.lock can also be upgraded, run:

  $ npx yarn-deduplicate
  

• Review the changes of yarn.lock if they make sense, then commit your changes:

  $ git commit -a --amend --no-edit