eslint-plugin-haraka

haraka-eslint

Install

In your Haraka plugin:

1. Add to NPM dependencies: npm install --save-dev eslint eslint-plugin-haraka

2. Install an eslint config file:

tee .eslintrc.yaml <<EOLINT
plugins: [ haraka ]
extends: [ eslint:recommended, plugin:haraka/recommended ]
EOLINT

1. Add within the "scripts" section of package.json:

"lint": "npx eslint *.js test"
"lintfix": "npx eslint --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 lintfix and the changes will be made to your files automatically.

If you disagree, you can add custom rules to your .eslintrc file.

Changelog

[1.0.16] - 2024-04-05

• chore: remove eslint deprecated formatting rules
  • see https://eslint.org/blog/2023/10/deprecating-formatting-rules/
• chore: remove .npmignore, populate [files] in package.json
• chore: add CodeQL workflow for GitHub code scanning (#27)
• ci: update to use shared workflows
• doc(README): fix badge URL, update usage