theme-check 1.5.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f0635001a9f808d12b55e0328536911bde9ea36160bcf34a63f10114401d18
-  data.tar.gz: 78365fe98014904e058191934663b75d24701db8a2a2585edac2557192cec5d5
+  metadata.gz: e992338f154cdf5da965bae74af6907af89156170b5bdcf599f8f15b9708bb87
+  data.tar.gz: 27071bf8d98359410d2486a62502f2e7453465771b932a77a6c27785ba00abbb
 SHA512:
-  metadata.gz: 0520e083dac843ed6273ba17e0cb44ee0e9e2c412f85a81b176da8b0912a583ab262c0c25b0b580df9c53cabefca305dce468559efa6df786ff37b7583e7ecc4
-  data.tar.gz: 58b7483ad5935de781eddf850a73c88f04aadbae394416f901fa38e173b44b4af3717947fc72cc009c899866ce1d27cc3f6597d5de7dd7ea1ef6984393d71ff4
+  metadata.gz: 33969efb3cc9bd670ce7a15a419e7419824e8e48ab5951e1f527f116e3aec42ca01c214eb50cd0eb1058fd6c5975c353f3b84024b990dcbad3a45f27cbb9380f
+  data.tar.gz: 410dd3f410c5dd0fe23533eae5716d8bfefec6fd4bc57e68c77dfe14832e7c498854d2dc6728b25467188d887860d97d92747cf915ab1c669f40226b46a371ad

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

@@ -8,15 +8,23 @@ jobs:
 
     strategy:
       matrix:
-        platform: [ubuntu-latest, windows-latest]
+        platform:
+          - ubuntu-latest
+          - windows-latest
         version:
           - 3.0.0
           - 2.6.6
+        theme:
+          - Shopify/dawn
 
     name: Ruby ${{ matrix.platform }} ${{ matrix.version }}
 
     steps:
     - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+        repository: ${{ matrix.theme }}
+        path: ./crash-test-theme
     - name: Set up Ruby ${{ matrix.version }}
       uses: ruby/setup-ruby@v1
       with:
@@ -30,6 +38,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"
+    - name: Crash test
+      run: |
+        bundle exec theme-check --fail-level crash ./crash-test-theme

data/CHANGELOG.md

@@ -1,4 +1,39 @@
 
