1. Visual Studio Code を使用して新しい共有スクリプトを作成する方法

Visual Studio Code を使用して共有スクリプトを作成する方法

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

共有スクリプトを使用すると、よく使用されるコードを個別のスクリプトに維持して再利用でき、任意のタイプの 1 つ以上のスクリプトから参照できます。

前提条件

作業フォルダの初期化

まず、Visual Studio Code で Intellisense をサポートするために必要なファイルを使用して、作業フォルダーを初期化します。作業フォルダには、任意のフォルダを選択することができます。

次のコマンドを実行します。

ch-cli scripting initialize -f <your-folder-path>

初期化後は、作業フォルダに次のファイルが含まれます。

[working folder]
├── omnisharp.json
├── references.json
├── lib
   ├── Newtonsoft.Json.dll
   ├── Remotion.Linq.dll
   ├── Stylelabs.M.Scripting.Types.dll
   ├── Stylelabs.M.Sdk.dll
   ├── Stylelabs.M.Sdk.Fluent.dll
   ├── Stylelabs.M.Sdk.ScriptClient.dll
   └── Stylelabs.Scripting.dll
├── references
   ├── Action.csx
   ├── Base.csx
   ├── MediaProcessing.csx
   ├── Shared.csx
   ├── UserPostRegistration.csx
   ├── UserPreRegistration.csx
   ├── UserSignIn.csx 
注意

作業フォルダ内のファイルは、インスタンスが接続している Content Hub のバージョンによって異なる場合があります。

共有スクリプトの作成

  1. Visual Studio Code で作業フォルダーを開きます。
  2. 作業フォルダーのルートで、拡張子 .csx を持つ新しいファイルを作成します。ファイル名はスクリプト名になります。
  3. ファイルを開き、次のヘッダーを追加します。

    #load "./references/Shared.csx"
    /**------------ Include above to support intellisense on Content Hub types in editor ----------------**/
    // Script Start
    重要

    スクリプト タイプは、スクリプトのヘッダーによって決定されます。ヘッダーのすべての行が必要です。

  4. ファイルを保存します。これで、Intellisense が使用できるようになります。

  5. Watcher スクリプトを起動します。

    次のコマンドを実行します。

    ch-cli scripting watch -f <your-folder-path>
    注意

    このコマンドは、Visual Studio Code ターミナルから実行できます。

    これで、接続している Content Hub インスタンスで共有スクリプトが作成されます。

  6. スクリプトで作業します。

    注意

    スクリプトを保存するたびに、Watcher スクリプトがスクリプトをコンパイルしてパブリッシュします。

  7. 共有スクリプトを有効にします。

    次のコマンドを実行します。

    ch-cli scripting enable -n <your-script-name>

他のスクリプトからの共有スクリプトの参照

共有スクリプトは、その名前を使用して参照します。次に例を示します。

#load "./references/Action.csx"
/**------------ Include above to support intellisense on Content Hub types in editor --------------**/
// Script Start

#load "my-shared-script.csx"

...

共有スクリプトの作成についての説明は以上です。

この記事を改善するための提案がある場合は、 お知らせください!