37.【TypeScript 教程】TSLint 与 ESLint

前端玖耀里2024-02-01 13:07

TypeScript TSLint 与 ESLint

本节将介绍怎样在一个 TypeScript 项目中使用 ESLint 规范，至于为什么不推荐使用 TSLint，可以看下这篇文章：TypeScript 官方已经决定全面采用 ESLint，ESLint 的 TypeScript 解析器也成为独立项目，专注解决双方兼容性问题。

所以，同开发前端项目一样，熟练掌握 ESLint 规则，也成了 TypeScript 项目开发的必要条件。

1. 解释

ESLint 是一个插件化并且可配置的 JavaScript 语法规则和代码风格的检查工具。

保持代码风格的一致性能增加可读性，更便于团队合作。保持一致就意味着要对我们编写的代码增加一定的约束，ESLint 就是这么一个通过各种规则对我们的代码添加约束的工具。

2. 用 ESLint 规范 Typescript 代码

安装 ESLint 规范 Typescript 代码所需依赖包：

npm install -d eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin

@typescript-eslint/parser 库是 ESLint 的 TypeScript 解析器，用来检查和规范 TypeScript 代码。

在项目根目录下创建 .eslintrc.js 文件进行配置：

module.exports = {
  root: true,
  env:{                         
    browser: true,
    node: true,
  }  
  parser:  '@typescript-eslint/parser',
  extends: [
    'plugin:@typescript-eslint/recommended'
  ],
  plugins: [
    '@typescript-eslint'
  ],
  rules: {
    
  }                      
}

其中属性 rules 是对象类型，每个团队都有自己的一套标准规范，按照要求在此配置对应的 ESLint 检测规则即可。

3. 小结

在掌握了 ESLint 的配置规则后，还可以搭配 prettier、husky、lint-staged 等这些优秀的库形成适合自己团队的代码风格。