ESLint Configurations

Usage

yarn add @img-arena/eslint-config

The based on the project environment include the appropriate configuration in the extends field in your .eslintrc.

For example, for a basic web based project:

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

For a React project using Typescript:

{
  "extends": [
    "@img-arena/eslint-config/react-rules",
    "@img-arena/eslint-config/ts-rules"
  ]
}

Available Configurations

• @img-arena/eslint-config - base default (browser) configuration
• @img-arena/eslint-config/react-rules - React rule definitions
• @img-arena/eslint-config/node-rules - Node environment rule definitions
• @img-arena/eslint-config/ts-rules - Typescript rule definitions

Publishing

The package is published automatically to the npm registry when PRs are merged to master, the version changes are based on commit message syntax; see below.

Commit Style

This repo follows the Conventional Commit format. This is so that we can automatically figure out what the SemVer release tag should be. Note that commits must be in this format, we use Husky to enforce this.

$ git commit -m "feat(frs-123): added new linting rule"

Commits and SemVer tags are directly linked, if you want a commit to not be evaluated in whether or not the semver version should change, add " [skip ci]" to the end of the commit message - https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/

Commitzen

This repo is Commitzen compatible, if you wish to use it instead of writing the commit via git commit -m ... try cz after git add.

https://github.com/commitizen/cz-cli#installing-the-command-line-tool