【Shopify.dev和訳】Themes/Dev tools/Theme Check/Configuration
この記事について
この記事は、Themes/Dev tools/Theme Check/Configurationの記事を和訳したものです。
記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
テーマチェックの設定 | Theme Check configuration
テーマチェックを設定することで、デフォルトのチェックオプションを上書きしたり、特定のチェックを有効または無効にしたり、独自のカスタムチェックを指定したりすることができます。
設定ファイルを使ってこれらの変更を行い、コメントを使ってチェックを無効にしたり、コマンドラインフラグを使ってチェックを選択的に実行することができます。
テーマチェックのコマンドラインフラグの詳細については、テーマチェックのコマンドを参照してください。
設定ファイル | Config file
チェックのデフォルトを上書きするために、テーマのルートに.theme-check.ymlファイルを追加します。
新しい .theme-check.yml ファイルは shopify theme check --init というコマンドで生成できます。
以下の設定を調整することができます。
| Setting (設定) | Description (説明) |
|---|---|
root |
テーマが標準のテーマディレクトリ構造を使用していない場合、templates、sections、snippetsディレクトリを見つけるためのルートパスを指定できます。例えば、src ディレクトリからコードを生成している場合、テーマチェックの設定を対応する dist ディレクトリに向ける必要があります。 |
ignore |
テーマ内のディレクトリをテーマチェックから除外します。 |
require |
カスタムチェックを使用したい場合は、各カスタムチェックの RB ファイルのパスを追加します。 |
| Check settings | 各チェックについて、enabled を true または false に設定し、チェックの重大度を設定し、チェックの特定のignoreファイルとパスを設定し、その他のチェックオプションを設定します。カスタムチェックを作成した場合は、この方法でチェックを有効にする必要があります。チェックオプションのデフォルト値は、checks のリファレンスで確認できます。 |
# テーマのフォルダが置かれるディレクトリ
root: dist
# カスタムチェックへのパス
require:
- ./path/to/my_custom_check.rb
# チェックを無効にする
TemplateLength:
enabled: false
severity: suggestion
ignore:
- templates/index.liquid
# Configure options for a check
max_length: 300
# カスタムチェックを有効にする
MyCustomCheck:
enabled: true
severity: style
重大度チェック | Check severity
バージョン 1.1.0 以上
チェックの重大度は、テーマの機能と最適化に対するチェックの相対的な重要度を示します。深刻度には、error、suggestion、styleがあります。チェックの重大度は、設定ファイルで変更することができます。
CI プロセスの一部としてテーマチェックを実行している場合は、失敗したチェックの深刻度によって受け取る終了コードが決まります。デフォルトでは、重大度errorの問題が 1 つ以上検出されると、テーマチェックは失敗、つまり終了コード 1 を返します。--fail-level フラグを使用すると、テーマチェックの実行を失敗させる深刻度を設定できます。
リキッドコメントによるチェックの無効化 | Disable checks using Liquid comments
コメントを使って、すべてのチェックや特定のチェックを無効にすることができます。テーマコードの特定のセクション、またはファイル全体のチェックを無効にすることができます。
テンプレートのあるセクションのチェックをすべて無効にします :
{% comment %}theme-check-disable{% endcomment %}
{% assign x = 1 %}
{% comment %}theme-check-enable{% endcomment %}
特定のチェックを無効にするには、そのチェックをコメントに含める必要があります :
{% comment %}theme-check-disable UnusedAssign{% endcomment %}
{% assign x = 1 %}
{% comment %}theme-check-enable UnusedAssign{% endcomment %}
複数のチェックを無効にするには、コンマで区切ったリストを指定します :
{% comment %}theme-check-disable UnusedAssign,SpaceInsideBraces{% endcomment %}
{%assign x = 1%}
{% comment %}theme-check-enable UnusedAssign,SpaceInsideBraces{% endcomment %}
コメントを最初の行に配置することで、ドキュメント全体のチェックを無効にすることができます :
{% comment %}theme-check-disable SpaceInsideBraces{% endcomment %}
{%assign x = 1%}
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion