# @on-running/eslint-config

> on-running eslint config

Latest version **1.1.0** (published 2023-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @on-running/eslint-config
pnpm add @on-running/eslint-config
yarn add @on-running/eslint-config
bun add @on-running/eslint-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-03-16 |
| First published | 2023-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ekpang Michael |
| Maintainers | on-running |
| Keywords | eslint, eslint-config |

## Links

- npm: https://www.npmjs.com/package/@on-running/eslint-config
- Repository: https://github.com/onrunning/eslint-config
- Homepage: https://github.com/onrunning/eslint-config#readme
- Issues: https://github.com/onrunning/eslint-config/issues
- npm.io page: https://npm.io/package/@on-running/eslint-config

## Dependencies (5)

- [eslint](https://npm.io/package/eslint.md) ^8.7.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^4.0.0
- [@rushstack/eslint-patch](https://npm.io/package/@rushstack/eslint-patch.md) ^1.1.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.10.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.10.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-03-16
- 1.0.0 — 2023-03-11
- 0.0.4 — 2023-03-11
- 0.0.3 — 2023-03-11
- 0.0.2 — 2023-03-11
- 0.0.1 — 2023-03-11

## README

# ESLint Config
On running Eslint config for Javascript and Typescript applications

## How to use


### For JavaScript

Install the package as a dev dependency:

```sh
yarn add --dev @on-running/eslint-config
```

Create an ESLint config `.eslintrc.yml` file in the root of your project with the content below:

```sh
extends: "@on-running/eslint-config" 
```

> Ensure the package's required peer dependencies - `eslint >= 8.0.0`  are installed.

### For TypeScript

Install the package as a dev dependency:

```sh
yarn add --dev @on-running/eslint-config
```

Create an ESLint config `.eslintrc.yml` file in the root of your project with the content below:

```sh
extends: "@on-running/eslint-config/typescript"
```

Create a `tsconfig.eslint.json` file if you don't alreay have one with the following content:

```json
{
  "extends": "./tsconfig.json",
  "include": ["./*.ts", "src", "test", "tests"],
  "exclude": [""]
}
```

> Ensure the package's required peer dependencies - `eslint >= 8.0.0`, `typescript >= 4.0.0` are installed.

## Publish new release
To publish a new release of the package start your commit message with any of the following: 
 ```sh
 release('minor'): for minor release
 release('patch'): for patch release
 release('major'): for a major release
 
 ```

---
_Source: https://npm.io/package/@on-running/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._