tlin下載tlin源代碼下載

tlin

其他類別

v1.1.0

下載

Tlin：GNO的皮棉

類似語法語言的先進林格。

介紹

Tlin是專為GO和GNO編程語言而設計的襯裡。它利用Golangci-lint作為其主要覆蓋引擎的功能，為類似Go樣語法的語言提供強大的代碼分析。

受Rust的Clippy的啟發，TLIN的目標是為默認Golangci-lint規則提供其他代碼改進建議。

特徵

支持GO（.go）和GNO（.gno）文件
能夠添加自定義棉絨規則
其他代碼改進建議，例如檢測不必要的代碼
自動修復一些棉絨規則
循環複雜性分析

安裝

要求：
- 去：1.22或更高
- GNO的最新版本
- GNU使3.81或更高（用於建築物）

要安裝Tlin CLI，請按照以下步驟：

克隆存儲庫

git clone https://github.com/gnolang/tlin

 cd tlin

安裝CLI

go install ./cmd/tlin

就是這樣！現在，您可以在終端中使用tlin命令。

用法

tlin < path >

將<path>替換為要分析的文件或目錄路徑。

要檢查當前目錄，請運行：

tlin .

配置

Tlin支持配置文件（ .tlin.yaml ）來自定義其行為。您可以通過運行來生成默認配置文件：

tlin -init

此命令將在當前目錄中創建一個.tlin.yaml文件，其中包含以下內容：

 # .tlin.yaml
name : tlin
rules :

您可以自定義配置文件以啟用或禁用特定的棉絨規則，設置循環複雜性閾值等。

 # .tlin.yaml
name : tlin
rules :
  useless-break :
    severity : WARNING
  deprecated-function :
    severity : OFF

添加GNO特定的棉絨規則

我們的Linter允許在默認的Golangci-lint規則之外添加自定義棉絨規則。要添加新的棉絨規則，請按照以下步驟：

配x如果您添加了新規則或格式化器，則必須更新相關測試。

為您提出的棉布規則創建RFC（請求註釋）文檔：
- 描述新規則的目的和動力。您可以在RFC中找到模板
- 提供規則將標記的代碼示例。
- 解釋任何潛在的邊緣案例或考慮因素。
- 概述擬議的實施方法。
在Tlin存儲庫中打開新問題，然後附上您的RFC文檔。
等待社區反饋和維護者的批准。根據反饋，請準備好迭代RFC。

RFC批准後，繼續執行：

一個。實現您的新規則的LintRule接口：

 type NewRule struct {}

func ( r * NewRule ) Check ( filename string , node * ast. File ) ([]types. Issue , error ) {
    // Implement your lint rule logic here
    // return a slice of Issues and any error encountered
}

b。在registerAllRules中註冊您的新規則，也許是internal/engine.go中的Engine結構的registerDefaultRules方法：

 func ( e * Engine ) registerDefaultRules () {
    e . rules = append ( e . rules ,
        & GolangciLintRule {},
        // ...
        & NewRule {}, // Add your new rule here
    )
}

 func ( e * Engine ) registerAllRules () {
    e . rules = append ( e . rules ,
        & GolangciLintRule {},
        // ...
        & NewRule {}, // Add your new rule here
    )
}

（可選）如果您的規則需要特殊格式，請在formatter包中創建一個新的格式化器：

一個。創建一個新文件（例如formatter/new_rule.go ）。

b。為您的新規則實現IssueFormatter接口：

 type NewRuleFormatter struct {}

func ( f * NewRuleFormatter ) Format (
    issue types. Issue ,
    snippet * internal. SourceCode ,
) string {
    // Implement formatting logic for new rule here.
}

c。將新的格式器添加到formatter/fmt.go中的GetFormatter函數中。

 func GetFormatter ( rule string ) IssueFormatter {
    switch rule {
    // ...
    case "new_rule" : // Add your new rule here
        return & NewRuleFormatter {}
    default :
        return & DefaultFormatter {}
    }
}