theme-check 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 299afef3e63667dca21495d3a3e6246d378b4be98c6b26a7a5f46405e6db80b8
-  data.tar.gz: b4d57dd51b0bd8960fcd42314fea731c1ae0aaac1ca29bbd2c591b3a6a9f4781
+  metadata.gz: a114e025e51ad2a09395b4ae0dca33e9417942a76ed781fdd639e7d7d1b35928
+  data.tar.gz: ff3c7f9b43f5ccae262cd22c8547d308a71e214cdd7f924208c25122624a48dc
 SHA512:
-  metadata.gz: ea83f67457a564676ca6e32f7b6f601f54c2d6c259cc1a8af705d673640bb9a3e11881f54ca9cc571faf75cb36af93b51c5f03c96547d2cb24eb19ff69d59795
-  data.tar.gz: 2694a73abcb292ebcc6d1f142a9255f9b5126d4748c64ece82c0081acb65d12c194acbd6232f24b50d0ddf982d076f49b342ef833883a09ab9a287712b631af5
+  metadata.gz: 3e4ead0f1d63cc68dfbaff6dd5462f08b9008c04dd87fae9499875cf967e501c68327adec0ac3c1f253bbdbf1343d14ddeb63fe58b4c9f4cb24f494315898d70
+  data.tar.gz: 62baa63bcf203d2bd0a7894787011f23d363cb6192920ac67c2ce0dfbe89f382c461a3d5a989c23234e5e1a9db7bfd9d10c4801bca121c1993a082b58887705d

data/.github/workflows/theme-check.yml

@@ -34,3 +34,6 @@ jobs:
       run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
     - name: Run tests
       run: bundle exec rake
+    - name: Test runtime
+      # Testing that runtime can execute, not testing the results themselves
+      run: bundle exec theme-check ./test/theme | grep -q "files inspected"

data/CHANGELOG.md

@@ -1,4 +1,48 @@
 
+v0.9.1 / 2021-06-04
+==================
+
+  * Convert `RemoteAsset` into an `HtmlCheck`
+  * Move Liquid logic from `RemoteAsset` to a new `AssetUrlFilters` check
+
+v0.9.0 / 2021-05-28
+==================
+
+  * Introduce HtmlCheck, and convert ParserBlockingJavaScript & ImgWidthAndHeight to it
+  * Move `script-tag` validation from ParserBlockingJavaScript to ParserBlockingScriptTag
+  * Add ability to ignore individual checks using file patterns
+  * Introduce single file and whole theme checks to optimize LSP diagnostics
+  * Fix TemplateLength counter not being reseted on each document
+  * Add missing category to ValidHTMLTranslation
+  * Set Ruby default encodings to UTF-8 to fix encoding issues
+  * Add ContentForHeaderModification check to prevent relying on the content of ``content_for_header`
+  * Fix `Content-Length` in LSP responses
+  * Fix disabling checks that emit offences in `on_end`
+  * Fix completion bug in `filter_completion_provider`
+
+v0.8.3 / 2021-05-17
+==================
+
+  * Making sure VERSION is set before referencing it
+
+v0.8.2 / 2021-05-14
+===================
+
+  * Bump NestedSnippet max_nesting_level to 3
+  * Add a message to help debug errors, and timeout checks after 5 sec
+  * Object Completions Everywhere!
+  * Include operators to space inside braces check
+
+0.8.1 / 2021-04-22
+==================
+
+  * Add consistent spacing around the pipe character (`|`) in variable expressions to the `SpaceInsideBrace` check ([#73](https://github.com/shopify/theme-check/issues/73))
+  * Add ReCaptcha system translation ([#265](https://github.com/shopify/theme-check/issues/265))
+  * Fix document links in `{% liquid %}` tags ([#263](https://github.com/shopify/theme-check/issues/263))
+  * Fix theme-check-disable for checks based on regular expressions ([#242](https://github.com/shopify/theme-check/issues/242))
+  * Fix VS Code crash on new window ([#264](https://github.com/shopify/theme-check/issues/264))
+  * Rescue errors thrown by remote_asset_file
+
 0.8.0 / 2021-04-13
 ==================
 

data/CONTRIBUTING.md

@@ -41,7 +41,8 @@ Under `lib/theme_check/checks`, create new Ruby file with a unique name describi
 ```ruby
 module ThemeCheck
   # Does one thing, and does it well!
-  # NOTE: inherit from JsonCheck to implement a JSON based check.
+  # NOTE: inherit from `JsonCheck` to implement a JSON-based check, and from `HtmlCheck`
+  # to implement an HTML-based one. See other checks in `lib/theme_check/checks` for examples.
   class MyCheckName < LiquidCheck
     severity :suggestion # :error or :style
 

