ESLint没有报告TypeScript编译器类型检查错误

Question

寻求帮助，将TypeScript编译器报告的类型错误输入到ESLint的输出中。库typescript eslint(https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md)让我觉得这应该是可能的。

文件结构

src/
  ... source files
  tsconfig.json
test/
  ... testing files
.eslintrc.js
package.json
tsconfig.json (symlink to src/tsconfig.json)

.eslintrc.js

module.exports = {
  'env': {
    'jest': true,
    'node': true,
  },
  'extends': [
    'airbnb-typescript/base',
    'plugin:@typescript-eslint/eslint-recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:@typescript-eslint/recommended-requiring-type-checking',
    'plugin:jest/recommended',
  ],
  'parser': '@typescript-eslint/parser',
  'parserOptions': {
    'project': ['./tsconfig.json'],
    'tsconfigRootDir': __dirname,
  },
  'plugins': [
    '@typescript-eslint',
    'jest',
  ],
  'root': true,
};

包.json

{
  "name": "...",
  "version": "...",
  "description": "...",
  "scripts": {},
  "devDependencies": {
    "@types/jest": "^25.1.3",
    "@typescript-eslint/eslint-plugin": "^2.21.0",
    "@typescript-eslint/parser": "^2.21.0",
    "eslint": "^6.8.0",
    "eslint-config-airbnb-typescript": "^7.0.0",
    "eslint-plugin-import": "^2.20.1",
    "eslint-plugin-jest": "^23.8.1",
    "jest": "^25.1.0",
    "nock": "^12.0.2",
    "ts-jest": "^25.2.1"
  },
  "dependencies": {
    "@types/node": "^13.7.7",
    "aws-sdk": "^2.630.0",
    "jsonschema": "^1.2.5",
    "typescript": "^3.8.3"
  }
}

ESLint的输出为空-没有错误-但是在运行TypeScript编译器以构建项目时，报告了许多错误；例如：

src/file.ts:xx:xx - error TS2339: Property 'body' does not exist on type 'object'.
src/file.ts:xx:xx - error TS2314: Generic type 'Promise<T>' requires 1 type argument(s).
src/filets:xx:xx - error TS7006: Parameter 'err' implicitly has an 'any' type.

我是在配置中遗漏了什么，还是在某种程度上不恰当？或者这不是实际上可能的事情？

我希望通过ESLint报告错误，因为在我处理项目时，我的编辑器中显示了linting错误。我正在使用Atom(https://atom.io/)但我也希望这能适用于VSCode，也可能适用于VIM；团队成员更喜欢不同的编辑器。

Answer 1

您可以使用以下设置报告TypeScript类型检查错误：

  "scripts": {
     "lint": "eslint src/**/*.{ts,tsx}",
     "lint:fix": "eslint src/**/*.{ts,tsx} --fix",
     "prettify": "prettier --write src/**/*.{ts,tsx}",
     "type-check": "tsc --noEmit",
   },
  "lint-staged": {
     "*.{ts,tsx}": [
       "eslint",
       "prettier --write",
       "git add"
     ]
   },

最后，要运行脚本来检查lint和类型检查错误，您可以使用以下命令：

yarn type-check && lint-staged

Answer 2

不幸的是，ESLint只报告来自它自己的linter的错误，它不报告typescript编译失败。我很同情你——在我的项目中，我使用Babel来更快地传输类型脚本，但由于Babel实际上并不检查类型（它只是删除它们），我仍然需要将类型检查作为一个单独的lint步骤。

这篇博文https://iamturns.com/typescript-babel/描述了如何在您的package.json中设置检查类型脚本来执行此lint函数，并将typecript编译器视为辅助linter。您甚至可以让它在运行eslint的相同lint命令中运行：

{
  ...
  "scripts": {
    "check-types": "tsc --noemit",
    "eslint": "eslint",
    "lint": "npm run eslint && npm run check-types",
  }

然后，您将设置持续集成服务器以运行npm run lint作为其构建步骤之一。

对于您的编辑器，似乎有一个用于typescript的Atom插件：https://atom.io/packages/atom-typescript
这将是在编辑器中显示typescript错误的理想方法。VSCode内置了此功能。我主要使用VSCode，效果很好！

我建议VSCode的最后一个设置是将eslint的“自动修复”功能与VSCode的eslint插件一起使用，并将其配置为在保存文件时运行eslint。您可以在.vscode/settings中执行此操作。基于每个项目的json：

{
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}