theme-check 1.10.3 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2774c1d3e2e9b8fa7dab0fdd4174dbfd3e625c608af349c30f526f00a6b9123
-  data.tar.gz: 69bdb078be8aa938b2dec75a62206840586ae1a015620ec3c9ce727e49fc2e07
+  metadata.gz: 99089d8a9e02b33f55c11e18d0d0dea02f8b4b9be24f548c2ba4852823d54d2e
+  data.tar.gz: aa7c80503782d3817fe49fd4460ff565144339c19ea87a1ec9c516573116299f
 SHA512:
-  metadata.gz: aa83efd1994e95fd12defc06b13567fac6e80fd830fb870f7a50b650424b8ed339848271ac35c608b6bc40a3e884665a3136c1f75e150be937be8b78e74df9fc
-  data.tar.gz: 848e2752ecc6e6bb4b0954663dac298f869a191d0b4b146fd488b8a9a442a5573a1c716c84658b2654431f96db1572309c70991a2e29e37c1bf82bd337c79edd
+  metadata.gz: 99f92709c2d233e05f5ba79b9c83243fc3fe3cd0ce640c7b2444b24c7922f57e76d40910997fab8ac7aa10ffe553ae3fcfde68bc310e0330279f0bb4419bd9d8
+  data.tar.gz: 6e43b16af119f881d5ae36501d638b7bb1459fe4fdfe124f396338012d28b5e5c8f4ad9b28b8ab3e3afd83c92044391ae31af6ca3f3914f898501d08e7710ca3

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+<!--A clear and concise description of what the bug is.-->
+
+**Expected**
+<!-- Include what you expect should happen here -->
+
+**Actual**
+<!-- Include a description of what actually happens here -->
+
+**Stack trace**
+```
+<!-- When provided, please include the entire error message in here -->
+```
+
+**Debugging information**
+- OS [e.g. Windows, Mac, Linux]
+- Version (output of `theme-check --version` in a terminal)
+
+**Additional context**
+<!-- Add any other context or screenshots about the problem here. -->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!-- Add any other context or screenshots about the feature request here. -->

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

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

@@ -13,7 +13,7 @@ jobs:
           - windows-latest
         version:
           - 3.0.0
-          - 2.6.6
+          - 2.7.6
         theme:
           - Shopify/dawn
 

data/CHANGELOG.md

@@ -1,4 +1,45 @@
 
