JSSアプリ初期化子

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

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

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

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

RequestResponse
npx create-sitecore-jss

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

必須の引数

初期化子を使用して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プロンプトをスキップする場合は、次のコマンドを実行できます。

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

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

RequestResponse
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

prePushHook

boolean

指定した場合、TypeScriptのタイプとコードの書式設定の有効性をチェックするlintスクリプトを実行します。

yes

boolean

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

基本テンプレート

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

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

又は：

RequestResponse
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を指定することもできます。

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

又は：

RequestResponse
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-styleguide-tracking- Sitecore Experience Platform (XP) インスタンスに対して実行されるアプリケーションの追跡コンポーネントの例が含まれています。nextjs-styleguideアドオンが必要です。これは、nextjs-personalizeアドオンまたはSitecore Experience Manager (XM) Cloudコンテンツ管理インスタンスでnot compatibleされます。

  • nextjs-personalize- XM Cloud Embedded Personalizationを使用したプロジェクトの例が含まれています。このアドオンはonly compatible with XM Cloudです。nextjs-styleguide-trackingアドオンとnot compatibleされます。

  • nextjs-sxa - ヘッドレスSXAプロジェクトのサンプル コンポーネントとセットアップが含まれています。

  • nextjs-multisite - 1つのNext.jsアプリケーションから複数のサイトをホストするための設定例が含まれています。

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、