コード管理
CLIコマンド
bm beta preview action

bm beta preview action

設定ファイルに定義したアクションを保存せずに開発環境で実行し、結果を確認するコマンドです。

⚠️

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

bm beta preview actionを使うと、アクションをbm syncで反映しなくても、設定ファイルに書いた内容のまま実行結果を確認できます。実行先は開発環境に固定されており、他の環境を指定する手段はありません。

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

# 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 beta preview action fetch-users --force

オプション

オプションデフォルト値説明
第1引数(必須)実行するアクションのID
--config <path>basemachina.config.ts設定ファイルのパス
--args <json>{}アクションに渡す引数(JSONオブジェクトの文字列)
--force(実行しない)レビュー設定を無視して実行する

レビュー設定の扱い

reviewSettingIdを指定したアクションでも、bm beta preview actionはレビューを経由せずそのまま実行します。書き込みを伴うアクションなら、開発環境のデータはその場で変わります。そのため--forceがなければ実行せず、警告を表示して終了します。--forceを指定した場合は、同じ警告を表示してから実行します。

呼び出し先のアクションの扱い

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

実行できないアクション

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