data/README.md

@@ -92,11 +92,14 @@ root: dist
 require:
   - ./path/to/my_custom_check.rb
 
-# Disable some checks
 TemplateLength:
+  # Disable some checks
   enabled: false
   # Or configure options
   max_length: 300
+  # Or ignore certain paths
+  ignore:
+    - snippets/icon-*
 
 # Enable a custom check
 MyCustomCheck

data/RELEASING.md

@@ -9,11 +9,13 @@
    rake prerelease[$VERSION]
    ```
 
-3. Commit your changes and make a PR.
+3. Run [`git changelog`](https://github.com/tj/git-extras) to update `CHANGELOG.md`.
 
-4. Merge your PR to master.
+4. Commit your changes and make a PR.
 
-5. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
+5. Merge your PR to master.
+
+6. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
 
 ## Homebrew Release Process
 

data/config/default.yml

@@ -7,92 +7,133 @@ ignore:
 
 ConvertIncludeToRender:
   enabled: true
+  ignore: []
 
 LiquidTag:
   enabled: true
+  ignore: []
   min_consecutive_statements: 4
 
 MissingTemplate:
   enabled: true
+  ignore: []
 
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  ignore: []
+  max_nesting_level: 3
 
 RequiredLayoutThemeObject:
   enabled: true
+  ignore: []
 
 SpaceInsideBraces:
   enabled: true
+  ignore: []
 
 SyntaxError:
   enabled: true
+  ignore: []
 
 TemplateLength:
   enabled: true
+  ignore: []
   max_length: 200
   # Exclude content of {% schema %} in line count
   exclude_schema: true
 
 UnknownFilter:
   enabled: true
+  ignore: []
 
 UnusedAssign:
   enabled: true
+  ignore: []
 
 UnusedSnippet:
   enabled: true
+  ignore: []
 
 MatchingSchemaTranslations:
   enabled: true
+  ignore: []
 
 MatchingTranslations:
   enabled: true
+  ignore: []
 
 DefaultLocale:
   enabled: true
+  ignore: []
 
 TranslationKeyExists:
   enabled: true
+  ignore: []
 
 ValidHTMLTranslation:
   enabled: true
+  ignore: []
 
 ValidJson:
   enabled: true
+  ignore: []
 
 ValidSchema:
   enabled: true
+  ignore: []
 
 MissingRequiredTemplateFiles:
   enabled: true
+  ignore: []
 
 UndefinedObject:
   enabled: true
+  ignore: []
   exclude_snippets: true
 
 RequiredDirectories:
   enabled: true
+  ignore: []
 
 DeprecatedFilter:
   enabled: true
+  ignore: []
 
 MissingEnableComment:
   enabled: true
+  ignore: []
 
 ParserBlockingJavaScript:
   enabled: true
+  ignore: []
+
+ParserBlockingScriptTag:
+  enabled: true
 
 AssetSizeJavaScript:
   enabled: false
+  ignore: []
   threshold_in_bytes: 10_000
+  ignore: []
 
 AssetSizeCSS:
   enabled: false
+  ignore: []
   threshold_in_bytes: 100_000
+  ignore: []
 
 ImgWidthAndHeight:
   enabled: true
+  ignore: []
 
 RemoteAsset:
   enabled: true
+  ignore: []
+
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []

data/data/shopify_liquid/tags.yml

@@ -8,6 +8,8 @@
 - cycle
 - decrement
 - echo
+- else
+- elsif
 - for
 - form
 - if
@@ -25,3 +27,4 @@
 - stylesheet
 - tablerow
 - unless
+- when

data/data/shopify_translation_keys.yml

@@ -848,3 +848,4 @@
 - shopify.store_availability.pick_up_time.two_to_four_hours
 - shopify.store_availability.pick_up_time.immediately
 - shopify.store_availability.pick_up_time.next_day
+- shopify.online_store.spam_detection.disclaimer_html

data/docs/checks/asset_url_filters.md

@@ -0,0 +1,56 @@
+# Ensure `asset_url` filters are used when serving assets (`AssetUrlFilters`)
+
+See the [`RemoteAsset` check documentation][remote_asset] for a detailed explanation on why remote assets are discouraged.
+
+## Check Details
+
+This check is aimed at eliminating unnecessary HTTP connections.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- Using multiple CDNs -->
+{{ "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" | stylesheet_tag }}
+
+<!-- Missing img_url filter -->
+{{ url | img_tag }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{{ 'bootstrap.min.css' | asset_url | stylesheet_tag }}
+
+<!-- Images -->
+{{ url | img_url | img_tag }}
+```
+
+Use the [`assets_url`](asset_url) or [`img_url`](img_url) filter to load the files in your theme's `assets/` folder from the Shopify CDN.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+AssetUrlFilters:
+  enabled: true
+```
+
+## When Not To Use It
+
+When the remote content is highly dynamic.
+
+## Version
+
+This check has been introduced in Theme Check 0.9.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/remote_asset_filters.rb
+[docsource]: /docs/checks/remote_asset_filters.md
+[remote_asset]: /docs/checks/remote_asset.md
+[asset_url]: https://shopify.dev/docs/themes/liquid/reference/filters/url-filters#assert_url
+[img_url]: https://shopify.dev/docs/themes/liquid/reference/filters/url-filters#img_url

data/docs/checks/content_for_header_modification.md

@@ -0,0 +1,42 @@
+# Do not depend on the content of `content_for_header` (`ContentForHeaderModification`)
+
+Do not rely on the content of `content_for_header` as it might change in the future, which could cause your Liquid code behavior to change.
+
+## Check Details
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign parts = content_for_header | split: ',' %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+The only acceptable usage of `content_for_header` is:
+
+```liquid
+{{ content_for_header }}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ContentForHeaderModification:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+- [`theme.liquid` template considerations][considerations]
+
+[codesource]: /lib/theme_check/checks/check_class_name.rb
+[docsource]: /docs/checks/check_class_name.md
+[considerations]: https://shopify.dev/docs/themes/theme-templates/theme-liquid#template-considerations

