theme-check 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d1302267ab60bbc2471f2f22491a88b64f6021869064717bacaf79d39d31f97
-  data.tar.gz: d67dabb3456b2a9b6f06235962dab7fc74be3e4ffa0dc7582004c212bc98de6b
+  metadata.gz: e992338f154cdf5da965bae74af6907af89156170b5bdcf599f8f15b9708bb87
+  data.tar.gz: 27071bf8d98359410d2486a62502f2e7453465771b932a77a6c27785ba00abbb
 SHA512:
-  metadata.gz: 87f6c5f2418d5929ef94c59b718770d674206cf6fa1d2a3039789dd6dac8fbf1c31e53dc11c495808ee6ddae5ea796cfa2b8bc6b4734fdc7d37b8660703d2233
-  data.tar.gz: 14b5ed0c2444f3d42449a7f88a95e9e280997fa5d4893a16cca2472e918d70a9d26ce1c46977a7bb51e8d3e082f8240fac163c89c3c95e7dcd3cc57227d2b4ae
+  metadata.gz: 33969efb3cc9bd670ce7a15a419e7419824e8e48ab5951e1f527f116e3aec42ca01c214eb50cd0eb1058fd6c5975c353f3b84024b990dcbad3a45f27cbb9380f
+  data.tar.gz: 410dd3f410c5dd0fe23533eae5716d8bfefec6fd4bc57e68c77dfe14832e7c498854d2dc6728b25467188d887860d97d92747cf915ab1c669f40226b46a371ad

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+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
 ===================
 

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

data/lib/theme_check/asset_file.rb

@@ -10,7 +10,7 @@ module ThemeCheck
     end
 
     def rewriter
-      @rewriter ||= TemplateRewriter.new(@relative_path, source)
+      @rewriter ||= ThemeFileRewriter.new(@relative_path, source)
     end
 
     def write

data/lib/theme_check/check.rb

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

data/lib/theme_check/checks/nested_snippet.rb

@@ -26,12 +26,12 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @templates[node.template.name] = TemplateInfo.new(Set.new)
+      @templates[node.theme_file.name] = TemplateInfo.new(Set.new)
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @templates[node.template.name].includes << node
+        @templates[node.theme_file.name].includes << node
       end
     end
     alias_method :on_render, :on_include

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -14,7 +14,7 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @layout_theme_node = node if node.template.name == LAYOUT_FILENAME
+      @layout_theme_node = node if node.theme_file.name == LAYOUT_FILENAME
     end
 
     def on_variable(node)
@@ -25,7 +25,7 @@ module ThemeCheck
     end
 
     def after_document(node)
-      return unless node.template.name == LAYOUT_FILENAME
+      return unless node.theme_file.name == LAYOUT_FILENAME
 
       add_missing_object_offense("content_for_layout") unless @content_for_layout_found
       add_missing_object_offense("content_for_header") unless @content_for_header_found

data/lib/theme_check/checks/syntax_error.rb

@@ -7,23 +7,23 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_document(node)
-      node.template.warnings.each do |warning|
-        add_exception_as_offense(warning, template: node.template)
+      node.theme_file.warnings.each do |warning|
+        add_exception_as_offense(warning, theme_file: node.theme_file)
       end
     end
 
     def on_error(exception)
-      add_exception_as_offense(exception, template: theme[exception.template_name])
+      add_exception_as_offense(exception, theme_file: theme[exception.template_name])
     end
 
     private
 
-    def add_exception_as_offense(exception, template:)
+    def add_exception_as_offense(exception, theme_file:)
       add_offense(
         exception.to_s(false).sub(/ in ".*"$/, ''),
         line_number: exception.line_number,
         markup: exception.markup_context&.sub(/^in "(.*)"$/, '\1'),
-        template: template,
+        theme_file: theme_file,
       )
     end
   end

data/lib/theme_check/checks/template_length.rb

@@ -29,9 +29,9 @@ module ThemeCheck
     end
 
     def after_document(node)
-      lines = node.template.source.count("\n") - @excluded_lines
+      lines = node.theme_file.source.count("\n") - @excluded_lines
       if lines > @max_length
-        add_offense("Template has too many lines [#{lines}/#{@max_length}]", template: node.template)
+        add_offense("Template has too many lines [#{lines}/#{@max_length}]", theme_file: node.theme_file)
       end
     end
 

