# tslint-config-airbnb

> A TSLint config for Airbnb JavaScript Style

Latest version **5.11.2** (published 2019-09-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install tslint-config-airbnb
pnpm add tslint-config-airbnb
yarn add tslint-config-airbnb
bun add tslint-config-airbnb
```

## 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.11.2 |
| Published | 2019-09-19 |
| First published | 2017-03-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 460 |
| Author | progre |
| Maintainers | progre |
| Keywords | airbnb, tslint, typescript |

## Links

- npm: https://www.npmjs.com/package/tslint-config-airbnb
- Repository: https://github.com/progre/tslint-config-airbnb
- Homepage: https://github.com/progre/tslint-config-airbnb/#readme
- Issues: https://github.com/progre/tslint-config-airbnb/issues
- npm.io page: https://npm.io/package/tslint-config-airbnb

## Dependencies (3)

- [tslint-eslint-rules](https://npm.io/package/tslint-eslint-rules.md) ^5.4.0
- [tslint-microsoft-contrib](https://npm.io/package/tslint-microsoft-contrib.md) ~5.2.1
- [tslint-consistent-codestyle](https://npm.io/package/tslint-consistent-codestyle.md) ^1.14.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

- 5.11.2 (latest) — 2019-09-19
- 5.11.1 — 2018-11-15
- 5.11.0 — 2018-09-01
- 5.10.0 — 2018-08-18
- 5.9.2 — 2018-05-19
- 5.8.0 — 2018-03-19
- 5.7.0 — 2018-02-21
- 5.6.0 — 2018-02-07
- 5.5.0 — 2018-01-24
- 5.4.2 — 2017-11-15
- 5.4.1 — 2017-11-15
- 5.4.0 — 2017-11-15
- 5.3.1 — 2017-11-13
- 5.3.0 — 2017-09-14
- 5.3.0-beta — 2017-09-13
- … 9 more at https://npm.io/package/tslint-config-airbnb/versions

## README

# TSLint Config Airbnb

[![NPM version](https://img.shields.io/npm/v/tslint-config-airbnb.svg?style=flat)](https://www.npmjs.com/package/tslint-config-airbnb)
[![Downloads](http://img.shields.io/npm/dm/tslint-config-airbnb.svg?style=flat)](https://npmjs.org/package/tslint-config-airbnb)

> A [TSLint config](https://palantir.github.io/tslint/usage/configuration/) for [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)

---

## This package is deprecated

### Migrate to eslint

1. Remove `tslint.json`

2. Remove lines from `tsconfig.json` if included

```json
    "plugins": [
      {
        "name": "typescript-tslint-plugin"
      }
    ],
```

3. Replace packages

```bash
$ npm uninstall tslint tslint-config-airbnb
$ npm uninstall typescript-tslint-plugin
$ npm install --dev eslint @typescript-eslint/eslint-plugin eslint-config-airbnb
$ npx install-peerdeps --dev eslint-config-airbnb
```

4. Create `.eslintrc.json`

```json
{
  "extends": ["airbnb"],
  "plugins": ["@typescript-eslint"],
  "parser": "@typescript-eslint/parser",
  "rules": {
    "import/no-unresolved": 0,
    "react/jsx-filename-extension": {
      "extensions": [
        ".jsx",
        ".tsx"
      ]
    }
  }
}
```

With webpack

```json
{
  :
  "rules": {
    :
    "import/extensions": [".js", ".json", ".jsx", ".ts", ".tsx"],
    :
  },
  "settings": {
    "import/resolver": {
      "webpack": {
        "config": "webpack.config.js"
      }
    }
  }
  :
}
```

5. if you are using Visual Studio Code, add to `vscode's settings.json`

```json
{
  "[typescript]": {
    "editor.formatOnSave": false,
  },
  "eslint.autoFixOnSave": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    { "language": "typescript", "autoFix": true },
    { "language": "typescriptreact", "autoFix": true }
  ]
}
```

---

## Installation

```sh
npm install tslint-config-airbnb --save-dev
```

## Usage

In `tslint.json`:

```json
{
  "extends": "tslint-config-airbnb"
}
```

### Rules

- [tslint](https://www.npmjs.com/package/tslint)
- [tslint-consistent-codestyle](https://www.npmjs.com/package/tslint-consistent-codestyle)
- [tslint-eslint-rules](https://www.npmjs.com/package/tslint-eslint-rules)
- [tslint-microsoft-contrib](https://www.npmjs.com/package/tslint-microsoft-contrib)

## Versioning

```
+----- Major version is synchronize with tslint's major version.
| +--- Minor version has BREAKING CHANGE and feat.
| | +- Patch version has patch.
| | |
x.x.x
```

## License

Apache 2.0

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