RubyGems - theme-check - Versions diffs - 1.10.3 → 1.12.0 - Mend

theme-check 1.10.3 → 1.12.0

Files changed (98) hide show

data/data/shopify_liquid/filters.yml CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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.
+### &#x2717; 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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/undefined_object.rb CHANGED Viewed

@@ -120,6 +120,10 @@ module ThemeCheck
           # NOTE: `email` is exceptionally exposed as a theme object in
           #       the customers' reset password template
           check_object(info, all_global_objects + ['email'])
+        elsif 'templates/robots.txt' == name
+          # NOTE: `robots` is the only object exposed object in
+          #       the robots.txt template
+          check_object(info, ['robots'])
         elsif 'layout/checkout' == name
           # NOTE: Shopify Plus has exceptionally exposed objects in
           #       the checkout template

data/lib/theme_check/checks/unused_assign.rb CHANGED Viewed

@@ -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

data/lib/theme_check/checks/unused_snippet.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 require "set"
 module ThemeCheck
@@ -11,16 +12,22 @@ module ThemeCheck
       @used_snippets = Set.new
     end
-    def on_include(node)
+    def on_render(node)
       if node.value.template_name_expr.is_a?(String)
         @used_snippets << "snippets/#{node.value.template_name_expr}"
+      elsif might_have_a_block_as_variable_lookup?(node)
+        # We ignore this case, because that's a "proper" use case for
+        # the render tag with OS 2.0
+        # {% render block %} shouldn't turn off the UnusedSnippet check
       else
         # Can't reliably track unused snippets if an expression is used, ignore this check
         @used_snippets.clear
         ignore!
       end
     end
-    alias_method :on_render, :on_include
+    alias_method :on_include, :on_render
     def on_end
       missing_snippets.each do |theme_file|
@@ -33,5 +40,46 @@ module ThemeCheck
     def missing_snippets
       theme.snippets.reject { |t| @used_snippets.include?(t.name) }
     end
+    private
+    # This function returns true when the render node passed might have a
+    # variable lookup that refers to a block as template_name_expr.
+    #
+    # e.g.
+    #
+    # {% for block in col %}
+    #   {% render block %}
+    # {% endfor %}
+    #
+    # In this case, the `block` variable_lookup in the render tag might be
+    # a Block because col might be an array of blocks.
+    #
+    # @param node [Node]
+    def might_have_a_block_as_variable_lookup?(node)
+      return false unless node.type_name == :render
+      return false unless node.value.template_name_expr.is_a?(Liquid::VariableLookup)
+      name = node.value.template_name_expr.name
+      return false unless name.is_a?(String)
+      # We're going through all the parents of the nodes until we find
+      # a For node with variable_name === to the template_name_expr's name
+      find_parent(node.parent) do |parent_node|
+        next false unless parent_node.type_name == :for
+        parent_node.value.variable_name == name
+      end
+    end
+    # @param node [Node]
+    def find_parent(node, &pred)
+      return nil unless node
+      return node if yield node
+      find_parent(node.parent, &pred)
+    end
   end
 end

data/lib/theme_check/config.rb CHANGED Viewed

@@ -126,14 +126,14 @@ module ThemeCheck
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
         severity = options_for_check.delete(:severity)
-        ignored_patterns = options_for_check.delete(:ignore) || []
+        check_ignored_patterns = options_for_check.delete(:ignore) || []
         check = if options_for_check.empty?
           check_class.new
         else
           check_class.new(**options_for_check)
         end
         check.severity = severity.to_sym if severity
-        check.ignored_patterns = ignored_patterns
+        check.ignored_patterns = check_ignored_patterns + ignored_patterns
         check.options = options_for_check
         check
       end.compact

data/lib/theme_check/disabled_checks.rb CHANGED Viewed

@@ -34,14 +34,16 @@ module ThemeCheck
         # We want to disable checks inside comments
         # (e.g. html checks inside {% comment %})
         disabled = @disabled_checks[[node.theme_file, :all]]
-        disabled.start_index = node.inner_markup_start_index
-        disabled.end_index = node.inner_markup_end_index
+        unless disabled.first_line
+          disabled.start_index = node.inner_markup_start_index
+          disabled.end_index = node.inner_markup_end_index
+        end
       end
     end
     def disabled?(check, theme_file, check_name, index)
       return true if check.ignored_patterns&.any? do |pattern|
-        theme_file.relative_path.fnmatch?(pattern)
+        theme_file&.relative_path&.fnmatch?(pattern)
       end
       @disabled_checks[[theme_file, :all]]&.disabled?(index) ||
@@ -65,7 +67,12 @@ module ThemeCheck
     private
     def comment_text(node)
-      node.value.nodelist.join
+      case node.type_name
+      when :comment
+        node.value.nodelist.join
+      when :inline_comment
+        node.markup.sub(/\s*#+\s*/, '')
+      end
     end
     def start_disabling?(text)

data/lib/theme_check/file_system_storage.rb CHANGED Viewed

@@ -21,6 +21,8 @@ module ThemeCheck
     def read(relative_path)
       file(relative_path).read(mode: 'rb', encoding: 'UTF-8')
+    rescue Errno::ENOENT
+      nil
     end
     def write(relative_path, content)

data/lib/theme_check/in_memory_storage.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module ThemeCheck
     attr_reader :root
     def initialize(files = {}, root = "/dev/null")
-      @files = files
+      @files = files # Hash<String, String>
       @root = Pathname.new(root)
     end