Flutter Tools

Flutter Tools は、Zed で Dart と Flutter を VS Code と同じように動かします。Zed 自身の Dart の拡張機能が提供するもの (ハイライト、Dart の言語サーバー、そのタスク、Dart デバッガー) をすべて含み、Flutter の開発者が毎日必要とするものを加えます。デバイスでのアプリの実行、保存時のホットリロード、DevTools、スニペットです。

拡張機能の ID flutter-tools
バージョン 0.3.0
必要なもの PATH 上の Flutter、または fvm。他には何も要りません。拡張機能は Flutter SDK 自身の Dart で動きます
ソース zed_editor_extensions リポジトリの flutter-extension

Flutter Tools は Dart の言語を自分で定義します。言語に実行のタスクを追加できるのは、その言語を定義する拡張機能だけだからです。そのため、Zed の Dart の拡張機能を 置き換えます。まずそれをアンインストールしてください (インストール を参照)。

提供するもの

アプリを実行する

Dart ファイルから実行ウィンドウを開きます。Run タブには task: spawn、Debug タブには debugger: start (デフォルトのキーマップでは F4) です。各プラットフォームについて、一組があります。

タブ 名前 内容
Run Flutter: run on iOS Simulator ターミナルでの flutter run。r、R、q が使える
Debug Flutter: debug on iOS Simulator 保存時のホットリロードとホットリスタートを持つデバッガー

同じ組が、Android、Web、macOS、Windows、Linux にもあります。Flutter アプリの main() の横のガターにある実行ボタンも、実行のタスクを提供します。各タスクは、プラットフォームでデバイスを選びます。

プラットフォーム デバイス
iOS Simulator 動いているシミュレーター。なければ最新の iOS の iPhone シミュレーターを起動する
Android 接続されたスマートフォン、または動いているエミュレーター。なければ最初のエミュレーターを起動する
Web Chrome または Edge。どちらもなければ web-server で、その URL は任意のブラウザーで開ける
macOS、Windows、Linux このコンピューター。それぞれ自身の OS でだけ

それらはプロジェクトのルートの lib/main.dart を実行し、プロジェクトに .fvmrc があれば fvm を通します。フレーバー、別のエントリーポイント、特定のスマートフォンには、独自のシナリオを追加します (デバッグのオプション を参照)。

Run タブには、flutter run、fvm flutter run、flutter test、fvm flutter test、dart pub get、dart analyze、dart format、dart run build_runner build、dart run build_runner watch も列挙されます。

素の Dart

Flutter アプリでないプロジェクトでは、task: spawn は次のものを提供します。

タスク 実行するもの
dart run: <file> エディターで開いているファイルの、そのパッケージでの dart run。プロジェクトが build_runner を使っていれば先にビルドする。main() の横の実行ボタンにも
dart run: bin/main.dart プロジェクトのルートでの dart run bin/main.dart。プロジェクトが build_runner を使っていれば先にビルドする
dart test プロジェクト全体の dart test (Flutter アプリでは flutter test)

Debug タブにはまだ既製の Dart のシナリオはありませんが、Dart のデバッグアダプターはあります。プロジェクトの .zed/debug.json のシナリオで Dart のプログラムをデバッグできます。

{
  "label": "Dart: bin/main.dart",
  "adapter": "Dart",
  "type": "dart",
  "request": "launch",
  "program": "bin/main.dart"
}

ホットリロードとホットリスタート

Flutter: run on ... タスクでは、アプリの lib/ の下の .dart ファイルを保存するとホットリロードされます。200 ms 以内の複数の保存は一回のリロードになります。ランナーは flutter run に --pid-file を与え、ホットリロードのための Flutter 自身のシグナルである SIGUSR1 を送るので、ターミナルは Flutter のままで、r、R、q は通常どおり動きます。build_runner watch が lib/ の下の .dart ファイルを書き直したときも、アプリはリロードされます。そのようなシグナルのない Windows では動きません。そこでは r を押してください。

