Tsuzuri for Visual Studio Code

Tsuzuri は、関数型の式と所有権モデルを備え、LLVM でネイティブコードと WebAssembly を生成するプログラミング言語です。 この拡張機能をインストールするだけで、VS Code で Tsuzuri のコーディング / 実行 / テスト / デバッグ ができます。

特長

• 追加のインストールが不要: コンパイラ、LLVM、リンカー、C ランタイム、デバッガーを同梱していますので、追加のランタイム インストールなどは不要です。
• 書きながら確認: 保存前からエラーと警告を表示し、ホバーで型とドキュメントを確認できます。
• ボタンひとつで実行: エディター右上のボタンでビルド、実行、デバッグができます。tasks.json や launch.json は不要です。
• テスト: test 宣言を Test Explorer に表示し、まとめて、または 1 件ずつ実行できます。
• デバッグ: ブレークポイント、ステップ実行、呼び出し履歴、ローカル変数を利用できます。
• オフラインのドキュメント: 日本語の言語ハンドブックを同梱しています。

はじめに

1. インストール

拡張機能ビュー（Windows / Linux は Ctrl+Shift+X、macOS は Cmd+Shift+X）で Tsuzuri を検索し、Install を選びます。 OS と CPU に合ったパッケージが自動で選ばれます。対応している OS と CPU は、後述の「対応環境」を参照してください。

2. プロジェクトを作る

1. コマンドパレット（Windows / Linux は Ctrl+Shift+P、macOS は Cmd+Shift+P）で Tsuzuri: New Project を実行します。
2. 空のフォルダーを選びます。次のファイルが作られ、そのフォルダーが新しいウィンドウで開きます。

フォルダーを信頼するかどうか確認されたら、信頼を選びます。信頼していないフォルダーでは、コンパイラやプログラムを起動しません。 既存のフォルダーでも、Main.tz か Tsuzuri.toml があれば Tsuzuri のプロジェクトとして扱います。

3. Hello, World を表示する

Main.tz を開き、次の内容にします。

def main :: IO<unit> =
    do! IO.write_line "Hello, World!"

test "adds numbers" = assert (1 + 2 == 3)

• def main :: IO<unit> はプログラムの入口です。IO<unit> は、入出力を行い、値を返さない処理を表します。
• do! IO.write_line "..." は、文字列と改行を標準出力へ書き込みます。字下げした行が main の本体です。
• test "名前" = assert (条件) はテストです。通常のビルドには含まれません。

エディター右上の ▷（Run Project）を押します。ファイルを保存してビルドし、ターミナルに Hello, World! を表示します。

使い方

コードを書く

• 構文の色分け、括弧の補完、コメントの切り替え、折りたたみ。
• 入力中の構文・型・所有権のエラーと警告。保存していない変更も検査します。
• 型とドキュメントコメント（///）のホバー表示、定義への移動、アウトライン、パンくずリスト。
• Format Document（Windows / Linux は Shift+Alt+F、macOS は Shift+Option+F）による公式フォーマッターでの整形。
• キーワード、型、標準ライブラリの関数の補完。
• def、main、test、record、union、match、class、doc などのスニペット。

エラーは波線と問題パネルに表示します。

IO. のようにモジュール名に続けて入力すると、標準ライブラリの関数を補完します。

実行とビルド

エディター右上のボタン、コマンドパレット、ステータスバー左下の Tsuzuri から操作します。 実行前には未保存のファイルを保存します。

ビルドと実行は既定で -O3 の最適化を行います。設定の tsuzuri.optimization で変更できます。 WebAssembly を動かすブラウザーや Node.js などのホストは、別に用意してください。

テスト

テストは test "名前" = assert (条件) と書きます。次の例では、main の返した値 360 が実行時に表示されます。

record Order { price: i64, quantity: i64 }

/// 注文の小計を計算します。
def subtotal :: Order -> i64 = \order ->
    let amount = order.price * order.quantity
    amount

def main :: i64 =
    let order = Order { price: 120, quantity: 3 }
    subtotal order

test "subtotal multiplies price by quantity" =
    assert (subtotal (Order { price: 120, quantity: 3 }) == 360)

test "empty order costs nothing" =
    assert (subtotal (Order { price: 120, quantity: 0 }) == 0)

アクティビティバーの Testing ビューに、プロジェクト内のテストが自動で表示されます。 すべてのテストをまとめて実行するほか、行番号の横の ▷ から 1 件ずつ実行できます。 結果には成否と所要時間が表示され、失敗したテストはその位置にメッセージを表示します。 既定では -O0 でビルドします。Testing ビューの実行ボタンの横にあるメニューで Native (O3) のプロファイルを選ぶと、最適化したコードでテストできます。

デバッグ

1. 行番号の左をクリックして、ブレークポイントを置きます。
2. F5 を押すか、エディター右上のデバッグボタン（Debug Project）を押します。

デバッグ情報付きでビルドし、ブレークポイントで停止します。変数、ウォッチ式、呼び出し履歴、ステップ実行を利用できます。 冒頭の画面は、上の例で subtotal の中に止め、引数 order とローカル変数 amount を表示したものです。

初回のデバッグでは、同梱しているデバッガー拡張機能 CodeLLDB を自動でインストールします。インターネット接続は不要です。 既に CodeLLDB をインストールしている場合は、それを使います。

通常は launch.json を作る必要はありません。プログラムに引数や環境変数を渡す場合は、次のように指定します。

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "tsuzuri",
            "request": "launch",
            "name": "Debug Tsuzuri",
            "args": ["input.txt"],
            "env": { "LOG_LEVEL": "debug" }
        }
    ]
}

project でプロジェクトのフォルダー、stopOnEntry で開始直後の停止も指定できます。

ドキュメントを読む

Tsuzuri: Open Documentation で、入門、言語リファレンス、標準ライブラリを含む日本語ハンドブックを VS Code の中に開きます。 同じ内容は GitHub でも読めます。

コマンド

設定

1 つのフォルダーに複数のプロジェクトを入れる場合は、プロジェクトごとにワークスペースフォルダーを分けるか、tsuzuri.projectPath を指定してください。

対応環境

VS Code 1.103 以降が必要です。

• 32-bit x86、Alpine Linux など musl ベースの環境で動く VS Code、Web 版 VS Code は対象外です。
• Remote - SSH、WSL、Dev Containers では、リモート側に拡張機能をインストールしてください。
• Linux で作る実行ファイルは、同梱の musl を使います。

現在の制限

• 補完はキーワード、型、標準ライブラリの関数が対象です。型に基づく補完、参照の検索、名前の変更、シグネチャヘルプ、クイックフィックスには未対応です。
• デバッガーの変数表示は DWARF に基づく低水準の表示です。Tsuzuri の式の評価には対応していません。
• テストを 1 件だけデバッグする機能には未対応です。
• 既知の問題: macOS では、IO を使うプログラム（New Project で作る例を含む）のブレークポイントで停止しません。IO を使わないプログラムでは停止します。

セキュリティとプライバシー

• 信頼していないワークスペースでは、コード、コンパイラ、設定に由来するプログラムを起動しません。
• この拡張機能は利用状況のデータ（テレメトリ）を送信しません。

リンク

• Tsuzuri のリポジトリ
• 日本語ドキュメント
• 問題の報告
• 拡張機能の開発者向け情報

ライセンス

Apache License 2.0 です。同梱している LLVM、Zig、CodeLLDB などは、それぞれのライセンスに従います。各ライセンスはパッケージに含まれています。