CLI コマンド リファレンス
この記事では、Microsoft Dynamics 365 Commerce オンライン ソフトウェア開発キット (SDK) にあるコマンドライン インターフェイス (CLI) コマンドについて説明します。
次のすべてのコマンドは、Yarn を使用して実行する必要があります。 それらはすべて次の構造を持っています。
yarn {msdyn365} {command} {command-arguments}
各コマンドについては、この記事のエントリを参照するか、または yarn --help または yarn msdyn365 {command} --help コマンドを使用してください。
開始
用途
yarn start <--verbose>
このコマンドは、.env ファイルで定義されたポートを使用して、Node サーバーを構築して起動します。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn start
yarn start --verbose
build
用途
yarn build <--verbose>
このコマンドはカスタマイズ コード上の完全なビルドを実行します。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn build
yarn build --verbose
追加のコンポーネント オーバーライド
用途
yarn msdyn365 add-component-override <themeName> <componentName> <--list-components> <--verbose>
このコマンドにより、指定したテーマ コンポーネント フォルダーにコンポーネントが追加されます。 その後、そのフォルダから必要に応じてコンポーネントを変更できます。
- --list-components オプションでは、コンポーネントの一覧を表示するために使用されます。
- --verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 add-component-override spring-theme add-to-cart.component
yarn msdyn365 add-component-override --list-components
追加のデータ アクション
用途
yarn msdyn365 add-data-action <action-name> <--verbose>
このコマンドは、テンプレート データ アクションをルート/src/アクション フォルダーに追加します。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 add-data-action getMyData --verbose
追加のモジュール
用途
yarn msdyn365 add-module <module-name> <--verbose>
このコマンドは、モジュールをルート/src/モジュール フォルダーに追加します。 モジュール名は大文字と小文字を区別しません。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 add-module product-feature --verbose
追加のテーマ
用途
yarn msdyn365 add-theme <theme-name> <--verbose>
このコマンドは、テーマをルート/src/テーマ フォルダーに追加します。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 add-theme spring-theme --verbose
追加の表示拡張機能
用途
yarn msdyn365 add-view-extension <theme-name> <Module-name> <--verbose>
このコマンドは、モジュール表示拡張機能をルート/src/テーマ/<テーマ名>/表示フォルダーに追加します。 その後、テーマは、コンフィギュレーション、リソース、およびスロットなどのモジュール定義の項目をさらに追加できます。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 add-view-extension spring-theme product-feature --verbose
クローン
用途
yarn msdyn365 clone <module-library-module-name> <new-module-name> <--verbose>
このコマンドは、モジュール ライブラリ モジュールの名前を変更したコピーが作成され、ソース コードがローカル ルート/src/モジュール フォルダーに追加されます。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 clone content-block super-content-block --verbose
作成要求のフック
用途
yarn msdyn365 create-request-hook <--verbose>
このコマンドでは、要求パイプラインのプラグイン フックを作成します (src/requestHooks/initialRequest.hook.ts)。 要求パイプラインのプラグイン フック ファイルでは能力を提供し、Node サーバー上でルート/src/モジュールフォルダーに送信されたレンダリング要求をインターセプトします。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 create-request-hook --verbose
最適化モジュールの css
用途
yarn msdyn365 optimize-module-css <themeName> --requiredStyles=<requiredStylesFolder> --componentStyles=<componentStylesFolder> --assetFiles=<assetFiles> --assetVar=<assetVar>
このコマンドは、必要なファイル構造を作成することで、モジュール CSS 最適化特徴のスタイルを最適化します。 スタイルは引き続き、特定のモジュールの個々の <MODULE_NAME.scss> ファイル内で更新する必要があります。
- --requiredStyles オプションは、必要/抽象的なスタイルのフォルダー名を指定するために必要とされます。
- --componentStyles オプションは、コンポーネント スタイルのフォルダー名を指定するために使用されます。
- --assetFiles オプションは、スタイル資産が使用されているファイル名を指定するために使用されます。
- --assetVar オプションは、
$文字を使用せずにパスを資産ファイルに説明する変数名を指定するために使用されます。
例
yarn msdyn365 optimize-module-css adventureWorks --requiredStyles=00-settings,01-tools,02-generic --componentStyles=03-components --assetFiles=icons.scss --assetVar=msv-font-path
梱包
用途
yarn msdyn365 pack <--verbose>
このコマンドでは、ローカル サイト コンフィギュレーション (モジュール、データ アクション、テーマなど) のパッケージが作成されます。 このパッケージは、Microsoft Dynamics Lifecycle Services (LCS) を使用して、Node サーバーにアップロードされます。 このコマンドは、ローカル SDK ファイルのルート ディレクトリから実行する必要があります。
出力は、コマンドが実行されたディレクトリの ZIP ファイルです。 ファイル名は、SDK package.json ファイルで表示された名前とバージョンを使用して作成されます。 たとえば、ZIP ファイルは @msdyn365-commerce-partners-fabrikam-1.2.73.zip と呼ばれるかもしれません。
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
例
yarn msdyn365 pack --verbose
パッケージ
用途
yarn msdyn365 packages
このコマンドは、ビルド時に生成された packageVersions.json ファイルをコンソールに印刷します。
packageVersions.json ファイルには、Dynamics 365 Commerce パッケージと Dynamics 365 Commerce モジュール パッケージ、そのバージョン、および使用されたバージョンの決定方法に関する情報が含まれています。
例
yarn msdyn365 packages
プレビュー
用途
yarn msdyn365 pack --preview
このコマンドは、最新の SDK プレビュー バージョンを含むパッケージを作成し、SDK バージョン 1.41.10-preview.0 以降で使用できます。
更新バージョン
用途
yarn msdyn365 update-versions <entity>
このコマンドは、エンティティ (SDK、モジュール ライブラリ、または小売プロキシ) のバージョンが最新リリースに更新されます。
例
yarn msdyn365 update-versions module-library
yarn msdyn365 update-versions retail-proxy
yarn msdyn365 update-versions sdk
--verbose オプションでは、コマンド プロンプト ウィンドウでより詳細なデバッグ アウトプットを提供するために使用されます。
検証
用途
yarn msdyn365 validate <path/to/directory>
このコマンドは、パッケージおよびパッケージ内のモジュールに対して一連の検証チェックを実行します。 具体的には、各モジュールが有効な定義 .json ファイルを持っている必要があります。
パスは、package.json ファイルを含むパッケージ フォルダの完全なパスです。
例
yarn msdyn365 validate ./