dart run: <file> タスクでは (Dart VM 上のサーバーや CLI)、プログラムは VM サービスを有効にして動きます。そのパッケージの .dart ファイル、または lib/resources/ の下のファイルを保存するとホットリロードされ、ターミナルには次のような行が表示されます。

↻ Reloaded in 55 ms

Spring Boot for Dart のアプリケーション (spring_boot_dart 0.3.2 以降) は、新しい @GetMapping や別の server.port のように、その Bean、アノテーション、設定ファイルが変わった場合は自分で再起動し、そうでなければ Spring Boot DevTools のように、新しいメソッドの本体で動き続けます。Flutter 側については ホットリロード を参照してください。コンパイルエラーは、2 秒後もコードがまだコンパイルできない場合にだけ表示されるので、古い生成コードは報告されません。Ctrl+C でプログラムが止まります。

デバッガーの下では (Flutter: debug on ... のシナリオ、または Flutter アダプターのための独自のもの):

行うこと 起きること
lib/ の下の .dart ファイルを保存する ホットリロード: 新しいコードが動き、アプリは状態を保つ
デバッグパネルの Restart ホットリスタート: アプリは再ビルドなしで最初からやり直す
Stop アプリが終了する

ブレークポイント、ステップ実行、変数、デバッグコンソールは Flutter 自身のデバッガーのものです。自動保存を有効にすると ("autosave": {"after_delay": {"milliseconds": 1000}})、入力をやめた一秒後にアプリがリロードされます。

拡張機能はキーバインドを追加できません。キーボードからホットリスタートするには、これをキーマップ (zed: open keymap file) に追加します。ファイルを保存してから、アプリを再起動します。

[
  {
    "context": "Editor",
    "bindings": {
      "cmd-alt-s": ["action::Sequence", ["workspace::Save", "debugger::Restart"]],
      "ctrl-alt-s": ["action::Sequence", ["workspace::Save", "debugger::Restart"]]
    }
  }
]

デバッグのオプション

プロジェクトの .zed/debug.json での、Flutter アダプターのための独自のシナリオ:

{
  "label": "Flutter: Android (dev)",
  "adapter": "Flutter",
  "request": "launch",
  "program": "lib/main_dev.dart",
  "target": "android",
  "toolArgs": ["--flavor", "dev"]
}
フィールド デフォルト 意味
target なし ios-simulator、android、web、macos、windows、linux: その種類のデバイス。上記のとおりに選ばれる
deviceId Flutter の選択 ID による一つのデバイス (flutter devices)。target より優先される
program lib/main.dart エントリーポイント。cwd からの相対
cwd プロジェクトのルート Flutter プロジェクトのフォルダー (モノレポではアプリのフォルダー)
flutterMode debug debug、profile、release。リロードとリスタートには debug が必要
args [] アプリの引数
toolArgs [] flutter run の引数: --flavor dev、--dart-define=K=V
env {} Flutter の環境変数
hotReloadOnSave true false では Restart でだけリロードする
devTools true false: このアプリには DevTools なし
useFvm .fvmrc があれば true、なければ false fvm を通して Flutter を実行する
request launch attach は vmServiceUri とともに、動いているアプリにアタッチする

Flutter DevTools

DevTools は、デバッガーの下で動いているアプリで動きます。

  1. Debug タブでアプリを起動します: Flutter: debug on <platform>。
  2. Run タブから、次のタスクのいずれかで DevTools を開きます。
タスク 表示するもの
Flutter DevTools: Widget Inspector ライブのウィジェットツリーと、各ウィジェットのプロパティとレイアウト
Flutter DevTools: Performance フレームの時間、ジャンク、再ビルド、タイムライン
Flutter DevTools: CPU Profiler 関数ごとの時間の使い道
Flutter DevTools: Memory ヒープ、割り当て、リーク
Flutter DevTools: Network HTTP リクエストとその応答
Flutter DevTools: Logging log() の呼び出しを含むログと、フレームワークのイベント

ページは Zed の隣の独自のウィンドウで開きます。アプリモード (タブなし、アドレスバーなし) の Chrome、Edge、Chromium、またはデフォルトのブラウザーです。すべてのページがそのウィンドウのタブなので、一つのタスクですべてに到達できます。デバッグコンソールにも DevTools のアドレスが表示されます。

