theme-check 0.3.0 → 0.5.0

data/docs/checks/deprecated_filter.md

@@ -0,0 +1,46 @@
+# Discourage use of deprecated filters (`DeprecatedFilter`)
+
+This check discourages the use of [deprecated filters][deprecated].
+
+## Check Details
+
+This check is aimed at eliminating deprecated filters.
+
+:-1: Example of **incorrect** code for this check:
+
+```liquid
+.site-footer p {
+  color: {{ settings.color_name | hex_to_rgba: 0.5 }};
+}
+```
+
+:+1: Example of **correct** code for this check:
+
+```liquid
+.site-footer p {
+  color: {{ settings.color_name | color_modify: 'alpha', 0.5 }};
+}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+DeprecatedFilter:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.2.0.
+
+## Resources
+
+- [Deprecated Filters Reference][deprecated]
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[deprecated]: https://shopify.dev/docs/themes/liquid/reference/filters/deprecated-filters
+[codesource]: /lib/theme_check/checks/deprecated_filter.rb
+[docsource]: /docs/checks/deprecated_filter.md

data/docs/checks/liquid_tag.md

@@ -0,0 +1,65 @@
+# Encourage use of liquid tag for consecutive statements (LiquidTag)
+
+Recommends using `{% liquid ... %}` if 4 or more consecutive liquid tags (`{% ... %}`) are found.
+
+## Check Details
+
+This check is aimed at eliminating repetitive tag markers (`{%` and `%}`) in theme files.
+
+:-1: Example of **incorrect** code for this check:
+
+```liquid
+{% if collection.image.size != 0 %}
+{%   assign collection_image = collection.image %}
+{% elsif collection.products.first.size != 0 and collection.products.first.media != empty %}
+{%   assign collection_image = collection.products.first.featured_media.preview_image %}
+{% else %}
+{%   assign collection_image = nil %}
+{% endif %}
+```
+
+:+1: Example of **correct** code for this check:
+
+```liquid
+{%- liquid
+  if collection.image.size != 0
+    assign collection_image = collection.image
+  elsif collection.products.first.size != 0 and collection.products.first.media != empty
+    assign collection_image = collection.products.first.featured_media.preview_image
+  else
+    assign collection_image = nil
+  endif
+-%}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+LiquidTag:
+  enabled: true
+  min_consecutive_statements: 4
+```
+
+### `min_consecutive_statements`
+
+The `min_consecutive_statements` option (Default: `4`) determines the maximum (inclusive) number of consecutive statements before the check recommends a refactor.
+
+## When Not To Use It
+
+It's safe to disable this rule.
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [`{% liquid %}` Tag Reference][liquid]
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[liquid]: https://shopify.dev/docs/themes/liquid/reference/tags/theme-tags#liquid
+[codesource]: /lib/theme_check/checks/liquid_tag.rb
+[docsource]: /docs/checks/liquid_tag.md

data/docs/checks/matching_schema_translations.md

@@ -0,0 +1,93 @@
+# Spot errors in schema translations (`MatchingSchemaTranslations`)
+
+Validates translations in schema tags (`{% schema %}`).
+
+## Check Details
+
+Add checks for eliminating translations mistakes in schema tags.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% comment %}
+  - fr.missing is missing
+  - fr.extra is not in the default locale
+{% endcomment %}
+{% schema %}
+  {
+    "locales": {
+      "en": {
+        "title": "Welcome",
+        "missing": "Product"
+      },
+      "fr": {
+        "title": "Bienvenue",
+        "extra": "Extra"
+      }
+    }
+  }
+{% endschema %}
+
+{% comment %}
+  - The French product label is missing.
+{% endcomment %}
+{% schema %}
+  {
+    "name": {
+      "en": "Hello",
+      "fr": "Bonjour"
+    },
+    "settings": [
+      {
+        "id": "product",
+        "label": {
+          "en": "Product"
+        }
+      }
+    ]
+  }
+{% endschema %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% schema %}
+  {
+    "name": {
+      "en": "Hello",
+      "fr": "Bonjour"
+    },
+    "settings": [
+      {
+        "id": "product",
+        "label": {
+          "en": "Product",
+          "fr": "Produit"
+        }
+      }
+    ]
+  }
+{% endschema %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+MatchingSchemaTranslations:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/matching_schema_translations.rb
+[docsource]: /docs/checks/matching_schema_translations.md

data/docs/checks/matching_translations.md

@@ -0,0 +1,72 @@
+# Prevent mismatching translations (`MatchingTranslations`)
+
+This check exists to prevent missing and superfluous translations in locale files.
+
+## Check Details
+
+This check warns against missing translations in locale files.
+
+:-1: Examples of **incorrect** code for this check:
+
+```js
+// en.default.json
+{
+  "greeting": "Hello, world",
+  "goodbye": "Bye, world"
+}
+
+// fr.json - missing `greeting` and `goodbye`
+{
+}
+
+// fr.json - missing `greeting` and superfluous `goodby`
+{
+  "greeting": "Bonjour, monde"
+  "goodby": "Au revoir, monde"
+}
+```
+
+:+1: Example of **correct** code for this check:
+
+```liquid
+// en.default.json
+{
+  "greeting": "Hello, world",
+  "goodbye": "Bye, world"
+  "pluralized_greeting": {
+    "one": "Hello, you",
+    "other": "Hello, y'all",
+  }
+}
+
+// fr.json
+{
+  "greeting": "Bonjour, monde"
+  "goodbye": "Au revoir, monde"
+  "pluralized_greeting": {
+    "zero": "Je suis seul :(",
+    "few": "Salut, groupe!"
+  }
+}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+MatchingTranslations:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/matching_translations.rb
+[docsource]: /docs/checks/matching_translations.md

