JSSアプリの初期化器
このページの翻訳は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アプリケーションを作成する際は、アプリケーションのセットアップについての情報を提供するためにプロンプトに従うことができます。
あるいは、以下の引数を使ってフラグとしてその値を渡すことで、任意のプロンプトを上書きすることもできます。
議論
種類
概要
templates
string
JSSアプリケーションの足場を組むために使うテンプレート名のカンマ区切られたリストです。例えば、nextjsなどの基本アプリテンプレートの名前や、nextjs-styleguideなどの任意の数のアドオンテンプレートを含めることができます。
例えば、 npx create-sitecore-jss --templates nextjs,nextjs-styleguide.
また、positionalの引数( npx create-sitecore-jss nextjs,nextjs-styleguide.
appName
string
あなたのJSSアプリケーションの名前です。
デフォルト: sitecore-jss-app。
destination
string
アプリケーション用のパス/ディレクトリ。空でないディレクトリパスを提供すると、初期化器は既存ファイルの潜在的な変更を示します。また、変更の処理オプション(現在のファイルの変更を承認する、ファイルをスキップする、すべてのファイルの変更を承認する、または中止する)も提供します。初期化器を空でない宛先で使用することで、既存のJSSプロジェクトにアドオンテンプレートを適用するのに役立ちます。
デフォルト: /。
fetchWith
string
データ取得の方法。 REST か GraphQLを選びます。
デフォルト: GraphQL。
prerender
string
nextjsテンプレートを使用する場合のみ利用可能です。アプリケーションのプリレンダリング方式。静的サイト生成(SSG)とサーバー側レンダリング(SSR)のどちらかを選びます。
デフォルト: SSG。
language
string
nextjs-styleguideアドオンを使用している場合にのみ有効です。言語およびローカのコード。例えば、es-MX。
デフォルト: da-DK。
hostName
string
あなたのSitecoreインスタンスのホスト名です。
デフォルト: .dev.local。
例えば、templates、appName、fetchWithプロンプトをスキップしたい場合、次のコマンドを実行します。
npx create-sitecore-jss --templates nextjs --appName my-nextjs-app --fetchWith GraphQL
以下のようにpositional引数を使うことでコマンドを短縮できます:
npx create-sitecore-jss nextjs --appName my-nextjs-app --fetchWith GraphQL
オプション引数
必要な引数に加え、JSS初期化器は以下のオプションパラメータを受け入れます:
議論
種類
概要
appPrefix
boolean
存在する場合、そのアプリケーションは以下の通りです:
- テンプレートに接頭辞を付けるために appName 引数を使用し、Sitecoreに展開する際に各テンプレートが固有の名前を持つようにしています。同じ名前の複数のテンプレートは、強力型GraphQLクエリを使うと名前の競合によりエラーを引き起こします。
- appNameの引数を使ってプレースホルダーをプレフィックスで付けます。プレフィックスプレースホルダーを使う場合、複数のJSSアプリをSitecoreにデプロイしている場合、プレースホルダーにコンポーネントを挿入するSitecoreインターフェースは現在のサイトのコンポーネントのみを表示します。
force
boolean
提供されている場合、ファイルシステム操作に関する質問を抑制し、初期化器はデフォルトのアクションを実行します。
silent
boolean
提供されている場合はログメッセージを抑制します。
使用方法: npx create-sitecore-jss --silent
prePushHook
boolean
提供されている場合は、TypeScriptの型とコードのフォーマットの妥当性を確認するlintingスクリプトを実行します。
yes
boolean
もし提供されていれば、CLIの引数値に関する質問は抑制され、初期化器はデフォルト値を使用します。
ベーステンプレート
プロジェクトを作成する際、positional引数または--templatesフラグを使って1つのベーステンプレート名を指定することができます。
npx create-sitecore-jss
または:
npx create-sitecore-jss --templates
利用可能な 基本テンプレート名 は以下の通りです:
- nextjs.
- react.
- angular.
- vue.
- react-native.
- node-headless-ssr-experience-edge.
- node-headless-ssr-proxy.
アドオンテンプレート
プロジェクトを作成する際、ベーステンプレート名に加えて、positional引数や--templatesフラグを使って複数のアドオンテンプレート名を指定することもできます。
npx create-sitecore-jss
または:
npx create-sitecore-jss --templates
利用可能な アドオンテンプレート名 は以下の通りです:
- nextjs-styleguide - 部品の例と 切断作業のセットアップを含む。
- nextjs-styleguide-tracking- Sitecore Experience Platform(XP)インスタンスに対して動作するアプリケーションの例追跡コンポーネントを含む。nextjs-styleguideアドオンが必要である。nextjs-personalizeアドオンやSitecore Experience Manager(XM)クラウドコンテンツ管理インスタンスとは互換性がない。
- nextjs-sxa - ヘッドレスSXAプロジェクトのための例となるコンポーネントとセットアップが含まれています。
- nextjs-multisite - 単一のNext.jsアプリケーションから複数のサイトをホスティングするためのセットアップ例が含まれています。