本文へ移動
Hikari 仕様

静的検査 (hikari check) 仕様

本書は hikari check の仕様を定める。起動ディスパッチ全体と終了コードの共通表は hikari-command.md、検査そのものの規則は static-analysis.md を参照。

指定した各 .hika を起点 (entry) に、評価せず 静的検査 (static-analysis.md §1) のみを実行する。entry とそこから到達可能なモジュールグラフ全体を構文検査・型検査し、結果に応じた終了コードを返す。CI や保存時フックでの利用を想定する。check / format / lint の住み分けは hikari-command.md §1.2。

構文

hikari check <path>...

ファイルを明示する場合は .hika の接尾辞を要求し、それ以外は引数不正として拒む。
あるパスの収集や読み取りに失敗しても、残りのパスの収集と検査を続ける。

引数には .hika ファイルまたはディレクトリを 1 つ以上指定する。ディレクトリは配下の .hika を再帰収集する (format (format.md) / lint (lint.md) と同じパス展開)。収集した各ファイルをそれぞれ entry として検査する。1 件の検査単位は到達可能なモジュールグラフ全体であり、lint の「ファイル単位・import 解決なし」とは異なる (hikari-command.md §1.2)。

検査内容

ファイル実行 (hikari-command.md §5) の開始前に走るものと同一の検査 (同じ analyze)。検出対象は static-analysis.md §1 を参照。

hikari check は構文・import 解決層 (前段) に加えて、静的型検査 (static-analysis.md §2) を行う。型検査の対象は entry から import で到達するすべてのファイルである (static-analysis.md §2.1「検査するファイル」)。検査は 1 つで、水準を下げるフラグは持たない — hikari check が緑なら実行もできる、という対応を崩さないためである。規則はファイル実行 hikari <path> (hikari-command.md §5.5) と同じで、全実行系・LSP (lsp.md「起動」)・ビルド (build.md「静的型検査」) が同じ水準で検査する。診断・終了コードの形式は「出力と終了コード」のとおり (型エラーは exit 1)。

型検査は、型が付くと示せない値を受理しない (static-analysis.md §2.1)。
値の位置の型不明・未確定の型変数も静的エラーであり、暗黙の下方変換は認めない。

静的な代入可能性と使用の検査: 注釈への代入、メンバー参照、演算、呼び出しについて、値の型が必要な条件を満たすことを要求する。
型注釈と値の照合・型注釈位置の未定義型名 (static-analysis.md §2.4)、
メンバーの解決 (同 §2.7)、
演算子と適用 (同 §2.8)、
値位置の未定義参照 (同 §2.13)、
Future の検査 (同 §2.12) がこれにあたる。
関数結果の静的な照合 (同 §2.2 / §2.6) と、
条件の matches による絞り込み (同 §2.3) も、この証明に使う。

契約系のもの: 到達してもその地点では panic しないが、宣言された型・述語・網羅性という契約に反する箇所を実行前に塞ぐ。主なものは次のとおり。

  • 名前付き関数の結果型の暗黙 Any を禁止: 名前に束縛された関数 (body 非空) で、結果型注釈を省略し、かつ本体から推論した型がネスト位置に Any を含む (List(Any)・Result(Any)・record の Any フィールド等。bare な top-level Any は値束縛と同じく対象外) 場合は型エラー。Any を意図する場合は束縛注釈 add: { Int, Int | Any } := …/内部名注釈 { inner self: { Int, Int | Any } | … } で明示すればオプトインとして許容し、body 末尾アスクリプション { x, y | expr: Any } の Any は禁止する (language-spec.md §17.3・許否は static-analysis.md §2.5 のマトリクス)。
  • 名前付き関数のパラメーター型必須化: 名前に束縛された関数 (body 非空) の各パラメーター型が、インライン注釈・宣言関数型の対応位置 (非 Any)・推論可能なデフォルトのいずれでも確定しなければ型エラー。インライン x: Any は操作できない top 型の明示として充足する。bare パラメーターと関数型注釈位置の Any は充足とみなさない (static-analysis.md §2.5)。
  • 宣言結果型を契約とした越境照合 (同 §2.6): 完全適用 f(args) の結果型を宣言から確定し、x: T := f(args) 等の照合に用いる。宣言結果型は末尾式だけでなく return / ? の全脱出経路とも照合する。
  • 分岐の収束と網羅性 (同 §2.9): 期待型の無い if/match の分岐結果型が割れること、closed variant の match の被覆漏れ (非網羅)、および到達しえないアーム・冗長な catch-all (不要 default)。
  • 可変状態の型安定性 (同 §2.10)・非ゼロと添字の検査 (同 §2.11)・Future payload の照合 (同 §2.12)。
  • 多重度型の消費追跡 (同 §2.14): 多重度型 (language-spec.md §17.8) が課す契約の破れ。消費済みの値への出現・分岐での消費状態の割れ・ExactlyOnce の未消費がこれにあたる。多重度は実行時に何も照合しないため、この系統はすべて契約系である。

自動推論の対象外は static-analysis.md §2.16 を参照。

import 解決規則はファイル実行 (hikari-command.md §5.3) と同じ (import を書いたファイルのディレクトリを起点とし、パスは OS の規則に従う)。検査の結果は import 元に依らないので、複数 entry が同じモジュールへ到達しても、1 回の hikari check の中でそのモジュールは 1 度だけ検査し、診断も 1 度だけ出す。entry として指定したファイルへ別の entry から到達した場合も同じである。

[check] skip (format.md「除外 skip」) は entry として集めないだけである。 skip したファイルへ別の entry から import で到達したら、そのファイルも検査する。実行 (hikari <path>) は hikari.toml を読まずに到達したファイルをすべて検査するので、import 先まで skip で外すと「hikari check は緑なのに実行は型エラーで止まる」形ができる。

出力と終了コード

  • 全 entry の検査がクリーンな場合は 何も出力せず exit code 0。
  • 静的エラーがある場合は各診断を <file>:<line>:<col>: <msg> (<code>) 形式で stderr に出す。末尾の (<code>) は診断コードで、hikari lint と同じ体裁で添える。コードの一覧は static-analysis.md が定める。
  • 複数 entry のときは全 entry を検査し、終了コードはそれらの最大値になる (いずれかに静的エラーがあれば 1、いずれかの読み取りに失敗すれば 2)。
状況 code
静的エラーなし 0
静的エラーあり 1
読み取り失敗 / 引数不正 / .hika 不在 2