【Shopify.dev和訳】Themes/Dev tools/Shopify CLI/Theme commands

2021/10/06に公開約14,400字

この記事について

この記事は、Themes/Developer tools/Shopify CLI/Theme commandsの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Theme commands

このリファレンスには、Shopify CLI で使用できるテーマコマンドの一覧があります。このグループのコマンドは shopify theme [command] という構文を使います。

コマンドラインからこれらのコマンドのヘルプにアクセスするには、shopify [command] -h を使用してください。

init

テーマ構築の出発点となる Git リポジトリをローカルマシンにクローンします。

Git リポジトリが指定されていない場合、このコマンドは Shopify のサンプルテーマである Dawn のコピーを、指定された名前で現在のフォルダに作成します。名前が指定されていない場合は、名前を入力するように促されます。

Terminal
shopify theme init [ NAME ] [ options ]

オプションパラメーター

Parameter Short version Description
NAME テーマに付けたい名前。複製されたファイルは、この名前のフォルダーに保存されます。
--clone-url <URL> -u <URL> クローンを作成する Git リポジトリの URL。 URL が指定されていない場合は、https://github.com/Shopify/dawn.git が使用されます。

serve

現在のテーマを開発テーマとして接続しているストアにアップロードし、次の情報を返します。

  • http://127.0.0.1:9292 は、開発テーマへのリンクです。この URL は、CSS やセクションのローカルな変更をホットリロードするので、ストアのデータを使ってリアルタイムに変更をプレビューすることができます。このプレビューは Google Chrome でのみ利用できます。
  • テーマのオンラインストアエディターへのリンクです。
  • 他の開発者と共有できるプレビューリンクです。

現在の環境にすでに開発テーマがある場合は、このコマンドで開発テーマをローカルテーマと同期させます。

ローカルの変更点を http://127.0.0.1:9292 でプレビューするには、Google Chrome を使用する必要があります。

開発テーマは shopify logout を実行すると削除されます。ログアウト後も使用できるプレビューリンクが必要な場合は、ストアの未公開テーマにプッシュしてください。

このコマンドは、Shopify のデフォルトのテーマフォルダ構造に一致するディレクトリでのみ実行できます。

Terminal
shopify theme serve

Check

Theme Checkを呼び出して実行し、テーマコードのエラーを分析し、テーマと Liquid のベストプラクティスに従っていることを確認します。テーマチェックが実行するチェックの詳細をご覧ください

Terminal
shopify theme check [ options ] [ /path/to/your/theme ]

オプションパラメーター

Parameter Short version Description
--config <PATH> -C <PATH> カスタムテーマチェック構成へのパス。この構成は、分析対象のディレクトリに .theme-check.yml が存在する場合、それをオーバーライドします。
--category <CATEGORY> -c <CATEGORY> 指定されたカテゴリのチェックのみを実行します。このフラグの複数のインスタンスを使用して、複数のカテゴリを指定できます。
--exclude-category <CATEGORY> -x <CATEGORY> 指定されたカテゴリ以外のすべてのチェックを実行します。このフラグの複数のインスタンスを使用して、複数のカテゴリを指定できます。
--fail-level <LEVEL> テーマチェックの実行が失敗する原因となる重大度レベルを構成します(終了コード 1)。オプションには、errorsuggestion、および style が含まれます。
--auto-correct -a 修正可能な違反を自動的に修正します。
--init 新しいTheme Check configファイルを生成します。
--print アクティブな構成を STDOUT に出力します。
--list -l アクティブなチェックを一覧表示します。
--version -v 使用しているテーマチェックのバージョンを印刷します。

push

ローカルのテーマファイルを Shopify にアップロードし、指定されていればリモートテーマを上書きします。

テーマが指定されていない場合は、ストア内のテーマリストから上書きするテーマを選択するように促されます。

このコマンドは、Shopify のデフォルトのテーマフォルダ構造と一致するディレクトリでのみ実行できます。

このコマンドは、次の情報を返します。

Terminal
shopify theme push [ options ]

--json フラグを使用すると、テーマ情報が JSON 形式で返されます。これは、スクリプトまたは継続的インテグレーションの機械可読入力として使用できます。

Terminal
shopify theme push --unpublished --json

サンプルアウトプット:

{
  "theme": {
    "id": 108267175958,
    "name": "MyTheme",
    "role": "unpublished",
    "shop": "mystore.myshopify.com",
    "editor_url": "https://mystore.myshopify.com/admin/themes/108267175958/editor",
    "preview_url": "https://mystore.myshopify.com/?preview_theme_id=108267175958"
  }
}

オプションパラメーター

Parameter Short version Description
--themeid <THEMEID> -i <THEMEID> 上書きするテーマのID
--development -d 開発テーマにプッシュします。開発テーマがない場合は、作成されます。
--nodelete -n Shopify からリモートファイルを削除せずにローカルファイルをプッシュします。
--json -j プッシュされたテーマに関する情報を JSON オブジェクトとして返します。
--allow-live -a Shopify CLI がライブ(公開)テーマを上書きできるようにします。
--publish -p テーマがプッシュされた後、テーマを公開してストアに公開します。
--unpublished -u テーマを新しい未公開テーマとしてテーマライブラリにアップロードします。テーマの名前を入力するように求められます。
--ignore -x 指定されたファイルの Shopify へのアップロードをスキップします。 1 つのコマンドでフラグを複数回使用して、無視する複数のパターンを指定します。

.shopifyignore を使用してファイルを除外すると、.shopifyignore の内容と --ignore フラグの両方が尊重されます。

・単純なファイル名: templates/product.temp.json
・ワイルドカード: config/*_secret.json, *.jpg
・正規表現: /\.jpe?g$/

publish

テーマライブラリから未公開のテーマを公開します。

テーマ ID が指定されていない場合は、ストア内のテーマリストから公開するテーマを選択するように促されます。

このコマンドは、Shopify のデフォルトのテーマフォルダ構造に一致するディレクトリでのみ実行できます。

ローカルテーマを公開したい場合は、まず shopify theme push を実行する必要があります。指定されたテーマを公開するかどうかの確認を求められます。--force フラグを使用すると、この確認を省略できます。

Terminal
shopify theme publish [ THEME_ID ] [ --force | -f ]

オプションパラメーター

Parameter Short version Description
THEME_ID 公開するテーマのID
--force -f ユーザーに確認せずにテーマを公開します。

package

ローカルのテーマファイルを Shopify にアップロードできるように ZIP ファイルにパッケージします。

パッケージに含まれるのは、デフォルトの Shopify テーマのフォルダ構造にマッチしたフォルダのみです。

ZIP ファイルは、settings_schema.json ファイルのパラメータに基づいて、theme_name-theme_version.zip という名前で使用されます。

Terminal
shopify theme package [ /path/to/your/theme ]

delete

ストアからテーマを削除します。

ID で複数のテーマを指定できます。テーマが指定されていない場合は、ストア内のテーマ一覧から削除するテーマを選択するように求められます。

指定したテーマが削除される前に、削除するかどうかの確認を求められます。--force フラグを使うと、この確認を省略できます。

Terminal
shopify theme delete { THEME_ID [ ... ] | --development, -d } [ --force | -f ]

オプションパラメーター

Parameter Short version Description
THEME_ID 削除するテーマのID。スペースで区切って複数のテーマ ID を指定できます。
--development -d 開発テーマを削除します。
--force -f ユーザーに確認せずにテーマを削除します。

次のステップ

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Discussion

ログインするとコメントできます