typescript - 如何创建我的自定义 tslint 规则集？

Question

我想介绍一个可以跨多个项目共享的 typescript 编码指南。我不想多次复制粘贴 tslint.json，它目前已经发生了，我们有它的不同版本。

我想将我的指南基于 tslint:recommended。我看到 tslint 语法允许 extend，但我不清楚它的用法以及如何构建这样的包。

这样的项目可以只包含一个 tslint.json 本身，还是我需要导出一个模块？

然后我希望将包托管在 npm/sinopia 实例上，但不确定如何进行。

Answer 1

是的。您可以创建一个包含您的规则集的 NPM 模块，并可以在 tslint.json 文件的 extends 设置中引用它。

例如，您可以使用此 package.json 创建一个名为 my-rule-set 的 NPM 模块:

{
    "name": "my-rule-set",
    "version": "0.0.0",
    "main": "my-rule-set.json"
}

和这个 my-rule-set.json(注意 package.json 中的 main 引用了 my- rule-set.json 文件):

{
    "extends": "tslint:recommended",
    "rules":
    {
        ...
    }
}

然后，通过在 node_modules 中安装 my-rule-set，您可以使用自己的规则集扩展 tslint.json 文件:

{
    "extends": "my-rule-set"
}

在 this TSLint blog post 中有更多关于可共享配置的信息.

如果您的规则集仅包含现有规则的配置，那么您只需要做这些。但是，如果您打算实现一些自定义规则，则需要在 my-rule-set.json 中链接到您的自定义规则所在的目录。因此，例如，它还应该有类似这样的内容:"rulesDirectory": "./rules"。然后 ./rules 目录应该包含已编译的 .js 版本的规则。