+v1.11.0 / 2022-08-22
+====================
+
+## TL;DR
+
+  * New check, overdue fixes and dropped support for ruby 2.6.
+
+## Features
+
+  * :new: [AssetPreload](https://github.com/Shopify/theme-check/blob/main/docs/checks/asset_preload.md) check ([#605](https://github.com/shopify/theme-check/issues/605)). Thanks @krzksz!
+    * Encourages the use of the new platform features for some sweet 103 Early Hints gains powered by the `preload_tag` and `preload: true` media filter argument.
+
+## Fixes:
+
+### General
+
+  * Add support for new comment syntax `{% # this is an inline comment %}` ([#533](https://github.com/shopify/theme-check/issues/533))
+  * Fix UnusedAssign false positives from `{% render ... with|for var %}` ([#608](https://github.com/shopify/theme-check/issues/608))
+  * Update list of platform filters ([#626](https://github.com/shopify/theme-check/issues/626))
+
+### Language Server
+
+  * Make `runChecks` command respect `onlySingleFileChecks` LSP config ([#624](https://github.com/shopify/theme-check/issues/624))
+  * Handle file delete|rename ([#611](https://github.com/shopify/theme-check/issues/611))
+  * Prevent server from hanging on error ([#623](https://github.com/shopify/theme-check/issues/623))
+
+### Linter
+
+  * Help migrate named sizes (master|pico|etc.) in `img_url` with `DeprecatedFilter` corrector ([#619](https://github.com/shopify/theme-check/issues/619))
+  * Fix MissingTemplate `ignore` config interactions (#613)
+  * Fix MissingRequiredTemplateFiles JSON file corrector ([#616](https://github.com/shopify/theme-check/issues/616))
+  * Fixes theme-check-disable when disable comment is followed by another (#617)
+  * Fix handling of `{% render block %}` in UnusedSnippet ([#615](https://github.com/shopify/theme-check/issues/615))
+  * Fix IndexError: string not matched in matching translation keys fixer ([#602](https://github.com/shopify/theme-check/issues/602))
+  * Handle variable lookup as names in UnusedAssign ([#612](https://github.com/shopify/theme-check/issues/612))
+
+## Breaking change (maybe)
+
+  * Bump min version of ruby to 2.7 ([#609](https://github.com/shopify/theme-check/issues/609))
+    * Upstream change from Shopify/liquid as ruby 2.6 is now EOL.
+
 v1.10.3 / 2022-06-16
 ==================
 

data/README.md

@@ -115,32 +115,31 @@ See [config/default.yml](config/default.yml) for available options & defaults.
 Use Liquid comments to disable and re-enable all checks for a section of your template:
 
 ```liquid
-{% comment %}theme-check-disable{% endcomment %}
+{% # theme-check-disable %}
 {% assign x = 1 %}
-{% comment %}theme-check-enable{% endcomment %}
+{% # theme-check-enable %}
 ```
 
 Disable a specific check by including it in the comment:
 
 ```liquid
-{% comment %}theme-check-disable UnusedAssign{% endcomment %}
+{% # theme-check-disable UnusedAssign %}
 {% assign x = 1 %}
-{% comment %}theme-check-enable UnusedAssign{% endcomment %}
+{% # theme-check-enable UnusedAssign %}
 ```
 
 Disable multiple checks by including them as a comma-separated list:
 
 ```liquid
-{% comment %}theme-check-disable UnusedAssign,SpaceInsideBraces{% endcomment %}
+{% # theme-check-disable UnusedAssign,SpaceInsideBraces %}
 {%assign x = 1%}
-{% comment %}theme-check-enable UnusedAssign,SpaceInsideBraces{% endcomment %}
+{% # theme-check-enable UnusedAssign,SpaceInsideBraces %}
 ```
 
 Disable checks for the _entire document_ by placing the comment on the first line:
 
 ```liquid
-{% comment %}theme-check-disable SpaceInsideBraces{% endcomment %}
-
+{% # theme-check-disable SpaceInsideBraces %}
 {%assign x = 1%}
 ```
 

data/config/default.yml

@@ -131,6 +131,10 @@ ParserBlockingScriptTag:
   enabled: true
   ignore: []
 
+AssetPreload:
+  enabled: true
+  ignore: []
+
 AssetSizeJavaScript:
   enabled: false
   threshold_in_bytes: 10_000

data/data/shopify_liquid/filters.yml

@@ -1,4 +1,20 @@
 ---
+# Here's an example workflow that's going to get ya the list of filters available
+# ```bash
+# spin up storefront-renderer
+# spin ssh
+# cd storefront-renderer
+# bundle exec rake console
+# ```
+# ```ruby
+# Pathname(ENV["HOME"]).join('filters.yml').write(YAML.dump(Liquid::StrainerFactory.global_filter_names))
+# ```
+# ```bash
+# exit
+# scp $(spin show -o fqdn):/filters.yml .
+# ```
+# The list of filters is now in a file named filters.yml in your $(pwd).
+# Note that it'll probably need a bit of massaging before including here...
 Liquid::StandardFilters:
 - times
 - h
@@ -19,7 +35,9 @@ Liquid::StandardFilters:
 - remove
 - sort_natural
 - replace_first
+- replace_last
 - remove_first
+- remove_last
 - newline_to_br
 - upcase
 - downcase

data/dev.yml

@@ -3,7 +3,7 @@ name: theme-check
 type: ruby
 
 up:
-  - ruby: 2.6.6
+  - ruby: "2.7"
   - bundler
 
 commands:

data/docs/checks/asset_preload.md

@@ -0,0 +1,60 @@
+# Prevent Manual Preloading of Assets (`AssetPreload`)
+
+_Version 1.11.0+_
+
+Preloading can be a useful way of making sure that critical assets are downloaded by the browser as soon as possible for better rendering performance.
+
+Liquid provides multiple filters to [preload key resources][preload_key_resources] so they can be converted into `Link` headers automatically. This enables them to be discovered even faster, especially when combined with Early Hints that Shopify supports.
+
+## Examples
+
+The following examples contain code snippets that either fail or pass this check.
+
+### ✗ Fail
+
+```liquid
+<link href="{{ 'script.js' | asset_url }}" rel="preload" as="script">
+<link href="{{ 'style.css' | asset_url }}" rel="preload" as="style">
+<link href="{{ 'image.png' | asset_url }}" rel="preload" as="image">
+```
+
+### &#x2713; Pass
+
+```liquid
+{{ 'script.js' | asset_url | preload_tag: as: 'script' }}
+{{ 'style.css' | asset_url | stylesheet_tag: preload: true }}
+{{ 
+  product.featured_image 
+    | image_url: width: 600 
+    | image_tag: preload: true 
+}}
+```
+
+## Options
+
+The following example contains the default configuration for this check:
+
+```yaml
+AssetPreload:
+  enabled: true
+  severity: suggestion
+```
+
+| Parameter | Description |
+| --- | --- |
+| enabled | Whether the check is enabled. |
+| severity | The [severity](https://shopify.dev/themes/tools/theme-check/configuration#check-severity) of the check. |
+
+## Disabling this check
+
+It's safe to disable this rule. You may want to do it when trying to preload assets from external domain and it is not possible
+to move them to Shopify because they change frequently or are dynamically generated.
+
+## Resources
+
+- [Rule source][codesource]
+- [Documentation source][docsource]
+
+[codesource]: /lib/theme_check/checks/asset_preload.rb
+[docsource]: /docs/checks/asset_preload.md
+[preload_key_resources]: https://shopify.dev/themes/best-practices/performance#use-resource-hints-to-preload-key-resources

data/docs/checks/asset_size_javascript.md

@@ -57,9 +57,9 @@ This includes theme and remote scripts.
 When you can't do anything about it, it is preferable to disable this rule using the comment syntax:
 
 ```
-{% comment %}theme-check-disable AssetSizeJavaScript{% endcomment %}
+{% # theme-check-disable AssetSizeJavaScript %}
 <script src="https://code.jquery.com/jquery-3.6.0.min.js" defer></script>
-{% comment %}theme-check-enable AssetSizeJavaScript{% endcomment %}
+{% # theme-check-enable AssetSizeJavaScript %}
 ```
 
 This makes disabling the rule an explicit affair and shows that the code is smelly.

data/docs/checks/missing_enable_comment.md

@@ -12,7 +12,7 @@ This check aims at eliminating missing `theme-check-enable` comments.
 <!doctype html>
 <html>
   <head>
-    {% comment %}theme-check-disable ParserBlockingJavaScript{% endcomment %}
+    {% # theme-check-disable ParserBlockingJavaScript %}
     <script src="https://cdnjs.com/jquery.min.js"></script>
   </head>
   <body>
@@ -27,9 +27,9 @@ This check aims at eliminating missing `theme-check-enable` comments.
 <!doctype html>
 <html>
   <head>
-    {% comment %}theme-check-disable ParserBlockingJavaScript{% endcomment %}
+    {% # theme-check-disable ParserBlockingJavaScript %}
     <script src="https://cdnjs.com/jquery.min.js"></script>
-    {% comment %}theme-check-enable ParserBlockingJavaScript{% endcomment %}
+    {% # theme-check-enable ParserBlockingJavaScript %}
   </head>
   <body>
     <!-- ... -->

data/docs/checks/nested_snippet.md

@@ -9,32 +9,32 @@ This check is aimed at eliminating excessive nesting of snippets.
 :-1: Examples of **incorrect** code for this check:
 
 ```liquid
-{% comment %}templates/index.liquid{% endcomment %}
+{% # templates/index.liquid %}
   {% render 'one' %}
 
-{% comment %}snippets/one.liquid{% endcomment %}
+{% # snippets/one.liquid %}
   {% render 'two' %}
 
-{% comment %}snippets/two.liquid{% endcomment %}
+{% # snippets/two.liquid %}
   {% render 'three' %}
 
-{% comment %}snippets/three.liquid{% endcomment %}
+{% # snippets/three.liquid %}
   {% render 'four' %}
 
-{% comment %}snippets/four.liquid{% endcomment %}
+{% # snippets/four.liquid %}
   ok
 ```
 
 :+1: Examples of **correct** code for this check:
 
 ```liquid
-{% comment %}templates/index.liquid{% endcomment %}
+{% # templates/index.liquid %}
   {% render 'one' %}
 
-{% comment %}snippets/one.liquid{% endcomment %}
+{% # snippets/one.liquid %}
   {% render 'two' %}
 
-{% comment %}snippets/two.liquid{% endcomment %}
+{% # snippets/two.liquid %}
   ok
 ```
 

data/docs/checks/translation_key_exists.md

@@ -9,7 +9,7 @@ This check is aimed at eliminating the use of translations that do not exist.
 :-1: Examples of **incorrect** code for this check:
 
 ```liquid
-{% comment %}locales/en.default.json{% endcomment %}
+{% # locales/en.default.json %}
 {
   "greetings": "Hello, world!",
   "general": {
@@ -17,14 +17,14 @@ This check is aimed at eliminating the use of translations that do not exist.
   }
 }
 
-{% comment %}templates/index.liquid{% endcomment %}
+{% # templates/index.liquid %}
 {{ "notfound" | t }}
 ```
 
 :+1: Examples of **correct** code for this check:
 
 ```liquid
-{% comment %}locales/en.default.json{% endcomment %}
+{% # locales/en.default.json %}
 {
   "greetings": "Hello, world!",
   "general": {
@@ -32,7 +32,7 @@ This check is aimed at eliminating the use of translations that do not exist.
   }
 }
 
-{% comment %}templates/index.liquid{% endcomment %}
+{% # templates/index.liquid %}
 {{ "greetings" | t }}
 {{ "general.close" | t }}
 ```

data/docs/checks/valid_html_translation.md

@@ -18,7 +18,7 @@ This check is aimed at eliminating invalid HTML in translations.
 :+1: Examples of **correct** code for this check:
 
 ```liquid
-{% comment %}locales/en.default.json{% endcomment %}
+{% # locales/en.default.json %}
 {
   "hello_html": "<h1>Hello, world</h1>",
   "image_html": "<img src='spongebob.png'>",

data/lib/theme_check/analyzer.rb

@@ -41,6 +41,7 @@ module ThemeCheck
       json_file_count + liquid_file_count
     end
 
+    # Returns all offenses for all files in theme
     def analyze_theme
       reset
 
@@ -60,9 +61,23 @@ module ThemeCheck
         @json_checks.call(:on_file, json_file)
       end
 
-      finish
+      finish(false)
+
+      offenses
     end
 
+    # When only_single_file is false:
+    #   Runs single file checks for each file in `files`
+    #   Runs whole theme checks
+    #   Returns single file checks offenses for file in `files` + whole theme checks
+    # When only_single_file is true:
+    #   Runs single file checks for each file in `files`
+    #   Does not run whole theme checks
+    #   Returns single file checks offenses for file in `files`
+    # When files is empty and only_single_file is false:
+    #   Only returns whole theme checks
+    # When files is empty and only_single_file is true:
+    #   Returns empty array
     def analyze_files(files, only_single_file: false)
       reset
 
@@ -103,6 +118,8 @@ module ThemeCheck
       end
 
       finish(only_single_file)
+
+      offenses
     end
 
     def uncorrectable_offenses
@@ -158,8 +175,6 @@ module ThemeCheck
       @disabled_checks.remove_disabled_offenses(@liquid_checks)
       @disabled_checks.remove_disabled_offenses(@json_checks)
       @disabled_checks.remove_disabled_offenses(@html_checks)
-
-      offenses
     end
   end
 end

data/lib/theme_check/check.rb

@@ -6,7 +6,8 @@ module ThemeCheck
     include JsonHelpers
 
     attr_accessor :theme
-    attr_accessor :options, :ignored_patterns
+    attr_accessor :options
+    attr_writer :ignored_patterns
     attr_writer :offenses
 
     # The order matters.
@@ -130,6 +131,10 @@ module ThemeCheck
       defined?(@ignored) && @ignored
     end
 
+    def ignored_patterns
+      @ignored_patterns ||= []
+    end
+
     def can_disable?
       self.class.can_disable
     end

data/lib/theme_check/checks/asset_preload.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class AssetPreload < HtmlCheck
+    severity :suggestion
+    categories :html, :performance
+    doc docs_url(__FILE__)
+
+    def on_link(node)
+      return if node.attributes["rel"]&.downcase != "preload"
+      case node.attributes["as"]&.downcase
+      when "style"
+        add_offense("For better performance, prefer using the preload argument of the stylesheet_tag filter", node: node)
+      when "image"
+        add_offense("For better performance, prefer using the preload argument of the image_tag filter", node: node)
+      else
+        add_offense("For better performance, prefer using the preload_tag filter", node: node)
+      end
+    end
+  end
+end

data/lib/theme_check/checks/deprecated_filter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ThemeCheck
   class DeprecatedFilter < LiquidCheck
     doc docs_url(__FILE__)
@@ -8,6 +9,19 @@ module ThemeCheck
     # The image_url filter does not accept width or height values
     # greater than this numbr.
     MAX_SIZE = 5760
+    SIZE_REGEX = /^\d*x\d*$/
+    NAMED_SIZES = {
+      "pico" => 16,
+      "icon" => 32,
+      "thumb" => 50,
+      "small" => 100,
+      "compact" => 160,
+      "medium" => 240,
+      "large" => 480,
+      "grande" => 600,
+      "original" => 1024,
+      "master" => nil,
+    }
 
     def on_variable(node)
       used_filters = node.filters.map { |name, *_rest| name }
@@ -40,19 +54,29 @@ module ThemeCheck
 
       # Can't correct those.
       return add_default_offense(node, 'img_url', ['image_url']) unless
-       (size_spec.nil? || size_spec.is_a?(String)) &&
-       (scale.nil? || scale.is_a?(Numeric)) &&
-       size_spec != 'small'
+        (size_spec.nil? || size_spec.is_a?(String)) &&
+          (scale.nil? || scale.is_a?(Numeric))
+
+      return add_default_offense(node, 'img_url', ['image_url']) if
+        size_spec.is_a?(String) &&
+          size_spec !~ SIZE_REGEX &&
+          !NAMED_SIZES.key?(size_spec)
 
       node_source = node.markup
+
       node_start_index = node.start_index
       match = node_source.match(/img_url[^|]*/)
       img_url_character_range =
         (node_start_index + match.begin(0))...(node_start_index + match.end(0))
 
       scale = (scale || 1).to_i
-      width, height = (size_spec&.split('x') || [100, 100])
-        .map { |v| v.to_i * scale }
+      width, height = if size_spec.nil?
+        [100, 100]
+      elsif NAMED_SIZES.key?(size_spec)
+        [NAMED_SIZES[size_spec], NAMED_SIZES[size_spec]]
+      else
+        size_spec.split('x')
+      end.map { |v| v.to_i * scale }
 
       image_url_filter_params = [
         width && width > 0 ? "width: #{[width, MAX_SIZE].min}" : nil,

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -16,6 +16,10 @@ module ThemeCheck
       @disabled_checks.update(node)
     end
 
+    def on_inline_comment(node)
+      @disabled_checks.update(node)
+    end
+
     def after_document(node)
       checks_missing_end_index = @disabled_checks.checks_missing_end_index
       return if checks_missing_end_index.empty?

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -33,7 +33,11 @@ module ThemeCheck
           if REQUIRED_LIQUID_TEMPLATE_FILES.include?(file)
             corrector.create_file(@theme.storage, "#{file}.liquid", "")
           else
-            corrector.create_file(@theme.storage, "#{file}.json", "")
+            corrector.create_file(@theme.storage, "#{file}.json", JSON.pretty_generate({
+              name: "TODO",
+              sections: {},
+              order: [],
+            }))
           end
         end
       end

data/lib/theme_check/checks/missing_template.rb

@@ -28,7 +28,11 @@ module ThemeCheck
     private
 
     def ignore?(path)
-      @ignore_missing.any? { |pattern| File.fnmatch?(pattern, path) }
+      all_ignored_patterns.any? { |pattern| File.fnmatch?(pattern, path) }
+    end
+
+    def all_ignored_patterns
+      @all_ignored_patterns ||= @ignore_missing + ignored_patterns
     end
 
     def add_missing_offense(name, node:)

data/lib/theme_check/checks/unused_assign.rb

@@ -39,7 +39,12 @@ module ThemeCheck
     end
 
     def on_variable_lookup(node)
-      @templates[node.theme_file.name].used_assigns << node.value.name
+      @templates[node.theme_file.name].used_assigns << case node.value.name
+      when Liquid::VariableLookup
+        node.value.name.name
+      else
+        node.value.name
+      end
     end
 
     def on_end