ウィジェットを選択すると、そのコードが Zed で開きます。インスペクターのツリーでのクリック、または Select Widget Mode を有効にしてアプリのウィジェットをタップすることです。これには Zed のコマンドラインツール zed が必要です。macOS ではコマンドパレットから cli: install を実行し、それ以外では PATH 上になければなりません。

DevTools は Web アプリで、Zed の拡張機能は Web ページを表示することも独自のパネルを描画することもできません。Zed がそれをできるようになるまで、DevTools はその隣のウィンドウに住みます。

バックグラウンドの build_runner

プロジェクトの pubspec.yaml の dev_dependencies に build_runner がある場合 (ワークスペースのフォルダーと、その下の 4 レベルまでのパッケージ。モノレポの example/flutter_app など)、拡張機能の言語サーバーは、プロジェクトを開いたときにそこで一度 dart run build_runner watch --delete-conflicting-outputs を起動します。Zed がサーバーを閉じると watch を止めます。

pub ワークスペース (build_runner 2.14 以降) では、一つの watch がすべてのメンバーをビルドします。pubspec.yaml、pubspec.lock、.dart_tool/package_config.json が変わると、watch は再び起動します。手での build のような別の build_runner のコマンドは、watch にそのロックを求めます。30 秒後もまだロックを持っている watch は再起動されるので、コマンドが永遠に待つことはありません。

ビルドの Succeeded や Failed の各行は、Zed のメッセージとして表示されます。出力の全体は dev: open language server logs の flutter-tools の下にあります。

スニペット

