一、安装ESLint工具和TypeScript语言插件
在工程根目录下执行如下命令:
npm install --save-dev eslint
npm install --save-dev typescript @typescript-eslint/parser
npm install --save-dev @typescript-eslint/eslint-plugin
命令分别安装了eslint工具、ts的语法解析工具、ts的语法规则插件;
二、根目录下创建规则配置文件“ .eslintrc.json ”
配置文件的格式如下:
{
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"rules": {
"@typescript-eslint/adjacent-overload-signatures": "error"
}
}
在rules下配置需要的TS语言相关规则,github中有开源项目解释了具体的规则和用法,可以参考:typescript-eslint/packages/eslint-plugin/docs/rules at main · typescript-eslint/typescript-eslint (github.com)
三、开始扫描文件
在根目录的package.json文件中加入如下命令:
"scripts": {
"eslint": "eslint./ --ext .ts"
}
作用是在npm中加入了脚本指令eslint,执行扫描根目录下所有.ts文件;
然后执行下面指令:
npm run eslint
即可开始扫描;