data/lib/theme_check/checks/undefined_object.rb

@@ -62,22 +62,22 @@ module ThemeCheck
 
     def on_document(node)
       return if ignore?(node)
-      @files[node.template.name] = TemplateInfo.new
+      @files[node.theme_file.name] = TemplateInfo.new
     end
 
     def on_assign(node)
       return if ignore?(node)
-      @files[node.template.name].all_assigns[node.value.to] = node
+      @files[node.theme_file.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
       return if ignore?(node)
-      @files[node.template.name].all_captures[node.value.instance_variable_get('@to')] = node
+      @files[node.theme_file.name].all_captures[node.value.instance_variable_get('@to')] = node
     end
 
     def on_for(node)
       return if ignore?(node)
-      @files[node.template.name].all_forloops[node.value.variable_name] = node
+      @files[node.theme_file.name].all_forloops[node.value.variable_name] = node
     end
 
     def on_include(_node)
@@ -90,7 +90,7 @@ module ThemeCheck
       return unless node.value.template_name_expr.is_a?(String)
 
       snippet_name = "snippets/#{node.value.template_name_expr}"
-      @files[node.template.name].add_render(
+      @files[node.theme_file.name].add_render(
         name: snippet_name,
         node: node,
       )
@@ -98,7 +98,7 @@ module ThemeCheck
 
     def on_variable_lookup(node)
       return if ignore?(node)
-      @files[node.template.name].add_variable_lookup(
+      @files[node.theme_file.name].add_variable_lookup(
         name: node.value.name,
         node: node,
       )
@@ -130,7 +130,7 @@ module ThemeCheck
     private
 
     def ignore?(node)
-      @exclude_snippets && node.template.snippet?
+      @exclude_snippets && node.theme_file.snippet?
     end
 
     def each_template

data/lib/theme_check/checks/unused_assign.rb

@@ -25,21 +25,21 @@ module ThemeCheck
     end
 
     def on_document(node)
-      @templates[node.template.name] = TemplateInfo.new(Set.new, {}, Set.new)
+      @templates[node.theme_file.name] = TemplateInfo.new(Set.new, {}, Set.new)
     end
 
     def on_assign(node)
-      @templates[node.template.name].assign_nodes[node.value.to] = node
+      @templates[node.theme_file.name].assign_nodes[node.value.to] = node
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @templates[node.template.name].includes << "snippets/#{node.value.template_name_expr}"
+        @templates[node.theme_file.name].includes << "snippets/#{node.value.template_name_expr}"
       end
     end
 
     def on_variable_lookup(node)
-      @templates[node.template.name].used_assigns << node.value.name
+      @templates[node.theme_file.name].used_assigns << node.value.name
     end
 
     def on_end

data/lib/theme_check/checks/unused_snippet.rb

@@ -8,30 +8,30 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def initialize
-      @used_templates = Set.new
+      @used_snippets = Set.new
     end
 
     def on_include(node)
       if node.value.template_name_expr.is_a?(String)
-        @used_templates << "snippets/#{node.value.template_name_expr}"
+        @used_snippets << "snippets/#{node.value.template_name_expr}"
       else
         # Can't reliably track unused snippets if an expression is used, ignore this check
-        @used_templates.clear
+        @used_snippets.clear
         ignore!
       end
     end
     alias_method :on_render, :on_include
 
     def on_end
-      missing_snippets.each do |template|
-        add_offense("This template is not used", template: template) do |corrector|
-          corrector.remove(@theme, template.relative_path.to_s)
+      missing_snippets.each do |theme_file|
+        add_offense("This snippet is not used", theme_file: theme_file) do |corrector|
+          corrector.remove(@theme, theme_file.relative_path.to_s)
         end
       end
     end
 
     def missing_snippets
-      theme.snippets.reject { |t| @used_templates.include?(t.name) }
+      theme.snippets.reject { |t| @used_snippets.include?(t.name) }
     end
   end
 end

data/lib/theme_check/checks/valid_json.rb

@@ -8,7 +8,7 @@ module ThemeCheck
     def on_file(file)
       if file.parse_error
         message = format_json_parse_error(file.parse_error)
-        add_offense(message, template: file)
+        add_offense(message, theme_file: file)
       end
     end
   end