README.md

Equisoft's ESLint configuration

This project hosts Equisoft's ESLint configuration. It is versatile enough to be used with NodeJS or Web projects.

The rules of this ESLint configuration uses AirBnB's packages, with some small overrides to make up Equisoft's flavor.

For react, you should instead look at @equisoft/eslint-config-react which comes with additional validations.

Versioning

The versioning of this project respects semver. That means your project's package.json can caret (^) import it.

Prerequisites

yarn add --dev eslint @microsoft/eslint-formatter-sarif eslint-import-resolver-node eslint-plugin-import yargs

Installation

Install the libraries in your project:

yarn add --dev @equisoft/eslint-config

Then create a .eslintrc.json file that uses Equisoft's configuration:

{
  "extends": ["@equisoft/eslint-config"]
}

Finally, create a script in your package.json to easily run ESLint:

{
  "scripts": {
    "eslint": "eslint src",
    "eslint:ci": "yarn eslint"
  }
}

Now you can use yarn eslint to validate the code style of your Javascript files!

Continuous Integration

We strongly suggest that you enforce code style checks on your CI. For example, on Github Actions you can add a configuration similar to this one to your workflow:

eslint:
  name: ESLint
  steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup asdf-vm
        uses: equisoft-actions/with-asdf-vm@v1

      - name: Install NPM dependencies
        uses: equisoft-actions/yarn-install@v1

      - name: Run ESLint
        uses: equisoft-actions/yarn-eslint@v2

Migrating an existing codebase

ESLint supports exclusion of globs in .eslintignore. One way to gradually migrate a legacy code base to this configuration is to exclude all source files and add conforming files one at a time. To achieve this, add this to your .eslintignore:

src/**/*.js
!src/contacts/**/*.js

Note how an entry prefixed by ! is added to re-include some source files.

For more information on this technique, you can read the ESLint documentation.