@shferreira/eslint-config-mailbutler

eslint-config-mailbutler

These are our ESLint rules for internal projects.

Installation

Install this once per project.

1. If you don't already have a package.json file, create one with npm init.

2. Install the required ESLint packages:

npx install-peerdeps --dev eslint-config-mailbutler

The required dependencies will be now visible in your package.json.

1. Create a .eslintrc or .eslintrc.js file in the root of your project's directory (it should live where package.json does).

If you're using a .eslintrc, it should look like this:

{
  "extends": [
    "mailbutler"
  ]
}

If you're using a .eslintrc.js, that's how it should be:

module.exports = {
  "extends": [
    "mailbutler"
  ]
};

Tip: You can also put the JSON object in your package.json under the key "eslintConfig":. That will allow you to have one less file.

1. Add those two scripts to your package.json for convenience:

"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
},

Or if you prefer doing it in the command line:

npx npm-add-script -k "lint" -v "eslint ."
npx npm-add-script -k "lint:fix" -v "eslint . --fix"

1. Run ESLint by calling npm run lint. Fix issues with npm run lint:fix.