data/docs/checks/missing_enable_comment.md

@@ -0,0 +1,50 @@
+# Prevent missing theme-check-enable comments (`MissingEnableComment`)
+
+When `theme-check-disable` is used in the middle of a template, the corresponding `theme-check-enable` comment should also be included.
+
+## Check Details
+
+This check aims at eliminating missing `theme-check-enable` comments.
+
+:-1: Example of **incorrect** code for this check:
+
+```liquid
+<!doctype html>
+<html>
+  <head>
+    {% comment %}theme-check-disable ParserBlockingJavaScript{% endcomment %}
+    <script src="https://cdnjs.com/jquery.min.js"></script>
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+:+1: Example of **correct** code for this check:
+
+```liquid
+<!doctype html>
+<html>
+  <head>
+    {% comment %}theme-check-disable ParserBlockingJavaScript{% endcomment %}
+    <script src="https://cdnjs.com/jquery.min.js"></script>
+    {% comment %}theme-check-enable ParserBlockingJavaScript{% endcomment %}
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.3.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/missing_enable_comment.rb
+[docsource]: /docs/checks/missing_enable_comment.md

data/docs/checks/missing_required_template_files.md

@@ -0,0 +1,26 @@
+# Prevent missing required theme files (`MissingRequiredTemplateFiles`)
+
+Makes sure all the required template files in a theme are present.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+MissingRequiredTemplateFiles:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [Theme Requirements](https://shopify.dev/tutorials/review-theme-store-requirements-files)
+- [Theme Templates](https://shopify.dev/docs/themes/theme-templates)
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/missing_required_template_files.rb
+[docsource]: /docs/checks/missing_required_template_files.md

data/docs/checks/missing_template.md

@@ -0,0 +1,40 @@
+# Prevent missing templates (`MissingTemplate`)
+
+This check exists to prevent rendering resources with the `render` tag, `section` tag (and the deprecated `include` tag) that do not exist.
+
+## Check Details
+
+This check is aimed at preventing liquid rendering errors.
+
+:-1: Example of **incorrect** code for this check:
+
+```liquid
+{% render 'snippet-that-does-not-exist' %}
+```
+
+:+1: Example of **correct** code for this check:
+
+```liquid
+{% render 'article-card' %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+MissingTemplate:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/missing_template.rb
+[docsource]: /docs/checks/missing_template.md

data/docs/checks/nested_snippet.md

@@ -0,0 +1,69 @@
+# Prevent deeply nested snippets (`NestedSnippet`)
+
+Reports deeply nested `render` tags (or deprecated `include` tags).
+
+## Check Details
+
+This check is aimed at eliminating excessive nesting of snippets.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% comment %}templates/index.liquid{% endcomment %}
+  {% render 'one' %}
+
+{% comment %}snippets/one.liquid{% endcomment %}
+  {% render 'two' %}
+
+{% comment %}snippets/two.liquid{% endcomment %}
+  {% render 'three' %}
+
+{% comment %}snippets/three.liquid{% endcomment %}
+  {% render 'four' %}
+
+{% comment %}snippets/four.liquid{% endcomment %}
+  ok
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% comment %}templates/index.liquid{% endcomment %}
+  {% render 'one' %}
+
+{% comment %}snippets/one.liquid{% endcomment %}
+  {% render 'two' %}
+
+{% comment %}snippets/two.liquid{% endcomment %}
+  ok
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+NestedSnippet:
+  enabled: true
+  max_nesting_level: 2
+```
+
+### `max_nesting_level`
+
+The `max_nesting_level` option (Default: `2`) determines the maximum depth of snippets rendering snippets.
+
+## When Not To Use It
+
+It's safe to disable this rule.
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/nested_snippet.rb
+[docsource]: /docs/checks/nested_snippet.md