+v1.6.2 / 2021-09-16
+===================
+
+  * SpaceInsideBraces fixup for tags without arguments ([#458](https://github.com/shopify/theme-check/issues/458))
+  * Fix UnusedAssign bug when variable used in for loop range by bumping Liquid to 5.1 ([#456](https://github.com/shopify/theme-check/issues/456))
+
+v1.6.1 / 2021-09-15
+===================
+
+  * Fix `Undefined method `-' for nil:NilClass` in Node when tag was missing surrounding spaces ([#454](https://github.com/shopify/theme-check/issues/454), [#452](https://github.com/shopify/theme-check/issues/452))
+
+v1.6.0 / 2021-09-14
+===================
+
+### Features
+
+  * Add `--auto-correct` support to `TranslationKeyExists` (add missing translation as TODO to default locale) ([#422](https://github.com/shopify/theme-check/issues/422))
+  * Add `--auto-correct` support to `UnusedSnippet` (delete unused file) ([#416](https://github.com/shopify/theme-check/issues/416))
+  * Add `--auto-correct` support to `MissingRequiredTemplateFiles` (create missing files) ([#385](https://github.com/shopify/theme-check/issues/385))
+
+### Fixes
+
+  * Fix `undefined method [] of nil` in `replace_placeholders` ([#441](https://github.com/shopify/theme-check/issues/441), [#444](https://github.com/shopify/theme-check/issues/444))
+  * Disable ConvertIncludeToRender corrector until we fix [#445](https://github.com/shopify/theme-check/issues/445) ([#446](https://github.com/shopify/theme-check/issues/446))
+  * Fix a couple of correction bugs ([#442](https://github.com/shopify/theme-check/issues/442), [#439](https://github.com/shopify/theme-check/issues/439))
+  * Fix `AssetSizeCSS` error when size is nil ([#419](https://github.com/shopify/theme-check/issues/419))
+  * Write JSON to file, not a Ruby Hash. ([#434](https://github.com/shopify/theme-check/issues/434), [#432](https://github.com/shopify/theme-check/issues/432))
+
+v1.5.2 / 2021-09-09
+===================
+
+  * Handle invalid URIs in RemoteAssetFile ([#418](https://github.com/shopify/theme-check/issues/418), [#438](https://github.com/shopify/theme-check/issues/438))
+  * Fix `Bad start_index` error in SpaceInsideBraces ([#423](https://github.com/shopify/theme-check/issues/423))
+  * Autocorrect missing directories ([#389](https://github.com/shopify/theme-check/issues/389))
+
 v1.5.1 / 2021-09-08
 ===================
 

data/docs/api/html_check.md

@@ -16,18 +16,18 @@ module ThemeCheck
     severity :suggestion # :error or :style
 
     def on_document(node)
-      # Called with the root node of all templates
-      node.value    # is an instance of Nokogiri::XML::Node
-      node.template # is the template being analyzed, See lib/theme_check/template.rb.
-      node.parent   # is the parent node.
-      node.children # are the children nodes.
+      # Called with the root node of all theme files
+      node.value      # is an instance of Nokogiri::XML::Node
+      node.theme_file # is the html_file being analyzed, See lib/theme_check/theme_file.rb.
+      node.parent     # is the parent node.
+      node.children   # are the children nodes.
       # See lib/theme_check/html_node.rb for more helper methods
-      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
+      theme # Gives you access to all the theme files in the theme. See lib/theme_check/theme.rb.
     end
 
     def on_img(node)
       # Called for every <img> element in the file.
-      node.attrbutes["class"] # Get the class attribute of the img element.
+      node.attributes["class"] # Get the class attribute of the img element.
     end
 
     def on_a(node)

data/docs/api/liquid_check.md

@@ -16,13 +16,13 @@ module ThemeCheck
     severity :suggestion # :error or :style
 
     def on_document(node)
-      # Called with the root node of all templates
-      node.value    # is the original Liquid object for this node. See Liquid source code for details.
-      node.template # is the template being analyzed, See lib/theme_check/template.rb.
-      node.parent   # is the parent node.
-      node.children # are the children nodes.
+      # Called with the root node of all liquid_file
+      node.value      # is the original Liquid object for this node. See Liquid source code for details.
+      node.theme_file # is the liquid_file being analyzed, See lib/theme_check/liquid_file.rb.
+      node.parent     # is the parent node.
+      node.children   # are the children nodes.
       # See lib/theme_check/node.rb for more helper methods
-      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
+      theme # Gives you access to all the theme files in the theme. See lib/theme_check/theme.rb.
     end
 
     def on_node(node)
@@ -38,8 +38,8 @@ module ThemeCheck
       
       # If you find an issue, add an offense:
       add_offense("Describe the problem...", node: node)
-      # Or, if the offense is related to the whole template:
-      add_offense("Describe the problem...", template: node.template)
+      # Or, if the offense is related to the whole theme file:
+      add_offense("Describe the problem...", theme_file: node.theme_file)
     end
 
     def on_assign(node)
@@ -50,7 +50,7 @@ module ThemeCheck
       # Called for every `String` (including inside if conditions).
       if node.parent.block?
         # If parent is a block, `node.value` is a String written directly to the output when
-        # the template is rendered.
+        # the theme file is rendered.
       end
     end
 
@@ -59,7 +59,7 @@ module ThemeCheck
     end
 
     def on_error(exception)
-      # Called each time a Liquid exception is raised while parsing the template
+      # Called each time a Liquid exception is raised while parsing the theme file
     end
 
     def on_end

data/docs/checks/convert_include_to_render.md

@@ -2,7 +2,7 @@
 
 The `include` tag is [deprecated][deprecated]. This tag exists to enforce the use of the `render` tag instead of `include`.
 
-The `include` tag works similarly to the `render` tag, but it lets the code inside of the snippet to access and overwrite the variables within its parent template. The `include` tag has been deprecated because the way that it handles variables reduces performance and makes theme code harder to both read and maintain.
+The `include` tag works similarly to the `render` tag, but it lets the code inside of the snippet to access and overwrite the variables within its parent theme file. The `include` tag has been deprecated because the way that it handles variables reduces performance and makes theme code harder to both read and maintain.
 
 ## Check Details
 

data/docs/checks/missing_enable_comment.md

@@ -1,6 +1,6 @@
 # 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.
+When `theme-check-disable` is used in the middle of a theme file, the corresponding `theme-check-enable` comment should also be included.
 
 ## Check Details
 

data/lib/theme_check/analyzer.rb

@@ -32,12 +32,12 @@ module ThemeCheck
     def analyze_theme
       reset
 
-      liquid_visitor = Visitor.new(@liquid_checks, @disabled_checks)
+      liquid_visitor = LiquidVisitor.new(@liquid_checks, @disabled_checks)
       html_visitor = HtmlVisitor.new(@html_checks)
       ThemeCheck.with_liquid_c_disabled do
-        @theme.liquid.each do |template|
-          liquid_visitor.visit_template(template)
-          html_visitor.visit_template(template)
+        @theme.liquid.each do |liquid_file|
+          liquid_visitor.visit_liquid_file(liquid_file)
+          html_visitor.visit_liquid_file(liquid_file)
         end
       end
 
@@ -51,23 +51,23 @@ module ThemeCheck
 
       ThemeCheck.with_liquid_c_disabled do
         # Call all checks that run on the whole theme
-        liquid_visitor = Visitor.new(@liquid_checks.whole_theme, @disabled_checks)
+        liquid_visitor = LiquidVisitor.new(@liquid_checks.whole_theme, @disabled_checks)
         html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
-        @theme.liquid.each do |template|
-          liquid_visitor.visit_template(template)
-          html_visitor.visit_template(template)
+        @theme.liquid.each do |liquid_file|
+          liquid_visitor.visit_liquid_file(liquid_file)
+          html_visitor.visit_liquid_file(liquid_file)
         end
         @theme.json.each { |json_file| @json_checks.whole_theme.call(:on_file, json_file) }
 
         # Call checks that run on a single files, only on specified file
-        liquid_visitor = Visitor.new(@liquid_checks.single_file, @disabled_checks)
+        liquid_visitor = LiquidVisitor.new(@liquid_checks.single_file, @disabled_checks)
         html_visitor = HtmlVisitor.new(@html_checks.single_file)
-        files.each do |file|
-          if file.liquid?
-            liquid_visitor.visit_template(file)
-            html_visitor.visit_template(file)
-          elsif file.json?
-            @json_checks.single_file.call(:on_file, file)
+        files.each do |theme_file|
+          if theme_file.liquid?
+            liquid_visitor.visit_liquid_file(theme_file)
+            html_visitor.visit_liquid_file(theme_file)
+          elsif theme_file.json?
+            @json_checks.single_file.call(:on_file, theme_file)
           end
         end
       end
@@ -86,6 +86,11 @@ module ThemeCheck
     def correct_offenses
       if @auto_correct
         offenses.each(&:correct)
+      end
+    end
+
+    def write_corrections
+      if @auto_correct
         @theme.liquid.each(&:write)
         @theme.json.each(&:write)
       end

data/lib/theme_check/asset_file.rb

@@ -9,10 +9,21 @@ module ThemeCheck
       @content = nil
     end
 
-    alias_method :content, :source
+    def rewriter
+      @rewriter ||= ThemeFileRewriter.new(@relative_path, source)
+    end
+
+    def write
+      content = rewriter.to_s
+      if source != content
+        @storage.write(@relative_path, content.gsub("\n", @eol))
+        @source = content
+        @rewriter = nil
+      end
+    end
 
     def gzipped_size
-      @gzipped_size ||= Zlib.gzip(content).bytesize
+      @gzipped_size ||= Zlib.gzip(source).bytesize
     end
 
     def name

data/lib/theme_check/check.rb

@@ -46,7 +46,7 @@ module ThemeCheck
       end
 
       def severity_value(severity)
-        SEVERITY_VALUES[severity]
+        SEVERITY_VALUES[severity] || -1
       end
 
       def categories(*categories)
@@ -91,8 +91,8 @@ module ThemeCheck
       @offenses ||= []
     end
 
-    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, node_markup_offset: 0, &block)
-      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, node_markup_offset: node_markup_offset, correction: block)
+    def add_offense(message, node: nil, theme_file: node&.theme_file, markup: nil, line_number: nil, node_markup_offset: 0, &block)
+      offenses << Offense.new(check: self, message: message, theme_file: theme_file, node: node, markup: markup, line_number: line_number, node_markup_offset: node_markup_offset, correction: block)
     end
 
     def severity

data/lib/theme_check/checks/asset_size_css.rb

@@ -22,5 +22,20 @@ module ThemeCheck
         node: node
       )
     end
+
+    def href_to_file_size(href)
+      # asset_url (+ optional stylesheet_tag) variables
+      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{^(https?:)?//}
+        asset = RemoteAssetFile.from_src(href)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/asset_size_css_stylesheet_tag.rb

@@ -13,12 +13,29 @@ module ThemeCheck
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }
       return unless used_filters.include?("stylesheet_tag")
-      file_size = href_to_file_size('{{' + node.markup + '}}')
+      file_size = stylesheet_tag_pipeline_to_file_size(node.markup)
+      return if file_size.nil?
       return if file_size <= @threshold_in_bytes
       add_offense(
         "CSS on every page load exceeding compressed size threshold (#{@threshold_in_bytes} Bytes).",
         node: node
       )
     end
+
+    def stylesheet_tag_pipeline_to_file_size(href)
+      # asset_url
+      if href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{(https?:)?//[^'"]+}
+        url = Regexp.last_match(0)
+        asset = RemoteAssetFile.from_src(url)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -8,7 +8,8 @@ module ThemeCheck
 
     def on_include(node)
       add_offense("`include` is deprecated - convert it to `render`", node: node) do |corrector|
-        corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
+        # We need to fix #445 and pass the variables from the context or don't replace at all.
+        # corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
       end
     end
   end

data/lib/theme_check/checks/html_parsing_error.rb

@@ -5,8 +5,8 @@ module ThemeCheck
     category :html
     doc docs_url(__FILE__)
 
-    def on_parse_error(exception, template)
-      add_offense("HTML in this template can not be parsed: #{exception.message}", template: template)
+    def on_parse_error(exception, theme_file)
+      add_offense("HTML in this template can not be parsed: #{exception.message}", theme_file: theme_file)
     end
   end
 end

data/lib/theme_check/checks/liquid_tag.rb

@@ -13,7 +13,7 @@ module ThemeCheck
     end
 
     def on_tag(node)
-      if !node.inside_liquid_tag?
+      if node.inside_liquid_tag?
         reset_consecutive_statements
       # Ignore comments
       elsif !node.comment?

data/lib/theme_check/checks/matching_translations.rb

@@ -23,7 +23,7 @@ module ThemeCheck
 
       @files.each do |file|
         diff = LocaleDiff.new(@theme.default_locale_json.content, file.content)
-        diff.add_as_offenses(self, template: file)
+        diff.add_as_offenses(self, theme_file: file)
       end
     end
   end

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -9,19 +9,33 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     REQUIRED_LIQUID_FILES = %w(layout/theme)
-    REQUIRED_TEMPLATE_FILES = %w(
-      index product collection cart blog article page list-collections search 404
+
+    REQUIRED_LIQUID_TEMPLATE_FILES = %w(
       gift_card customers/account customers/activate_account customers/addresses
-      customers/login customers/order customers/register customers/reset_password password
-    )
-      .map { |file| "templates/#{file}" }
+      customers/login customers/order customers/register customers/reset_password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_JSON_TEMPLATE_FILES = %w(
+      index product collection cart blog article page list-collections search 404
+      password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_TEMPLATE_FILES = (REQUIRED_LIQUID_TEMPLATE_FILES + REQUIRED_JSON_TEMPLATE_FILES)
 
     def on_end
       (REQUIRED_LIQUID_FILES - theme.liquid.map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' is missing")
+        add_offense("'#{file}.liquid' is missing") do |corrector|
+          corrector.create(@theme, "#{file}.liquid", "")
+        end
       end
       (REQUIRED_TEMPLATE_FILES - (theme.liquid + theme.json).map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' or '#{file}.json' is missing")
+        add_offense("'#{file}.liquid' or '#{file}.json' is missing") do |corrector|
+          if REQUIRED_LIQUID_TEMPLATE_FILES.include?(file)
+            corrector.create(@theme, "#{file}.liquid", "")
+          else
+            corrector.create(@theme, "#{file}.json", "")
+          end
+        end
       end
     end
   end

data/lib/theme_check/checks/missing_template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module ThemeCheck
-  # Reports missing include/render/section template
+  # Reports missing include/render/section liquid file
   class MissingTemplate < LiquidCheck
     severity :suggestion
     category :liquid
@@ -12,17 +12,17 @@ module ThemeCheck
     end
 
     def on_include(node)
-      template = node.value.template_name_expr
-      if template.is_a?(String)
-        add_missing_offense("snippets/#{template}", node: node)
+      snippet = node.value.template_name_expr
+      if snippet.is_a?(String)
+        add_missing_offense("snippets/#{snippet}", node: node)
       end
     end
 
     alias_method :on_render, :on_include
 
     def on_section(node)
-      template = node.value.section_name
-      add_missing_offense("sections/#{template}", node: node)
+      section = node.value.section_name
+      add_missing_offense("sections/#{section}", node: node)
     end
 
     private