/haraka-eslint

eslint rules for Haraka projects

Primary LanguageJavaScriptMIT LicenseMIT

haraka-eslint

Build Status Code Climate

NPM

Install

In your Haraka module:

  1. Add to NPM dependencies:

npm install --save-dev @haraka/eslint-config

  1. Configure eslint:
cat  <<EOLINT > .eslintrc.yaml
env:
  node: true
  es6: true
  es2022: true
extends: "@haraka"
EOLINT
  1. Add to the "scripts" section of package.json:
"lint": "npx eslint@8 *.js test"
"lint:fix": "npx eslint@8 --fix *.js test"
  1. Within your CI workflow:

npm run lint

Usage

To check your project against lint rules:

npm run lint

Step #4 above does this automatically when CI tests are set up.

If you agree with the lint suggestions, you can run npm run lint:fix and the changes will be made to your files automatically.

Custom rules can be added to the .eslintrc file.