tslint-config-airbnb's Introduction

TSLint Config Airbnb

A TSLint config for Airbnb JavaScript Style Guide

This package is deprecated

Migrate to eslint

Remove tslint.json
Remove lines from tsconfig.json if included

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

Replace packages

$ 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

Create .eslintrc.json

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

With webpack

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

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

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

Installation

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

Usage

In tslint.json:

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

Rules

Versioning

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