README

Swimlane Eslint Rules

Rules for eslint used in Swimlane's Javascript (etc) development.

Javascript (es6)

Install:

npm install --save-dev eslint @swimlane/eslint-config eslint-plugin-security

Create an .eslintrc.yml file with the following:

env:
  browser: true
  commonjs: true
  es2021: true
extends:
  - '@swimlane'
parserOptions:
  ecmaVersion: 12

TypeScript

Install:

npm install --save-dev eslint @swimlane/eslint-config eslint-plugin-security
npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin

Create an .eslintrc.yml file with the following:

env:
  browser: true
  es2021: true
  node: true
extends:
  - '@swimlane/eslint-config/typescript'
parserOptions:
  ecmaVersion: 12
  sourceType: module

Prettier

If using prettier (for example @swimlane/prettier-config-swimlane) you should follow instructions in the eslint-config-prettier readme to install and setup eslint-config-prettier. For example for es6 config your .eslintrc.yml file will be:

env:
  browser: true
  commonjs: true
  es2021: true
extends:
  - '@swimlane'
  - 'prettier'
parserOptions:
  ecmaVersion: 12

Versioning Policy

Major (new linting errors)
- A new rule is added
- An existing rule is made more strict
- A new plugin is added to an existing config
- A existing plugin is updated to be more strict
Minor (same or fewer linting errors)
- A rule is removed
- An existing rules is made less strict
- Adding a new configuration
- A existing plugin is updated to be less strict
Patch (non-user-facing changes)
- Changes to documentation
- Fixes for build or publication
- Modifying tests

Credits

@swimlane/eslint-config is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build.

Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.

Usage no npm install needed!