eslint-config-quintoandar-pwa

eslint-config-quintoandar-pwa

Table of Contents

• Getting start
  • Install
    • Install peer dependencies
  • Usage
  • Running local lint
  • Running local test
• What configs and rules ?
• Versioning
• Contributing
• Roadmap
• Badges

This package provides QuintoAndar's .eslintrc for PWA as an extensible shared config.

Getting start

Install

npm install --save-dev eslint-config-quintoandar-pwa

Install peer dependencies

Install the correct versions of each package required, which are listed by the command:

npm info "eslint-config-quintoandar-pwa@latest" peerDependencies

You can use this shortcut in NPM+5 to install all peer deps:

npx install-peerdeps --dev eslint-config-quintoandar-pwa

Usage

In your project, create a file .eslintrc.json and extends this project:

{
  "extends": "eslint-config-quintoandar-pwa"
}

Running local lint

Just run:

npm run lint

Running local test

Just run:

npm run test

What configs and rules ?

We extends Airbnb's configs and add new rules specific to QuintoAndar's PWA projects.

Versioning

We use SemVer for versioning. For the versions available, see the CHANGELOG.md

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Roadmap

You can take a look in our roadmap here.

Badges

Add the following line in your markdown readme:

![eslint-config-quintoandar-pwa-badge](https://img.shields.io/badge/code%20style-eslint--config--quintoandar--pwa-5063f0.svg)