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 {}
    }
}