Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/famarks/eslint-config-grafarg


https://github.com/famarks/eslint-config-grafarg

Last synced: 12 days ago
JSON representation

Awesome Lists containing this project

README

        

# grafarg-eslint-config

> Grafarg's [ESLint](https://eslint.org) config.

## Installation

```shell
yarn add @grafarg/eslint-config --dev
```

or:

```shell
npm install @grafarg/eslint-config --save-dev
```

Don't forget to install peerDependencies.

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

```sh
npm info "@grafarg/eslint-config@latest" peerDependencies
```

If using **npm 5+**, use this shortcut

```sh
npx install-peerdeps --dev @grafarg/eslint-config
```

If using **yarn**, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly.
Otherwise, run `npm info "@grafarg/eslint-config@latest" peerDependencies` to list the peer dependencies and versions, then run `yarn add --dev @` for each listed peer dependency.

## Usage

```json
{
"extends": ["@grafarg/eslint-config"]
}
```

It will automatically handle `*.(js|ts|tsx)` files.

## Publishing

```shell
npm publish
```

Also be sure to update any official packages that depend on this with fixes and version increases.

## Versioning

It's probable that _any_ change will be a breaking one, so it's best to stick to major version releases.