Siren ESLint Configuration and Rules

This repo consists of a standard rule configuration that can be extended, as well as custom rules created in-house.

Config

To use the config:

1. Install the repo:

   npm install --save-dev eslint-plugin-siren@sirensolutions/eslint-plugin#<tag>

   Where <tag> is the latest tag available.

2. Add the peerDependencies of this plugin to the devDependencies of the project where you are using the plugin.

3. Update your .eslintrc.yml (or whatever you've called it) to extend from plugin:siren/recommended

   extends: ['plugin:siren/recommended']

4. Ensure that your NPM script or Gulp task includes your package.json file so the same-core-dependency-version rule can check it. We recommend the following entry in your package.json:

   "lint": "eslint '**/*.{js,ts,jsx,tsx}' package.json",

Rules

Check the rules directory to see documentation about each rule.

Contributing

• All the new PRs merge into master and should increment the version.
• Once merged, tag the new commit in master and update all Siren repos that use it with the latest tag.
• If changed/added rules cause lint failures, they can be manually disabled with a ticket created on the appropriate team to update their code.