Skip to Content
コード管理CLIコマンドbm preview view

bm preview view

設定ファイルに定義したビューを保存せずに、開発環境のベースマキナの画面で表示するコマンドです。

bm preview viewを使うと、ビューをbm syncで反映しなくても、設定ファイルに書いた内容のまま表示を確認できます。コードエディターのビューとビジュアルエディターのビューの両方に対応しています。表示先は開発環境に固定されており、他の環境を指定する手段はありません。

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

設定ファイルのアクションを実行するには、「アクション管理」「実行権限設定」「レビュー設定の設定」の管理権限が必要です。権限がなければ画面上部に警告が表示されますが、保存済みのアクションと表示は確認できます。

使い方

実行するとブラウザでベースマキナの画面が開き、ビューが表示されます。設定ファイルを保存し直すと、表示は自動で読み込み直されます。コマンドはCtrl+Cを押すまで動き続けます。

# 設定ファイルのビューを一覧で開く
bm preview view
 
# id が「user-list」のビューを表示する
bm preview view user-list
 
# 設定ファイルのパスを指定する
bm preview view user-list --config apps/admin/basemachina.config.ts

オプション

オプションデフォルト値説明
第1引数（一覧を開く）表示するビューのID。省略すると一覧画面が開く
--config <path>basemachina.config.ts設定ファイルのパス

ビューから呼び出すアクションの扱い

次の方法でアクションを実行すると、設定ファイルに同じIDのアクションがある場合は、保存済みのアクションではなく設定ファイルに書いた内容で開発環境に対して実行します。設定ファイルにない場合は、開発環境に保存済みのアクションを実行します。

createActionJob、getActionJobResult（非同期ジョブ）と、createReviewRequest（レビュー依頼）は、プレビューでは使えません。呼び出すとエラーのトーストが表示されます。保存済みのアクションに対しても同じです。

openActionLink、openViewLink、ビジュアルエディタービューのアクションやビューへのリンクのセル、実行成功後の画面の移動では、プレビュー中はページを移動せず、移動先がトーストで表示されます。

useCheckActionAvailabilityは、本番と同じ答えを返します。プレビューで使えない機能のアクションも「使える」と返ることがあります。

bm preview actionと同じく、設定ファイルでreviewSettingIdを指定したアクションもレビューを経由せずに開発環境で実行され、書き込みを伴うアクションでは開発環境のデータがその場で変わります。実行の直前には警告のトーストが表示されます。設定ファイルにない保存済みのアクションはビューを保存したときと同じ扱いになり、開発環境でレビューが必要なアクションは実行できません。

bm preview actionbm beta preview action