tlinダウンロードtlinソースコードのダウンロード

tlin

その他のカテゴリー

v1.1.0

ダウンロード

Tlin：GNOの糸くず

GOのような文法言語の前線。

導入

Tlinは、GOプログラミング言語とGNOプログラミング言語の両方に合わせて設計されたリナーです。 Golangci-Lintの機能をメインの糸くずエンジンとして活用し、GOのような文法言語の強力なコード分析を提供します。

RustのClippyに触発されたTlinは、デフォルトのGolangci-Lintルールを超えて追加のコード改善提案を提供することを目指しています。

特徴

Go（.go）およびGno（.gno）ファイルのサポート
カスタムリントルールを追加する機能
不要なコードの検出など、追加のコード改善提案
いくつかの糸くずのルールの自動修正
環状複雑度分析

インストール

要件：
- GO：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 :

構成ファイルをカスタマイズして、特定のLintルールを有効または無効にし、Cyclomaticの複雑さのしきい値を設定します。

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

GNO固有のLintルールの追加

私たちのリナーを使用すると、デフォルトのGolangci-Lintルールを超えてカスタムリントルールを追加できます。新しい糸くずルールを追加するには、次の手順に従ってください。

ショ和新しいルールまたはフォーマッタを追加した場合は、関連するテストを更新する必要があります。

提案されているLINTルールのRFC（コメントのリクエスト）ドキュメントを作成します。
- 新しいルールの目的と動機を説明してください。 RFCでテンプレートを見つけることができます
- ルールがフラグを立てるコードの例を提供します。
- 潜在的なエッジのケースまたは考慮事項を説明してください。
- 提案された実装アプローチの概要。
Tlinリポジトリで新しい問題を開き、RFCドキュメントを添付します。
コミュニティのフィードバックとメンテナーの承認を待ちます。フィードバックに基づいてRFCを反復する準備をしてください。

RFCが承認されたら、実装を続行します。

a。新しいルールのために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に登録し、おそらくregisterDefaultRules Engineのinternal/engine.go ：

 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パッケージに新しいフォーマッタを作成します。

a。新しいファイルを作成します（例： 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 {}
    }
}