Auro Eslint Setup

auro-eslint-config is a pre-configured set of code style rules for the purpose of maintaining code quality and consistency between projects.

Install

$ npm i @aurodesignsystem/eslint-config

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this stack overflow answer.

Add .eslintrc file

At the root of your project, create a .eslintrc file with the following code:

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

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.