如何創建我的自定義tslint規則集？

Question

我想介紹一個可以在多個項目中共享的打字稿編碼指南。 我不想復制粘貼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"
}

此TSLint博客文章中提供了有關可共享配置的更多信息。

如果您的規則集僅包含現有規則的配置，那么您只需要這樣做。 但是，如果您打算實現一些自定義規則，則在my-rule-set.json您需要鏈接到自定義規則所在的目錄。 因此，例如，它也應該具有類似： "rulesDirectory": "./rules" 。 然后./rules目錄應包含規則的已編譯.js版本。