配置 ESLint RuleTester 以使用 Typescript Parser

Day*_*qui 8 eslint typescript-eslint

我正在尝试为我的基于打字稿的项目编写一些自定义 ESLint 规则。在我的项目中,我使用 eslint/typescript 进行 linting。

我已经编写了一个自定义 eslint 插件来验证自定义规则。现在我想为该自定义规则编写单元测试。我的测试文件如下所示:

/**
 * @fileoverview This rule verifies that logic can only depend on other logic
 * @author Dayem Siddiqui
 */
"use strict";

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const typescriptParser = require('@typescript-eslint/parser')
var rule = require("../../../lib/rules/logic-dependency"),
  RuleTester = require("eslint").RuleTester;

//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
typescriptParser.parseForESLint()
var ruleTester = new RuleTester({ parserOptions: {} });
ruleTester.run("logic-dependency", rule, {
  valid: [
    `class DeleteLogic {

        }
    class CreateLogic {
            constructor(private deleteLogic: DeleteLogic) {}
    }`
  ],

  invalid: [
    {
      code: `class ExternalClient {

            }
            
            class UpdateLogic {
                constructor(private externalClient: ExternalClient) {}
            }`,
      errors: [
        {
          message: "Logic cannot have a dependency on client",
          type: "MethodDefinition"
        }
      ]
    }
  ]
});
Run Code Online (Sandbox Code Playgroud)

现在我的测试失败了,因为默认情况下 eslint 只能理解纯 Javascript 代码。我知道我需要以某种方式配置它以使用自定义解析器,使其能够理解/解析打字稿代码。但是我无法在网上找到关于如何做到这一点的好例子

小智 5

RuleTester 构造函数采用 eslint 的 解析器选项,允许配置解析器本身。所以像这样传递它,鲍勃是你的叔叔:

const ruleTester = new RuleTester({
  parser: '@typescript-eslint/parser',
});
Run Code Online (Sandbox Code Playgroud)

typescript-eslint 自己的规则测试(例如这个)正是使用这个。

(正在寻找这个问题的答案并一直在这里结束,所以我发布了我在这里找到的解决方案,希望它会有所帮助。)


eslint 6.0+

结合@Sonata的评论:

Eslint 6.0+ 需要解析器的绝对路径(请参阅6.0 迁移指南):

const ruleTester = new RuleTester({
  parser: require.resolve('@typescript-eslint/parser'),
});
Run Code Online (Sandbox Code Playgroud)

  • 新版本的 eslint (>v6.0.0) 要求您使用绝对路径:`parser: require.resolve('@typescript-eslint/parser')`。请参阅https://github.com/eslint/eslint/blob/master/docs/user-guide/migration-to-6.0.0.md#rule-tester-parser (3认同)

Dea*_*ltz 0

使用诸如typescript-eslint/parser之类的包。在这种情况下,我只能提供一个链接。如果您需要使用它的帮助,请告诉我。