プレフィックスを入力し、補完のメニューからスニペットを選びます。メニューは入力したもので始まるスニペットだけを表示し、{、(、. の後では何も表示しません。Ctrl-Space ですべてを列挙します。Tab で次のフィールドに移動します。複数回現れるフィールドはすべての場所で同時に編集されます。決まった値の集合を持つフィールド (MainAxisAlignment.start、BoxFit.cover) はそれらをリストとして提供します。デフォルトのままなら、参照する名前が存在すればコードはコンパイルできます。

プレフィックスはほとんどが単語の頭文字です。sfp はパラメーター (parameter) を持つステートフル (stateful) ウィジェット、lvb は ListView.builder、ftb は FutureBuilder です。

スニペットを選ぶと、ファイルにそれを持ち込むインポートがない場合、必要なインポートも追加されます。インポートのないファイルで ftb と入力すると、次のものが挿入されます。

FutureBuilder<String>(
  future: future,
  builder: (context, snapshot) {
    if (snapshot.hasError) {
      return Text('${snapshot.error}');
    }
    if (!snapshot.hasData) {
      return const Center(child: CircularProgressIndicator());
    }
    final data = snapshot.requireData;
    return Text('$data');
  },
)

そして先頭に import 'package:flutter/material.dart'; が追加されます。そのため、スニペットは Zed のスニペットファイルではなく、拡張機能の言語サーバーから来ます。Zed のスニペットはカーソルの位置にしか挿入できないからです。

Dart の言語サーバーは独自のスニペットを持っているので、これらはそれを繰り返しません: stless、stful、stanim、class、main、fun、for、forin、if、ife、switch、try、while、do、test、group。

ロギングと非同期

プレフィックス 挿入されるもの インポート
log デバッグコンソールと DevTools に表示される log() dart:developer
loge エラーとそのスタックトレースの log() dart:developer
logd デバッグビルドでだけ出力される debugPrint() flutter/foundation.dart
pr print()
tm Timer を開始する dart:async
tmp 周期的な Timer を開始する dart:async
cpl Completer を生成する dart:async
sctrl ブロードキャストの StreamController のフィールド dart:async

アプリとウィジェットのクラス

プレフィックス 挿入されるもの
mapp ホーム画面を持つ MaterialApp
capp ホーム画面を持つ CupertinoApp
mna runApp の前にバインディングを初期化する main()
thd シードカラーからの Material 3 の ThemeData
slc 子を包む StatelessWidget
sfp widget. を通して読むフィールドを持つ StatefulWidget
inh of() と maybeOf() を持つ InheritedWidget
cn 通知するフィールドを一つ持つ ChangeNotifier
cpt CustomPainter
ccl CustomClipper<Path>

State のメンバー

プレフィックス 挿入されるもの
ins、ds、dcd、duw、dea、bld initState、dispose、didChangeDependencies、didUpdateWidget、deactivate、build のオーバーライド
ac AnimationController (State には TickerProvider の mixin が必要)
tc、sc、fn TextEditingController、ScrollController、FocusNode
fk GlobalKey<FormState>
gt、st ゲッター、セッター

文

プレフィックス 挿入されるもの
ss setState を呼ぶ
ifm、ifcm State や BuildContext がもうマウントされていなければ止める (await の後)
np、npn、npr、npa MaterialPageRoute をプッシュ、名前付きルートをプッシュ、ルートを置き換え、プッシュして他のすべてを取り除く
npo、npu 現在のルートをポップ、最初のルートまでポップ
sd キャンセルと確認のアクションを持つ AlertDialog を表示する
sbs モーダルなボトムシートを表示する
ssb ScaffoldMessenger を通して SnackBar を表示する
pfc 現在のフレームの後にコードを実行する
fd ある期間待つ
tcf catch と finally を持つ try
uf キーボードを閉じる
ifc パターンに一致させる
fid インデックスとともにリストをループする

レイアウト

プレフィックス 挿入されるもの
scf AppBar を持つ Scaffold
ab アクションを持つ AppBar
col、row、stk、pos Column、Row、Stack、Positioned の子
cen、al Center、Align
pd、pds 全辺のパディング、水平と垂直のパディング
sbh、sbw、sbx 垂直の空白、水平の空白、子を持つ SizedBox
ct、dct Container、角の丸い BoxDecoration を持つ Container
ex、fx Expanded、Flexible
wr、sa Wrap、SafeArea
crr 角を丸くクリップする
cd、lt、dv パディングを持つ Card、ListTile、Divider
cpi 中央に置かれたプログレスインジケーター
vis 子を条件付きで表示する

スクロール

プレフィックス 挿入されるもの
lv、lvb、lvs 子の ListView、遅延して組み立てられるもの、区切り付きのもの
gvb、gvc 遅延して組み立てられるグリッド、固定の列数を持つ子のグリッド
scv スクロールできる Column
csv アプリバーとリストを持つ CustomScrollView
slb、sla、slp 遅延して組み立てられるスリバーのリスト、CustomScrollView の中のボックスのウィジェット、スリバーの周りのパディング
ri 引っ張って更新
pvb 遅延して組み立てられる PageView
dtc TabBar と TabBarView を持つ DefaultTabController

ビルダー

プレフィックス 挿入されるもの
bd 新しい BuildContext のための Builder
lb 親の制約から組み立てる
ftb、stb 読み込み中とエラーの状態を持つ、Future から、Stream から組み立てるもの
vlb、lnb、anb ValueListenable が変わったとき、Listenable が通知したとき、アニメーションのティックごとに再ビルドする

コンテンツ、入力、アニメーション

プレフィックス 挿入されるもの
tx、rt テーマのスタイルを持つ Text、複数のスタイルを持つテキスト
ic Icon
img、imgn アセットからの画像、読み込み中とエラーの状態を持つネットワークからの画像
hr Hero アニメーション
gd、iw タップの検出、リップル付きのタップできる領域
eb、flb、ob、tb、ib、fab Elevated、Filled、Outlined、Text、Icon、FloatingAction のボタン
tf、tff、frm コントローラーを持つ TextField、バリデーターを持つ TextFormField、送信ボタンを持つ Form
cbt、swt、sl、dd ラベル付きのチェックボックス、ラベル付きのスイッチ、Slider、DropdownButton
anc、ano、ans 変更をアニメーションする Container、子のフェードインとフェードアウト、子の間のアニメーション

テーマ、Dart、テスト

プレフィックス 挿入されるもの
mqs、th、tt、cs 画面のサイズ、テーマ、テキストテーマ、カラースキーム
imm、imc、imw、ims、ima material、cupertino、widgets、services、dart:async のインポート
mdl copyWith、JSON、等価性、toString を持つイミュータブルなクラス
en、sld、ext、mx フィールドを持つ enum、二つのサブクラスを持つ sealed クラス、拡張、mixin
sgl、td 単一のインスタンスを持つクラス、型エイリアス
fa、fs Future を返す関数、Stream を生成する関数
todo TODO のコメント
tw ウィジェットテスト
su、tdn、sua 各テストの前、各テストの後、すべてのテストの前に一度実行する
tp、et、ef ウィジェットをタップして落ち着かせる、テキストフィールドに入力する、ウィジェットが見つかることを期待する

ドキュメントコメントの中のコード

/// コメントのフェンス付きのコードブロックはコードとしてハイライトされ、コメントの残りはコメントのままです。

/// Returns the basket's total.
///
/// ```dart
/// final total = basket.total(); // Dart としてハイライトされる
/// ```
double total() => ...

言語のないフェンスは、dartdoc が読むのと同じく Dart とみなされます。java、rust、javascript、typescript、python という名前のフェンスはその言語でハイライトされます。Java には Zed の Java の拡張機能のインストールが必要です。その他の言語はコメントのままです。例は独自のスタイル (keyword.dartdoc など) を受け取るので、テーマはそれらを区別できます。Farum Azula Themes は暗めの色でそれらを表示します。例のクラスはアウトラインに入らず、その main() は実行ボタンを受け取りません。

設定

設定 場所 効果
"lsp": { "flutter-tools": { "initialization_options": { "build_runner": false } } } Zed の settings.json バックグラウンドの build_runner watch なし
FLUTTER_TOOLS_BUILD_RUNNER=off Zed の環境変数 同上
FLUTTER_TOOLS_HOT_RELOAD_ON_SAVE=off Zed の環境変数 実行のタスクで保存時のホットリロードなし。dart run: タスクは素の dart run を使う
FLUTTER_TOOLS_BUILD_RUNNER_YIELD_MS Zed の環境変数 別のコマンドが求めた後、watch がビルドのロックを保持してよい時間。デフォルトは 30000
"lsp": { "dart": ... } Zed の settings.json Zed の Dart の拡張機能と同じく、Dart の言語サーバーの設定

Dart をセマンティックハイライトするには、"languages": { "Dart": { "semantic_tokens": "combined" } } を設定します。すると拡張機能のルールが、アノテーションと宣言された変数には tree-sitter の色を見せ、コンストラクターで指定されたフィールド (this._scope) をフィールドとして色付けし、Spring for Dart の拡張機能がインストールされていれば、クロージャーのパラメーターを variable.parameter.closure で色付けします。

トラブルシューティング

インストールが失敗する、または Dart が二度定義される。 Zed の Dart の拡張機能がまだインストールされています。Extensions ページでそれをアンインストールし、auto_install_extensions に "dart": true があれば取り除いてください。

Flutter: debug on <platform> が Debug タブにない。 Flutter: run on <platform> を実行した後、Zed は再起動するまでそのシナリオをリストから外します。他のプラットフォームは残ります。

DevTools のタスクが何も開かない。 Debug タブから起動したアプリが必要です。Flutter: run on ... で起動したアプリにはここでは DevTools がありません。代わりに flutter run がそのターミナルに DevTools のリンクを表示します。

ウィジェットを選択してもファイルが開かない。 Zed のコマンドラインツールをインストールしてください。macOS では cli: install、または zed を PATH に置いてください。

Windows の実行のタスクで保存時のホットリロードがない。 Windows には SIGUSR1 がありません。ターミナルで r を押すか、Debug タブを使ってください。

"Waiting for already-running build_runner"。 バックグラウンドの watch がロックを持っています。30 秒以内にそれを手放します。watch を無効にするには、設定 を参照してください。

リンク