コンテンツにスキップ

リンター

Wippyには、Luaコードの型チェックと静的解析を行うビルトインリンターが含まれています。wippy lint で実行します。

Terminal window
wippy lint # Check all Lua entries
wippy lint --level hint # Show all diagnostics including hints
wippy lint --json # Output in JSON format
wippy lint --ns app # Check only the app namespace
wippy lint --summary # Group results by error code

リンターはすべてのLuaエントリ種別を検証します:

  • function.lua - 関数
  • library.lua - ライブラリ
  • process.lua - プロセス
  • workflow.lua - ワークフロー

それらのプリコンパイル済み .bc バリアント(function.lua.bclibrary.lua.bcprocess.lua.bcworkflow.lua.bc)もリントされます。

各エントリはパースされ、型チェックされ、正確性の問題が解析されます。

診断には3つの重大度レベルがあります:

レベル説明
error修正が必要な型エラーと正確性の問題
warningバグの可能性が高いパターンや問題のあるパターン
hintスタイルの提案と情報メモ

--level で表示するレベルを制御します:

Terminal window
wippy lint --level error # Errors only
wippy lint --level warning # Warnings and errors (default)
wippy lint --level hint # Everything
コード説明
P0001Lua構文エラー - ソースをパースできません

型チェッカーエラー (E0001+) は、型システムが検出した問題を報告します: 型の不一致、未定義の変数、無効な操作、およびその他の正確性の問題です。これらは常にエラーとして報告されます。

local x: number = "hello" -- E: string not assignable to number
local function add(a: number, b: number): number
return a + b
end
add("one", "two") -- E: string not assignable to number

リントルールはコードスタイルと品質のチェックを提供します。--rules で有効にします:

Terminal window
wippy lint --rules
コードルール説明
W0001no-empty-blocks空のブロック文
W0002no-global-assignグローバル変数への代入
W0003no-self-compare値の自己比較
W0004no-unused-vars未使用のローカル変数
W0005no-unused-params未使用の関数パラメータ
W0006no-unused-imports未使用のインポート
W0007no-shadowed-vars外部スコープの変数を隠蔽

--rules なしでは、型チェック(PコードとEコード)のみが実行されます。

名前空間によるフィルタリング

Section titled “名前空間によるフィルタリング”

--ns を使用して特定の名前空間をチェックします:

Terminal window
wippy lint --ns app # Exact namespace match
wippy lint --ns "app.*" # All under app
wippy lint --ns app --ns lib # Multiple namespaces

選択されたエントリの依存関係は型チェックのためにロードされますが、それらの診断は報告されません。

エラーコードによるフィルタリング

Section titled “エラーコードによるフィルタリング”

コードで診断をフィルタリングします:

Terminal window
wippy lint --code E0001
wippy lint --code E0001 --code E0004

表示する診断の数を制限します:

Terminal window
wippy lint --limit 10 # Show first 10 issues

テーブルフォーマット (デフォルト)

Section titled “テーブルフォーマット (デフォルト)”

各診断はソースコンテキスト、ファイルの場所、およびエラーメッセージとともに表示されます。結果はエントリ、重大度、行番号の順にソートされます。

サマリー行に合計が表示されます:

Checked 42 entries: 5 errors, 12 warnings

名前空間とエラーコードで診断をグループ化します:

Terminal window
wippy lint --summary
By namespace:
app 15 issues (5 errors, 10 warnings)
lib 2 issues (2 warnings)
By error code:
E0001 [error ] 5 occurrences
E0004 [error ] 3 occurrences
Checked 42 entries: 5 errors, 12 warnings

CI/CD統合のための機械可読出力:

Terminal window
wippy lint --json
{
"diagnostics": [
{
"entry_id": "app:handler",
"code": "E0001",
"severity": "error",
"message": "string not assignable to number",
"line": 10,
"column": 5
}
],
"total_entries": 42,
"error_count": 5,
"warning_count": 12,
"hint_count": 0
}

リンターは繰り返しの実行を高速化するために結果をキャッシュします。キャッシュキーはソースコードのハッシュ、メソッド名、依存関係、および型システムの設定に基づいています。

結果が古いと思われる場合はキャッシュをクリアしてください:

Terminal window
wippy lint --cache-reset

自動チェックにはJSON出力と終了コードを使用します:

Terminal window
wippy lint --json --level error > lint-results.json

リンターはエラーが見つからない場合は終了コード0で終了し、エラーがある場合は非ゼロで終了します。

GitHub Actionsステップの例:

- name: Lint
run: wippy lint --level warning
フラグ短縮形デフォルト説明
--levelwarning最小重大度レベル (error, warning, hint)
--jsonfalseJSON形式で出力
--ns名前空間パターンでフィルタリング
--codeエラーコードでフィルタリング
--limit0表示する診断の最大数 (0 = 無制限)
--summaryfalseエラーコードでグループ化
--no-colorfalseカラー出力を無効化
--rulesfalseリントルールを有効化(Wシリーズのスタイル/品質チェック)
--cache-resetfalseリント前にキャッシュをクリア
--lock-file-lwippy.lockロックファイルのパス
  • CLI - CLI完全リファレンス
  • - 型システムのドキュメント
  • LSP - ライブ診断によるエディタ統合