# eslint-config-cargurus-base

> cargurus's base JS ESLint config, following our styleguide

Latest version **11.2.1** (published 2017-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-cargurus-base
pnpm add eslint-config-cargurus-base
yarn add eslint-config-cargurus-base
bun add eslint-config-cargurus-base
```

## 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 | 11.2.1 |
| Published | 2017-07-07 |
| First published | 2017-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | dbmeads, jmong |
| Keywords | eslint, eslintconfig, config, cargurus, javascript, styleguide |

## Links

- npm: https://www.npmjs.com/package/eslint-config-cargurus-base
- Repository: https://github.com/cargurus/javascript
- Issues: https://github.com/cargurus/javascript/issues
- npm.io page: https://npm.io/package/eslint-config-cargurus-base

## Dependencies (1)

- [eslint-restricted-globals](https://npm.io/package/eslint-restricted-globals.md) ^0.1.1

## 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
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 11.2.1 (latest) — 2017-07-07
- 11.2.0 — 2017-07-06

## README

# eslint-config-cargurus-base

This package provides cargurus's base JS .eslintrc as an extensible shared config.

## Usage

We export two ESLint configurations for your usage.

### eslint-config-cargurus-base

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

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

  ```sh
  npm info "eslint-config-cargurus-base@latest" peerDependencies
  ```

  Linux/OSX users can simply run
  ```sh
  (
    export PKG=eslint-config-cargurus-base;
    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 eslint-config-cargurus-base 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 eslint-config-cargurus-base
  ```

  The cli will produce and run a command like:

  ```sh
  npm install --save-dev eslint-config-cargurus-base eslint@^#.#.# eslint-plugin-import@^#.#.#
  ```

2. Add `"extends": "cargurus-base"` to your .eslintrc

### eslint-config-cargurus-base/legacy

Lints ES5 and below. Requires `eslint` and `eslint-plugin-import`.

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

  ```sh
  npm info "eslint-config-cargurus-base@latest" peerDependencies
  ```

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

  Which produces and runs a command like:

  ```sh
  npm install --save-dev eslint-config-cargurus-base eslint@^3.0.1 eslint-plugin-import@^1.10.3
  ```

2. Add `"extends": "cargurus-base/legacy"` to your .eslintrc

See [Airbnb's overarching ESLint config](https://npmjs.com/eslint-config-cargurus), [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript), and the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information.

## Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with `npm test`.

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

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