eslint-config-acast

eslint-config-acast

Shared ESLint config used at Acast. It combines recommended lint rules from a set of useful ESLint plugins, with modular configs that can be combined to suite the projects need.

Base:

• eslint-plugin-import
• eslint-plugin-prettier

React:

• eslint-plugin-react
• eslint-plugin-jsx-a11y
• eslint-plugin-import (react config)
• eslint-config-prettier (react config)

Typescript:

• typescript-eslint
• eslint-plugin-import (typescript config)
• eslint-config-prettier (typescript config)

Jest:

• eslint-plugin-jest

Setup

Installation

npm install -D eslint-config-acast eslint prettier

Extending

Extend acast and any extra config you need for your project in your eslintrc file.

Available configs:

• acast
• acast/react
• acast/typescript
• acast/jest

Example:

// eslintrc.js
{
  "extends": ["acast", "acast/react", "acast/typescript", "acast/jest"]
}

Usage

CLI

With everything setup, you can use the ESLint CLI to lint your code. You can run eslint --fix to fix linting errors and warnings (including Prettier formatting rules).

VSCode integration

ESLint

Integrate ESLint with your Visual Studio Code by installing the ESLint plugin. After installing the plugin and reloading your workspace, you will see warnings and errors right there in your editor.

Prettier

Integrate Prettier with your Visual Studio Code by install the Prettier plugin. After installing the plugin and reloading your workspace, you are ready to format your code right there in your editor.

For the plugin to locate the Prettier formatting rules, add the following to your user settings:

"prettier.eslintIntegration": true

Format using Command Palette:

1. CMD + Shift + P -> Format Document
OR
1. Select the text you want to Prettify
2. CMD + Shift + P -> Format Selection

Or, format on save by adding the following to your user settings:

"[javascript]": {
    "editor.formatOnSave": true
}

Development

Rule overrides should be kept to a minimum. New additions should be well motivated without personal bias.

Release flow

No action is required other than merging your changes into master.

When a pull request is merged into master CircleCI will run the publish job and the following things will happen.

• Analyse commit messages since the last release (Git Tag).
• For every fix, feat or BREAKING CHANGE, semantic-release will automatically:

• Decide the new version number based on the commit messages since the latest release tag.
• Update the package.json file with the new version number and create a change log.
• Create a tag named Git Tag and push it.