# @justeat/eslint-config-fozzie

> Just Eat's JS ESLint config, which follows our styleguide

Latest version **5.5.0** (published 2023-09-04) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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 | 5.5.0 |
| Published | 2023-09-04 |
| First published | 2017-04-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 2 |
| Unpacked size | 3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | raouf.sawehli, mmakwe-onyeka, gregory.palaci, arielfdr, dawidchar, roberto.santana, lizzie.turney, davidpn.11, dandel10n, faye.carter, mwh1989, kevinrodrigues, fozzie-bot, ashleynolan, simonsje, xander-marjoram, sergii.semenkiv, thomaswilliammcclean, benrwhite, robertellison, zlatin.ivanov, joshuang2332, oliversweb, andymayje, jamieomaguire, adammorr, lsphillips |
| Keywords | config, eslint, eslintconfig, fozzie, javascript, justeat, styleguide |

## Links

- npm: https://www.npmjs.com/package/@justeat/eslint-config-fozzie
- Repository: https://github.com/justeat/eslint-config-fozzie
- Issues: https://github.com/justeat/eslint-config-fozzie/issues
- npm.io page: https://npm.io/package/@justeat/eslint-config-fozzie

## Dependencies (2)

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

## Recent versions

- 5.5.0 (latest) — 2023-09-04
- 5.4.0 — 2022-11-15
- 5.1.0 — 2022-01-31
- 5.0.0 — 2022-01-31
- 4.3.0 — 2021-12-15
- 4.0.0 — 2020-11-27
- 3.4.1 — 2020-04-07
- 3.4.0 — 2020-01-07
- 3.3.1 — 2019-11-07
- 3.3.0 — 2019-11-07
- 3.2.0 — 2019-11-07
- 3.1.1 — 2019-06-17
- 3.0.0 — 2019-04-05
- 2.3.0 — 2018-11-08
- 2.2.0 — 2018-08-30
- … 11 more at https://npm.io/package/@justeat/eslint-config-fozzie/versions

## README

# eslint-config-fozzie
[![npm version](https://badge.fury.io/js/%40justeat%2Feslint-config-fozzie.svg)](https://badge.fury.io/js/%40justeat%2Feslint-config-fozzie)

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

It 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.

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

### eslint-config-fozzie

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 "@justeat/eslint-config-fozzie@latest" peerDependencies
  ```

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

  The cli will produce and run a command like:

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

2. Add `"extends": "@justeat/eslint-config-fozzie"` to your `.eslintrc` file, which should look like this:
```
// Use this file as a starting point for your project's .eslintrc.js
// Copy this file, and add rule overrides as needed.
module.exports = {
    extends: '@justeat/eslint-config-fozzie'
}
```


## 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/@justeat/eslint-config-fozzie · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
