eslint-config-reperio

eslint-config-reperio

This is a sharable ESLint configuration for Reperio. It is based on the following packages:

• eslint-config-universe from Expo for cross-platform support
• eslint-plugin-perfectionist for sorting

Getting started

1. Install the package and peer dependencies:

npm install --save-dev eslint-config-reperio eslint@8 prettier

1. Add the following to your .eslintrc.json file:

{
  "extends": "reperio"
}

1. Add npm run lint and npm run format scripts to package.json since most of the rules are automatically fixable.

{
  "scripts": {
    "lint": "eslint . --ignore-path .gitignore",
    "format": "eslint . --fix --ignore-path .gitignore"
  }
}

Editor integration

It's recommended to install the ESLint and Prettier extensions for your editor. For VS Code, you can install the ESLint extension and Prettier extension.

It is also recommended to enable "Format On Save". Here is an example configuration for VS Code's settings.json:

{
  "[javascript]": {
    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
    "editor.formatOnSave": false
  },
  "[javascriptreact]": {
    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
    "editor.formatOnSave": false
  },
  "[typescript]": {
    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
    "editor.formatOnSave": false
  },
  "[typescriptreact]": {
    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
    "editor.formatOnSave": false
  },
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  },
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnPaste": true,
  "editor.formatOnSave": true,
  "eslint.codeActionsOnSave.rules": null,
  "eslint.format.enable": true
}

Disabling rules

The perfectionist rules are faily opinionated for sorting, so you can disable them as needed, e.g.:

// eslint-disable-next-line perfectionist/sort-objects
const helloWorld = { b: 2, a: 1 }