data/docs/checks/nested_snippet.md

@@ -45,7 +45,7 @@ The default configuration for this check is the following:
 ```yaml
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  max_nesting_level: 3
 ```
 
 ### `max_nesting_level`

data/docs/checks/parser_blocking_script_tag.md

@@ -0,0 +1,53 @@
+# Discourage use of parser-blocking `script_tag` filter (`ParserBlockingScriptTag`)
+
+The `script_tag` filter emits a parser-blocking script tag.
+
+See the [ParserBlockingJavaScript check documentation][parser_blocking_javascript] for why this is generally discouraged.
+
+## Check Details
+
+This check is aimed at eliminating parser-blocking JavaScript on themes.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- The script_tag filter outputs a parser-blocking script -->
+{{ 'app-code.js' | asset_url | script_tag }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<!-- Good. Using the asset_url filter + defer -->
+<script src="{{ 'theme.js' | asset_url }}" defer></script>
+
+<!-- Also good. Using the asset_url filter + async -->
+<script src="{{ 'theme.js' | asset_url }}" async></script>
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ParserBlockingScriptTag:
+  enabled: true
+```
+
+## When Not To Use It
+
+This should only be turned off with the `theme-check-disable` comment when there's no better way to accomplish what you're doing than with a parser-blocking script.
+
+It is discouraged to turn this rule off.
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [ParserBlockingJavaScript check][parser_blocking_javascript]
+- [Documentation Source][docsource]
+
+[parser_blocking_javascript]: /docs/checks/parser_blocking_javascript.md
+[docsource]: /docs/checks/parser_blocking_script_tag.md

data/docs/checks/space_inside_braces.md

@@ -17,6 +17,14 @@ This check is aimed at eliminating ugly Liquid:
 <!-- After commas and semicolons -->
 {% form 'type',  object, key:value %}
 {% endform %}
+
+<!-- Arround filter pipelines -->
+{{ url  | asset_url | img_tag }}
+{% assign my_upcase_string = "Hello world"| upcase %}
+
+<!-- Arround symbol operators -->
+{%- if target  == product and product.price_varies -%}
+{%- if product.featured_media.width >=165 -%}
 ```
 
 :+1: Examples of **correct** code for this check:
@@ -33,6 +41,10 @@ This check is aimed at eliminating ugly Liquid:
   media_size: section.settings.product_recommendations_image_ratio,
   center_align_text: section.settings.center_align_text
 %}
+{{ url | asset_url | img_tag }}
+{% assign my_upcase_string = "Hello world" | upcase %}
+{%- if target == product and product.price_varies -%}
+{%- if product.featured_media.width >= 165 -%}
 ```
 
 ## Check Options
@@ -44,6 +56,22 @@ SpaceInsideBraces:
   enabled: true
 ```
 
+## Auto-correction
+
+This check can automatically trim or add spaces around `{{ ... }}`.
+
+```liquid
+{{ x}}
+{{x}}
+{{  x  }}
+```
+
+Can all be auto-corrected with the `--auto-correct` option to:
+
+```liquid
+{{ x }}
+```
+
 ## When Not To Use It
 
 If you don't care about the look of your code.