Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/famarks/eslint-config-grafarg
https://github.com/famarks/eslint-config-grafarg
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/famarks/eslint-config-grafarg
- Owner: famarks
- Created: 2024-01-24T06:28:41.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-24T13:24:59.000Z (12 months ago)
- Last Synced: 2024-04-25T19:00:39.175Z (9 months ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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.