@ticketmaster/eslint-config-allure

@ticketmaster/eslint-config-allure

Opinionated ESLint configuration that follow Allure design system recommendations

Usage

This configuration already includes the following packages.

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint-config-prettier
• eslint-plugin-react
• eslint-plugin-react-hooks

However, it still requires those packages.

• eslint >= 7.0.0
• typescript >= 3.7.0
• react ^16.11.0

Install dependencies

If they are not already present, add the required dependencies and devDependencies

yarn add react
yarn add eslint typescript -D

Install the configuration

Add @ticketmaster/eslint-config-allure to your devDependencies

yarn add @ticketmaster/eslint-config-allure -D

Update your ESLint configuration file

Add "@ticketmaster/eslint-config-allure" into the extends property of your .eslintrc.json file.

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

Since @ticketmaster/eslint-config-allure is opinionated, your TSLint configuration file should not have any override rules and should look very similar to the one above.

You can now use ESlint with the Allure configuration in your project

It is recommended to add the two following scripts into you packages.json to facilitate your usage of ESlint.

"scripts": {
  "lint": "eslint '*/**/*.{js,jsx,ts,tsx}'",
  "lint:fix": "yarn lint --fix"
}