theme-check 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713459ed0c35e11e175e51d42237fceb583184af08a00f8f56cdecbbb1c494b8
-  data.tar.gz: aa2059da0b820755eee1a8778748d7c7758fef705e29f5def5c74905743553d8
+  metadata.gz: 0c0071563941bd1e62d174c317667f7b1258a5154fdd0b9e65531a667aafbb53
+  data.tar.gz: fba3428de01a76fc042ee5c9fefe5acdcc1b446c02eafd5a2d187d503d863433
 SHA512:
-  metadata.gz: fa6216908fb067365d11ef7c0ea1c2e0a847de124f81ad43824eb49f9373093b6fc54dabbc1062dd9068af11724abc9dad020c6bebc2c71702f4750a8829aa78
-  data.tar.gz: f0412fbb0407d75e33ac96f66c760dd39ddb5cd18c751b8f6cb8a6edb4da1d0867147d929b7bae1401eb5837ee1c4aa0f40f60340d70c4a75c5f47a0753ebf58
+  metadata.gz: 9ebf3e7d3f24ca2d5d4f7b815199755bc997b94e870b3e60a2d24bc39f863974f7838f69548d11ccca9882335b3cf1522384b56f4bd3184d526ca968909cb192
+  data.tar.gz: dd9d5079b4adc9be6c13eb9cdf42e049e87988337e7881631eb0ee1163c8680930cb6efee863856221b1f8fd76fc81d9d848cd10969752f170cd032e371a42d0

data/CHANGELOG.md

@@ -1,4 +1,31 @@
 
+v1.7.1 / 2021-09-24
+===================
+
+  * Handle Errno::EADDRNOTAVAIL in RemoteAsset ([#465](https://github.com/shopify/theme-check/issues/465))
+  * Complete end tags ([#277](https://github.com/shopify/theme-check/issues/277))
+  * Do not flag shopify translations as missing or extra ([#407](https://github.com/shopify/theme-check/issues/407))
+
+v1.7.0 / 2021-09-20
+===================
+
+### Features
+
+  * Handle LSP messages concurrently in the Language Server ([#459](https://github.com/shopify/theme-check/issues/459))
+    * Adds progress reporting while checking (:eyes: VS Code status bar)
+    * Makes completions work while checking (more noticeable on Windows since ruby is 3x slower on Windows)
+
+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
 ===================
 

data/data/shopify_liquid/tags.yml

@@ -2,28 +2,28 @@
 - assign
 - break
 - capture
-- case
-- comment
+- case: endcase
+- comment: endcomment
 - continue
 - cycle
 - decrement
 - echo
 - else
 - elsif
-- for
-- form
-- if
+- for: endfor
+- form: endform
+- if: endif
 - ifchanged
 - increment
-- javascript
+- javascript: endjavascript
 - layout
 - liquid
-- paginate
+- paginate: endpaginate
 - raw
 - render
-- schema
+- schema: endschema
 - section
-- style
+- style: endstyle
 - stylesheet
 - tablerow
 - unless

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

@@ -29,19 +29,36 @@ module ThemeCheck
         @html_checks.flat_map(&:offenses)
     end
 
+    def json_file_count
+      @json_file_count ||= @theme.json.size
+    end
+
+    def liquid_file_count
+      @liquid_file_count ||= @theme.liquid.size
+    end
+
+    def total_file_count
+      json_file_count + liquid_file_count
+    end
+
     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_with_index do |liquid_file, i|
+          yield(liquid_file.relative_path.to_s, i, total_file_count) if block_given?
+          liquid_visitor.visit_liquid_file(liquid_file)
+          html_visitor.visit_liquid_file(liquid_file)
         end
       end
 
-      @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
+      @theme.json.each_with_index do |json_file, i|
+        yield(json_file.relative_path.to_s, liquid_file_count + i, total_file_count) if block_given?
+        @json_checks.call(:on_file, json_file)
+      end
 
       finish
     end
@@ -51,23 +68,30 @@ 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)
+        total = total_file_count + files.size
+        @theme.liquid.each_with_index do |liquid_file, i|
+          yield(liquid_file.relative_path.to_s, i, total) if block_given?
+          liquid_visitor.visit_liquid_file(liquid_file)
+          html_visitor.visit_liquid_file(liquid_file)
+        end
+
+        @theme.json.each_with_index do |json_file, i|
+          yield(json_file.relative_path.to_s, liquid_file_count + i, total) if block_given?
+          @json_checks.whole_theme.call(:on_file, json_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_with_index do |theme_file, i|
+          yield(theme_file.relative_path.to_s, total_file_count + i, total) if block_given?
+          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/translation_key_exists.rb

@@ -1,17 +1,5 @@
 # frozen_string_literal: true
 module ThemeCheck
-  module SystemTranslations
-    extend self
-
-    def translations
-      @translations ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_translation_keys.yml")).to_set
-    end
-
-    def include?(key)
-      translations.include?(key)
-    end
-  end
-
   class TranslationKeyExists < LiquidCheck
     severity :error
     category :translation
@@ -24,7 +12,7 @@ module ThemeCheck
       return unless (key_node = node.children.first)
       return unless key_node.value.is_a?(String)
 
-      unless key_exists?(key_node.value) || SystemTranslations.include?(key_node.value)
+      unless key_exists?(key_node.value) || ShopifyLiquid::SystemTranslations.include?(key_node.value)
         add_offense(
           "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}'",
           node: node,

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

data/lib/theme_check/checks.rb

@@ -47,9 +47,10 @@ module ThemeCheck
       raise
     rescue => e
       node = args.first
-      template = node.respond_to?(:template) ? node.template.relative_path : "?"
+      theme_file = node.respond_to?(:theme_file) ? node.theme_file.relative_path : "?"
       markup = node.respond_to?(:markup) ? node.markup : ""
       node_class = node.respond_to?(:value) ? node.value.class : "?"
+      line_number = node.respond_to?(:line_number) ? node.line_number : "?"
 
       ThemeCheck.bug(<<~EOS)
         Exception while running `#{check.code_name}##{method}`:
@@ -58,12 +59,13 @@ module ThemeCheck
           #{e.backtrace.join("\n  ")}
         ```
 
-        Template: `#{template}`
+        Theme File: `#{theme_file}`
         Node: `#{node_class}`
         Markup:
         ```
         #{markup}
         ```
+        Line number: #{line_number}
         Check options: `#{check.options.pretty_inspect}`
       EOS
     end

data/lib/theme_check/cli.rb

@@ -186,7 +186,7 @@ module ThemeCheck
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
-        raise Abort, "No templates found."
+        raise Abort, "No theme files found."
       end
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme

data/lib/theme_check/corrector.rb

@@ -2,25 +2,25 @@
 
 module ThemeCheck
   class Corrector
-    def initialize(template:)
-      @template = template
+    def initialize(theme_file:)
+      @theme_file = theme_file
     end
 
     def insert_after(node, content)
-      @template.rewriter.insert_after(node, content)
+      @theme_file.rewriter.insert_after(node, content)
     end
 
     def insert_before(node, content)
-      @template.rewriter.insert_before(node, content)
+      @theme_file.rewriter.insert_before(node, content)
     end
 
     def replace(node, content)
-      @template.rewriter.replace(node, content)
+      @theme_file.rewriter.replace(node, content)
       node.markup = content
     end
 
     def wrap(node, insert_before, insert_after)
-      @template.rewriter.wrap(node, insert_before, insert_after)
+      @theme_file.rewriter.wrap(node, insert_before, insert_after)
     end
 
     def create(theme, relative_path, content)