https://github.com/alaskaairlines/eslint-config

Auro's eslint config repo
https://github.com/alaskaairlines/eslint-config

auro config design-system eslint

Last synced: about 1 month ago
JSON representation

Auro's eslint config repo

• Host: GitHub
• URL: https://github.com/alaskaairlines/eslint-config
• Owner: AlaskaAirlines
• License: apache-2.0
• Created: 2021-04-17T01:29:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-05T02:31:09.000Z (about 2 months ago)
• Last Synced: 2024-11-05T02:37:29.651Z (about 2 months ago)
• Topics: auro, config, design-system, eslint
• Language: JavaScript
• Homepage: https://auro.alaskaair.com/getting-started/developers/generator/install
• Size: 342 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Auro Eslint Setup

`auro-eslint-config` is a [pre-configured set of code style rules](https://eslint.org/) for the purpose of maintaining code quality and consistency between projects.

## Install

[![Build Status](https://img.shields.io/github/workflow/status/AlaskaAirlines/auro-eslint-config/Test%20and%20publish?branch=master&style=for-the-badge)](https://github.com/AlaskaAirlines/auro-eslint-config/actions?query=workflow%3A%22test+and+publish%22)

[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/eslint-config?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/eslint-config)

[![License](https://img.shields.io/npm/l/@aurodesignsystem/eslint-config?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)

```shell

$ 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](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.

### Add .eslintrc file

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

```js

{

  "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](https://auro.alaskaair.com/getting-started/developers/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.