1. JSSアプリケーションの開発

JSSアプリ初期化子

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

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

Sitecore JavaScriptレンダリングSDK (JSS) は、一般的なJavaScriptフレームワークとアプリケーション アドオン用のアプリ初期化スクリプトとJSSアプリケーション テンプレートを含むcreate-sitecore-jssパッケージを提供します。

JSS初期化子を使用するには、ターミナルで次のいずれかのコマンドを実行します。

npx create-sitecore-jss
npm init sitecore-jss
yarn create sitecore-jss
大事な

引数を指定するには、npxコマンドを使用します。

JSS初期化子コマンドを使用する場合は、latest JSSバージョンを使用してJSSアプリケーションを作成します。これには、新しいバージョンのプラットフォームでのみ使用できる機能が含まれる場合があります。

したがって、Sitecoreバージョンと互換性のあるJSSバージョンを特定し 、JSS初期化子にバージョン タグを提供する必要があります。たとえば、npx create-sitecore-jss@ver20のようになります。

必須の引数

初期化子を使用してJSSアプリケーションを作成する場合は、プロンプトに従って、アプリケーションに必要な設定に関する情報を提供できます。

または、次の引数を使用してその値をフラグとして渡すことで、任意のプロンプトをオーバーライドできます。

引数

種類

形容

templates

string

JSSアプリケーションのスキャフォールディングに使用するテンプレート名のカンマ区切りリスト。 これには、基本アプリケーション テンプレートの名前 ( nextjsなど) や、任意の数の アドオン テンプレート ( nextjs-styleguideなど) を含めることができます。

たとえば、npx create-sitecore-jss --templates nextjs,nextjs-styleguide.

また、位置引数 ( npx create-sitecore-jss nextjs,nextjs-styleguide.

appName

string

JSSアプリケーションの名前。

デフォルト: sitecore-jss-app。

destination

string

アプリケーションのパス/ディレクトリ。空でないディレクトリ パスを指定すると、初期化子は既存のファイルに対する潜在的な変更を示します。また、変更を処理するためのオプション (現在のファイルへの変更を承認する、ファイルをスキップする、すべてのファイルに対する変更を承認する、または中止する) も用意されています。空でないデスティネーションで初期化子を使用すると、既存のJSSプロジェクトにアドオンテンプレートを適用する場合に便利です。

デフォルト: <current-directory-path>/<base-template-name>。

fetchWith

string

データを取得する方法。 RESTまたはGraphQLを選択します。

デフォルト: GraphQL。

prerender

string

nextjsテンプレートを使用している場合にのみ使用できます。アプリケーションのプリレンダリング方法。静的サイト生成 (SSG) とサーバーサイドレンダリング (SSR) のどちらかを選択します。

デフォルト: SSG。

language

string

nextjs-styleguideアドオンを使用している場合にのみ有効です。言語とロケールのコード。たとえば、es-MX.

デフォルト: da-DK。

hostName

string

Sitecoreインスタンスのホスト名。

デフォルト: <app-name>.dev.local。

たとえば、templates、appName、およびfetchWithプロンプトをスキップする場合は、次のコマンドを実行できます。

npx create-sitecore-jss --templates nextjs --appName my-nextjs-app --fetchWith GraphQL

次のように位置引数を使用してコマンドを短縮できます。

npx create-sitecore-jss nextjs --appName my-nextjs-app --fetchWith GraphQL

オプションの引数

必須の引数に加えて、JSS初期化子は次の省略可能なパラメーターを受け入れます。

引数

種類

形容

appPrefix

boolean

存在する場合、アプリケーションは次のことを行います。

  • appName引数を使用してテンプレートにプレフィックスを付け、Sitecoreにデプロイするときに各テンプレートに一意の名前が付けられるようにします。同じ名前の複数のテンプレートは、名前の競合により、厳密に型指定されたGraphQLクエリを使用するとエラーが発生します。

  • appName引数を使用して、プレースホルダーをプレフィックスとして付けます。プレフィックス付きプレースホルダーを使用する場合、Sitecoreに複数のJSSアプリがデプロイされている場合、プレースホルダーにコンポーネントを挿入するためのSitecoreインターフェイスには、現在のサイトのコンポーネントのみが表示されます。

force

boolean

指定した場合、ファイル・システムの操作に関連する質問が抑制され、初期化子はデフォルトのアクションを実行します。

silent

boolean

指定した場合、ログ・メッセージを抑止します。

使い： npx create-sitecore-jss --silent

yes

boolean

指定した場合、CLI引数値に関連する質問は抑制され、初期化子はデフォルト値を使用します。

基本テンプレート

プロジェクトを作成するときは、位置引数を使用するか、--templatesフラグを使用してone base template nameを提供できます。

npx create-sitecore-jss <base-template-name>

又は：

npx create-sitecore-jss --templates <base-template-name>

利用可能なbase template namesは次のとおりです。

  • nextjs.

  • react.

  • angular.

  • vue.

  • react-native.

  • node-headless-ssr-experience-edge.

  • node-headless-ssr-proxy.

アドオンテンプレート

プロジェクトを作成するときは、基本テンプレート名に加えて、位置指定引数または--templatesフラグを使用してmultiple add-on template namesを指定することもできます。

npx create-sitecore-jss <base-template-name>,<first-add-on-template-name>,<second-add-on-template-name>

又は：

npx create-sitecore-jss --templates <base-template-name>,<first-add-on-template-name>,<second-add-on-template-name>

利用可能なadd-on template namesは次のとおりです。

  • nextjs-styleguide - サンプルコンポーネントと 、切断された状態での作業のセットアップが含まれています。

  • nextjs-sxa - JSS SXAヘッドレス コンポーネントが含まれています。このアドオン テンプレートは、Sitecore Experience Manager Cloud (XM Cloud) コンテンツ管理インスタンスとのみ互換性があります。

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