# @leemillward/eslint-config

> Base JS ESLint config

Latest version **2.2.0** (published 2024-04-09) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2024-04-09 |
| First published | 2020-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 4 |
| Unpacked size | 39.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lee Millward |
| Maintainers | leemillward |

## Links

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

## Dependencies (4)

- [eslint-plugin-vue](https://npm.io/package/eslint-plugin-vue.md) ^9.0.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.25.4
- [confusing-browser-globals](https://npm.io/package/confusing-browser-globals.md) ^1.0.11
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^15.0.0

## Recent versions

- 2.2.0 (latest) — 2024-04-09
- 2.1.0 — 2022-07-06
- 2.0.3 — 2022-03-07
- 2.0.2 — 2021-09-06
- 2.0.1 — 2021-09-06
- 2.0.0 — 2021-09-06
- 1.0.4 — 2020-03-06
- 1.0.3 — 2020-03-05
- 1.0.2 — 2020-02-13
- 1.0.0 — 2020-02-12

## README

# @leemillward/eslint-config

[![npm version](https://badge.fury.io/js/%40leemillward%2Feslint-config.svg)](https://badge.fury.io/js/%40leemillward%2Feslint-config)
![Build Status](https://github.com/leemillward/eslint-config/actions/workflows/test.yml/badge.svg?branch=master)

This package extends the [eslint-config-airbnb-base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) ruleset with our own set of JS linting rules. The structure is based on that package and also [@justeat/eslint-config/fozzie-config-fozzle](https://github.com/justeat/eslint-config-fozzie).

Many thanks to the work that the Airbnb team have put in on creating their template for extension rules – we have liberally borrowed from their structure and documentation in creating this ruleset.

## Usage

### @leemillward/eslint-config

Our default export contains all of our base ESLint rules, including ECMAScript 6+. It requires `eslint`, `eslint-plugin-import` and `eslint-plugin-vue`.

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

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

Linux/OSX users can simply run

```sh
(
  export PKG=@leemillward/eslint-config;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
```

Which produces and runs a command like:

```sh
  npm install --save-dev @leemillward/eslint-config eslint@^#.#.# eslint-plugin-import@^#.#.#
```

Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.

```sh
npm install -g install-peerdeps
install-peerdeps --dev @leemillward/eslint-config
```

The cli will produce and run a command like:

```sh
npm install --save-dev @leemillward/eslint-config eslint@^#.#.# eslint-plugin-import@^#.#.#
```

2. Add `"extends": "@leemillward/eslint-config"` to your .eslintrc

## Testing

You can run tests on this ruleset with `npm test`.

You can make sure this module lints with itself using `npm run lint`.

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