@raposify/eslint-config

ESLint Configuration

Shared JS configuration for Raposify apps

This is an NPM package to be used across all Javascript projects in Raposify. It is based on the official recommended configurations for the following ESLint plugins:

• ESLint
• React (configured for Preact)
• Jest
• Prettier

How to use

1. In your project, install this package as a dev dependency:

   > npm i eslint @raposify/eslint-config -D
   

2. Add the following to your package.json file

   "eslintConfig": {
     "extends": "@raposify"
   }
   

How to update

To update this package

1. Clone the repo

   > git clone https://gitlab.com/raposify/eslint-config.git
   

2. Install dependencies

   > npm i
   

3. Modify rules in index.js
4. Test the package by creating a new project, then installing this package with

   > npm i path/to/this/repo -D
   

   Follow the "How to use" instructions (above).
5. Commit changes to this repo
6. Increment the version in package.json

   > npm version <patch|minor|major>
   

7. Commit version upgrade to this repo
8. Go back to the package directory and publish it

   > npm publish --access public