TSLint Config Airbnb 使用教程

TSLint Config Airbnb 使用教程

tslint-config-airbnb [Deprecated] A TSLint config for Airbnb JavaScript Style 项目地址: https://gitcode.com/gh_mirrors/ts/tslint-config-airbnb

1. 项目介绍

tslint-config-airbnb 是一个为 Airbnb JavaScript 风格指南提供的 TSLint 配置。该项目已经被弃用，建议迁移到 ESLint。尽管如此，了解其配置和使用方法仍然有助于理解如何将 TSLint 配置应用于 TypeScript 项目。

2. 项目快速启动

安装

首先，确保你已经安装了 tslint 和 tslint-config-airbnb：

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

配置

在项目的根目录下创建或编辑 tslint.json 文件，添加以下内容：

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

使用

在项目中运行 TSLint 检查：

tslint -c tslint.json 'src/**/*.ts'

3. 应用案例和最佳实践

迁移到 ESLint

由于 tslint-config-airbnb 已被弃用，建议迁移到 ESLint。以下是迁移步骤：

1. 卸载 TSLint 相关包：

   npm uninstall tslint tslint-config-airbnb typescript-tslint-plugin
   

2. 安装 ESLint 和相关插件：

   npm install --dev eslint @typescript-eslint/eslint-plugin eslint-config-airbnb
   npx install-peerdeps --dev eslint-config-airbnb
   

3. 创建 .eslintrc.json 文件：

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

4. 配置 Webpack（如果使用）：

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

5. 配置 Visual Studio Code（如果使用）：

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

4. 典型生态项目

• TSLint: 一个用于检查 TypeScript 代码风格的工具。
• ESLint: 一个更现代的代码检查工具，支持 TypeScript 和 JavaScript。
• eslint-config-airbnb: Airbnb 提供的 ESLint 配置，适用于 JavaScript 和 TypeScript 项目。

通过本教程，你应该能够快速上手 tslint-config-airbnb 并了解如何迁移到更现代的 ESLint 配置。

tslint-config-airbnb [Deprecated] A TSLint config for Airbnb JavaScript Style 项目地址: https://gitcode.com/gh_mirrors/ts/tslint-config-airbnb