💡

Content Hub CLIを利用して、Visual Studio CodeでScriptを開発する

2022/06/28に公開

以前ご紹介した、Content Hub CLIがバージョンアップし、利用できる機能が増えました。その中の機能を利用して、ScriptをVisual Studio Codeで開発できるようになったのでその手順をご紹介します。

今回利用する環境

  • Windows10
  • Content CLI 1.1.1

Content Hub CLIのインストール

以下のサイトより Content Hub CLIをインストールしてください。
https://docs.stylelabs.com/contenthub/3.5.x/content/integrations/integration-tools/cli/get-started/overview.html

インストール完了後、以下のコマンドを実行し、バージョンが1.0.x以上であることを確認してください。

ch-cli --version

エンドポイントの作成

以下記事の「エンドポイントの作成」を参考にしてください。
https://zenn.dev/taito_fujii/articles/15c15cd1dd13dd

エンドポイントの作成までできると準備完了です。

initialize コマンドでワークスペースを初期化する

ch-cli scripting initialize 

実行が成功すると、下記のファイル郡が作成されます。

pull コマンドを実行して、ローカルにスクリプトファイルを配置する

次は対象のインスタンスから、Scriptを指定してローカルに保存するためPullコマンドを実行します。pullのあとにはスクリプト名を指定する必要があり、今回はデフォルトで設定されているCMP - "M.Content - impact"を取得します。具体的には以下のコマンドになります。

ch-cli scripting pull -n "CMP - M.Content - impact"

実行結果は以下の通り

エクスプローラ上に、csxファイルが配置されます。これが対象のインスタンスのスクリプトファイルにないります。

push コマンドを実行して、インスタンスに変更したスクリプトを反映する

任意のコードを変更して以下のコマンドを実行します。
今回は、4行目にコメントを記載して実際にインスタンス上で反映するかを確認します。

ch-cli scripting push -n "CMP - M.Content - impact"

コンパイルが成功し、インスタンスに反映されました。

UI確認

以下の画像の通り、Visual Studio Codeで編集したソースコードが反映されていることがわかります。今回は、Publish前の状態のPushとしましたが、パラメータ(-p true)をつけることで、即時にPublishすることも可能です。

このように、通常の開発スタイルと同様になるため、従来はUI上でのコーディング比較して開発が効率的になります。スクリプトを共有レポジトリで管理し、個別の環境に適用するなどの開発の標準化も期待できます。

今後、Scriptについてのより効果的な開発方法をご紹介する予定です。

Discussion