# eslint-config-olympic

> Shared ESLint config based on AirBnB JavaScript style guide.

Latest version **1.3.3** (published 2017-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-olympic
pnpm add eslint-config-olympic
yarn add eslint-config-olympic
bun add eslint-config-olympic
```

## 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.3.3 |
| Published | 2017-01-25 |
| First published | 2016-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Olympic Software |
| Maintainers | olympic |
| Keywords | eslint, eslintconfig, olympic, javascript, styleguide |

## Links

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

## 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.3.3 (latest) — 2017-01-25
- 1.3.2 — 2016-10-07
- 1.3.1 — 2016-07-28
- 1.3.0 — 2016-07-25
- 1.2.0 — 2016-06-09
- 1.1.0 — 2016-06-09
- 1.0.1 — 2016-06-02

## README

# Olympic ESLint Config

This config is the AirBnB base config with some exceptions. Supports both ES5 and ES6.

## Usage

Install using npm:
```
npm install --save-dev eslint eslint-config-olympic eslint-config-airbnb-base eslint-plugin-import
```

Extend this config in your `.eslintrc`:
```
{
    "extends": "olympic",
}
```

For linting legacy code (ES5) use the following in your .eslintrc:
```
{
    "extends": "olympic/legacy",
}
```

## Deviations from AirBnB Style Guide

| Rule              | AirBnB Value                                   | Olympic Value                                  |
|-------------------|------------------------------------------------|------------------------------------------------|
| [no-param-reassign](http://eslint.org/docs/rules/no-param-reassign) | 2, { props: true }                             | 0                                              |
| [indent](http://eslint.org/docs/rules/indent) | 2, 2, { SwitchCase: 1, VariableDeclarator: 1 } | 2, 4, { SwitchCase: 1, VariableDeclarator: 1 } |
| [func-names](http://eslint.org/docs/rules/func-names) | 1                                              | 0                                              |
| [no-nested-ternary](http://eslint.org/docs/rules/no-nested-ternary) | 2                                              | 0                                              |
| [one-var](http://eslint.org/docs/rules/one-var) | 2, 'never' | 0
| [one-var-declaration-per-line](http://eslint.org/docs/rules/one-var-declaration-per-line) | 2, 'always' | 0
| [linebreak-style](http://eslint.org/docs/rules/linebreak-style) | 2, 'unix' | 0

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