コード管理のアクションを反映前に試せるようになりました！

ベースマキナの更新情報をお届けします。今回は、設定のコード管理で使うCLI（@basemachina/cli）にbm beta preview actionコマンドを追加しました。

bm beta preview action

設定ファイルに定義したアクションを保存せずに開発環境で実行し、結果を確認するコマンドです。CLI 1.7.0以降でご利用いただけます。

これまで設定ファイルに書いたアクションの動作を確かめるには、bm syncで開発環境に反映する必要がありました。bm beta preview actionを使うと、反映しなくても設定ファイルに書いた内容のまま実行結果を確認できます。実行してもアクションは保存されないため、開発環境のアクションやバージョンが増えることはありません。

なお、bm beta配下のコマンドは、今後の開発で仕様に互換性のない変更が入ることもあります。

使い方

アクションのIDを渡して実行します。実行先は開発環境に固定されており、他の環境を指定する手段はありません。

# id が「fetch-users」のアクションを実行する
bm beta preview action fetch-users

# 引数を渡して実行する
bm beta preview action fetch-users --args '{"userId":"1"}'

# 設定ファイルのパスを指定する
bm beta preview action fetch-users --config apps/admin/basemachina.config.ts

ローカル端末で実行する場合は、事前にbm loginでログインしてください。プロジェクトに開発環境が設定されていない場合は実行できません。

レビュー設定を指定したアクションの扱い

reviewSettingIdを指定したアクションは--forceオプションがなければ実行されず、警告を表示して終了します。

# レビュー設定を無視して実行する
bm beta preview action fetch-users --force

実行できないアクション

ファイル型のパラメーターを持つアクションは、bm beta preview actionでは実行できません。

また、プレビュー実行の対象になるのは、コマンドに渡したIDのアクション1つだけです。JavaScriptアクションのコードからexecuteActionで別のアクションを呼び出す場合、呼び出される側は設定ファイルの内容ではなく、開発環境に保存済みのアクションです。呼び出し先の変更まで確かめたい場合は、先にbm syncで開発環境に反映してください。

詳細はドキュメントの「bm beta preview action」をご参照ください。