theme-check 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769a14dbfbdd0c479d57aa5dc9992a74c99fbbfb9db3d34ee384abc75dbb1028
-  data.tar.gz: b1eea70f76270fe165543281f7ce34ca55bb9c1c7f47cc59006cb71cb13a1269
+  metadata.gz: e8f59cffd194662dc9f66474d70310caeec0a713a3029c92efaefbf605ee69bc
+  data.tar.gz: 7bc65dd34a4b387c13cb0395d3d1cec4d60095a7ba2c3e6fa8fc5fa50bea2df8
 SHA512:
-  metadata.gz: '0197cae7eef9470beeadd192d3767a6f852ebcc89f53039cec52956ffd9b6d22bdd1b976762955b974bb8836f84f702e97aa1fdec480028e52c9f4822130ec17'
-  data.tar.gz: 7f2da4367e81879e6109ee2b411c01f3b55440d69ec048189f1909913c22bf02f0b802109bd98af75be3bf2590bf54e1c918fddc6e9763baded0e7b3539d59fb
+  metadata.gz: 2ed214b8d5abb83dd3b9ede347fc52f6ed4cce4ddc42b2e0879c24e54b21c0ff30055b5ac8b3e45c3fa5da9efc5da5343c168c6cd818af863d5a73e4841b796b
+  data.tar.gz: 8777e953d57ae33ce11c8bd527e061567ddc179dad28c612d1c7e6f80dd8a5d2534e786b86d5f55d944695c10c08f34b3aeb26057700b50b7b6642fbf8007290

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+v1.8.0 / 2021-11-09
+===================
+
+## Features
+
+**New corrections for the following checks:**
+
+  * `MissingRequiredTemplateFiles` ([#462](https://github.com/shopify/theme-check/issues/462))
+  * `RequiredLayoutThemeObject` ([#484](https://github.com/shopify/theme-check/issues/484))
+  * `UnusedAssign` ([#380](https://github.com/shopify/theme-check/issues/380))
+
+## Fixes
+
+  * Add support for `preload_tag` filter
+  * Minor Language Server improvements (close logs) ([#472](https://github.com/shopify/theme-check/issues/472))
+
 v1.7.2 / 2021-09-24
 ===================
 

data/data/shopify_liquid/filters.yml

@@ -81,6 +81,7 @@ UrlFilter:
 - product_img_url
 - collection_img_url
 - article_img_url
+- preload_tag
 JsonFilter:
 - json
 ColorFilter:

data/docs/checks/TEMPLATE.md.erb

@@ -1,47 +1,52 @@
 # Check Title (`<%= class_name %>`)
 
-A brief paragraph explaining why the check exists.
+_Version THEME_CHECK_VERSION+_
 
-## Check Details
+A short description of what the check does.
 
-This check is aimed at eliminating ...
+A brief paragraph explaining why the check exists (what best practice is it enforcing, and why is it important?).
 
-:-1: Examples of **incorrect** code for this check:
+## Examples
+
+The following examples contain code snippets that either fail or pass this check.
+
+### &#x2717; Fail
 
 ```liquid
 ```
 
-:+1: Examples of **correct** code for this check:
+### &#x2713; Pass
 
 ```liquid
 ```
 
-## Check Options
+## Options
 
-The default configuration for this check is the following:
+The following example contains the default configuration for this check:
 
 ```yaml
 <%= class_name %>:
-  enabled: true
-  some_option: 10
+  enabled: false
+  severity: suggestion
+  other_option: 10_000
 ```
 
-### `some_option`
-
-The `some_option` option (Default: `10`) determines ...
-
-## When Not To Use It
+| Parameter | Description |
+| --- | --- |
+| enabled | Whether the check is enabled. |
+| severity | The [severity](https://shopify.developers/themes/tools/theme-check/configuration#check-severity) of the check. |
+| other_option | A description of the option. |
 
-If you don't want to ..., then it's safe to disable this rule.
+## Disabling this check
 
-## Version
+[ This check is safe to disable. You might want to disable this check if ... | Disabling this check isn't recommended because ... ].
 
-This check has been introduced in Theme Check THEME_CHECK_VERSION.
+[ This check is disabled by default when <condition>. ]
 
 ## Resources
 
-- [Rule Source][codesource]
-- [Documentation Source][docsource]
+- [Rule source][codesource]
+- [Documentation source][docsource]
 
 [codesource]: /<%= code_source %>
 [docsource]: /<%= doc_source %>

data/exe/theme-check-language-server

@@ -3,9 +3,5 @@
 
 require 'theme_check'
 
-if ENV["THEME_CHECK_DEBUG"] == "true"
-  $DEBUG = true
-end
-
 status_code = ThemeCheck::LanguageServer.start
 exit! status_code

data/lib/theme_check/checks/matching_schema_translations.rb

@@ -7,7 +7,6 @@ module ThemeCheck
 
     def on_schema(node)
       schema = JSON.parse(node.value.nodelist.join)
-
       # Get all locales used in the schema
       used_locales = Set.new([theme.default_locale])
       visit_object(schema) do |_, locales|
@@ -19,11 +18,17 @@ module ThemeCheck
       visit_object(schema) do |key, locales|
         missing = used_locales - locales
         if missing.any?
-          add_offense("#{key} missing translations for #{missing.join(', ')}", node: node)
+          add_offense("#{key} missing translations for #{missing.join(', ')}", node: node) do |corrector|
+            key = key.split(".")
+            missing.each do |language|
+              corrector.schema_corrector(schema, key + [language], "TODO")
+            end
+            corrector.replace_block_body(node, schema)
+          end
         end
       end
 
-      check_locales(schema["locales"], node: node)
+      check_locales(schema, node: node)
 
     rescue JSON::ParserError
       # Ignored, handled in ValidSchema.
@@ -31,14 +36,16 @@ module ThemeCheck
 
     private
 
-    def check_locales(locales, node:)
+    def check_locales(schema, node:)
+      locales = schema["locales"]
       return unless locales.is_a?(Hash)
 
       default_locale = locales[theme.default_locale]
+
       if default_locale
         locales.each_pair do |name, content|
           diff = LocaleDiff.new(default_locale, content)
-          diff.add_as_offenses(self, key_prefix: ["locales", name], node: node)
+          diff.add_as_offenses(self, key_prefix: ["locales", name], node: node, schema: schema)
         end
       else
         add_offense("Missing default locale in key: locales", node: node)

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -27,14 +27,19 @@ module ThemeCheck
     def after_document(node)
       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
+      add_missing_object_offense("content_for_layout", "</body>") unless @content_for_layout_found
+      add_missing_object_offense("content_for_header", "</head>") unless @content_for_header_found
     end
 
     private
 
-    def add_missing_object_offense(name)
-      add_offense("#{LAYOUT_FILENAME} must include {{#{name}}}", node: @layout_theme_node)
+    def add_missing_object_offense(name, tag)
+      add_offense("#{LAYOUT_FILENAME} must include {{#{name}}}", node: @layout_theme_node) do
+        if @layout_theme_node.source.index(tag)
+          @layout_theme_node.source.insert(@layout_theme_node.source.index(tag), "  {{ #{name} }}\n  ")
+          @layout_theme_node.markup = @layout_theme_node.source
+        end
+      end
     end
   end
 end

data/lib/theme_check/checks/unused_assign.rb

@@ -46,8 +46,9 @@ module ThemeCheck
       @templates.each_pair do |_, info|
         used = info.collect_used_assigns(@templates)
         info.assign_nodes.each_pair do |name, node|
-          unless used.include?(name)
-            add_offense("`#{name}` is never used", node: node)
+          next if used.include?(name)
+          add_offense("`#{name}` is never used", node: node) do |corrector|
+            corrector.remove(node)
           end
         end
       end

data/lib/theme_check/checks/unused_snippet.rb

@@ -25,7 +25,7 @@ module ThemeCheck
     def on_end
       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)
+          corrector.remove_file(@theme, theme_file.relative_path.to_s)
         end
       end
     end

data/lib/theme_check/corrector.rb

@@ -14,11 +14,20 @@ module ThemeCheck
       @theme_file.rewriter.insert_before(node, content)
     end
 
+    def remove(node)
+      @theme_file.rewriter.remove(node)
+    end
+
     def replace(node, content)
       @theme_file.rewriter.replace(node, content)
       node.markup = content
     end
 
+    def replace_block_body(node, content)
+      content = "\n  #{JSON.pretty_generate(content, array_nl: "\n  ", object_nl: "\n  ")}\n" if content.is_a?(Hash)
+      @theme_file.rewriter.replace_body(node, content)
+    end
+
     def wrap(node, insert_before, insert_after)
       @theme_file.rewriter.wrap(node, insert_before, insert_after)
     end
@@ -28,11 +37,11 @@ module ThemeCheck
     end
 
     def create_default_locale_json(theme)
+      create(theme, "locales/#{theme.default_locale}.default.json", {})
       theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
-      theme.default_locale_json.update_contents({})
     end
 
-    def remove(theme, relative_path)
+    def remove_file(theme, relative_path)
       theme.storage.remove(relative_path)
     end
 
@@ -42,12 +51,40 @@ module ThemeCheck
 
     def add_default_translation_key(file, key, value)
       hash = file.content
+      add_key(hash, key, value)
+      file.update_contents(hash)
+    end
+
+    def remove_key(hash, key)
+      key.reduce(hash) do |pointer, token|
+        return pointer.delete(token) if token == key.last
+        pointer[token]
+      end
+    end
+
+    def add_key(hash, key, value)
       key.reduce(hash) do |pointer, token|
         return pointer[token] = value if token == key.last
         pointer[token] = {} unless pointer.key?(token)
         pointer[token]
       end
-      file.update_contents(hash)
+    end
+
+    def schema_corrector(schema, key, value)
+      return unless schema.is_a?(Hash)
+      key.reduce(schema) do |pointer, token|
+        case pointer
+        when Array
+          pointer.each do |item|
+            schema_corrector(item, key.drop(1), value)
+          end
+
+        when Hash
+          return pointer[token] = value if token == key.last
+          pointer[token] = {} unless pointer.key?(token) || pointer.key?("id")
+          pointer[token].nil? && pointer["id"] == token ? pointer : pointer[token]
+        end
+      end
     end
   end
 end

data/lib/theme_check/language_server/bridge.rb

@@ -38,14 +38,14 @@ module ThemeCheck
       def read_message
         message_body = @messenger.read_message
         message_json = JSON.parse(message_body)
-        @messenger.log(JSON.pretty_generate(message_json)) if $DEBUG
+        @messenger.log(JSON.pretty_generate(message_json)) if ThemeCheck.debug?
         message_json
       end
 
       def send_message(message_hash)
         message_hash[:jsonrpc] = '2.0'
         message_body = JSON.dump(message_hash)
-        @messenger.log(JSON.pretty_generate(message_hash)) if $DEBUG
+        @messenger.log(JSON.pretty_generate(message_hash)) if ThemeCheck.debug?
         @messenger.send_message(message_body)
       end
 
@@ -68,11 +68,25 @@ module ThemeCheck
       # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#responseMessage
       def send_response(id, result = nil, error = nil)
         message = { id: id }
-        message[:result] = result if result
-        message[:error] = error if error
+        if error
+          message[:error] = error
+        else
+          message[:result] = result
+        end
         send_message(message)
       end
 
+      # https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#responseError
+      def send_internal_error(id, e)
+        send_response(id, nil, {
+          code: ErrorCodes::INTERNAL_ERROR,
+          message: <<~EOS,
+            #{e.class}: #{e.message}
+              #{e.backtrace.join("\n  ")}
+          EOS
+        })
+      end
+
       # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
       def send_notification(method, params)
         message = { method: method }

data/lib/theme_check/language_server/handler.rb

@@ -47,10 +47,13 @@ module ThemeCheck
         })
       end
 
+      def on_shutdown(id, _params)
+        @bridge.send_response(id, nil)
+      end
+
       def on_exit(_id, _params)
         close!
       end
-      alias_method :on_shutdown, :on_exit
 
       def on_text_document_did_change(_id, params)
         relative_path = relative_path_from_text_document_uri(params)

data/lib/theme_check/language_server/io_messenger.rb

@@ -40,6 +40,8 @@ module ThemeCheck
           content += chunk
         end
         content.lstrip!
+      rescue IOError
+        raise DoneStreaming
       end
 
       def send_message(message_body)

data/lib/theme_check/language_server/protocol.rb

@@ -37,5 +37,9 @@ module ThemeCheck
       FULL = 1
       INCREMENTAL = 2
     end
+
+    module ErrorCodes
+      INTERNAL_ERROR = -32603
+    end
   end
 end

data/lib/theme_check/language_server/server.rb

@@ -37,7 +37,7 @@ module ThemeCheck
         @handlers = []
 
         # The error queue holds blocks the main thread. When filled, we exit the program.
-        @error = SizedQueue.new(1)
+        @error = SizedQueue.new(number_of_threads)
 
         @should_raise_errors = should_raise_errors
       end
@@ -94,8 +94,7 @@ module ThemeCheck
 
       rescue Exception => e # rubocop:disable Lint/RescueException
         raise e if should_raise_errors
-        @bridge.log(e)
-        @bridge.log(e.backtrace)
+        @bridge.log("#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
         2
       end
 
@@ -110,6 +109,15 @@ module ThemeCheck
         if @handler.respond_to?(method_name)
           @handler.send(method_name, id, params)
         end
+
+      rescue DoneStreaming => e
+        raise e
+      rescue StandardError => e
+        is_request = id
+        raise e unless is_request
+        # Errors obtained in request handlers should be sent
+        # back as internal errors instead of closing the program.
+        @bridge.send_internal_error(id, e)
       end
 
       def handle_response(message)
@@ -135,7 +143,16 @@ module ThemeCheck
 
         # Hijack the status_code if an error occurred while cleaning up.
         # 👀 unit tests.
-        return status_code_from_error(@error.pop) unless @error.empty?
+        until @error.empty?
+          code = status_code_from_error(@error.pop)
+          # Promote the status_code to ERROR if one of the threads
+          # resulted in an error, otherwise leave the status_code as
+          # is. That's because one thread could end successfully in a
+          # DoneStreaming error while the other failed with an
+          # internal error. If we had an internal error, we should
+          # return with a status_code that fits.
+          status_code = code if code > status_code
+        end
         status_code
       ensure
         @messenger.close_output

data/lib/theme_check/liquid_node.rb

@@ -74,6 +74,34 @@ module ThemeCheck
       position.end_index
     end
 
+    def start_token_index
+      return position.start_index if inside_liquid_tag?
+      position.start_index - (start_token.length + 1)
+    end
+
+    def end_token_index
+      return position.end_index if inside_liquid_tag?
+      position.end_index + end_token.length
+    end
+
+    def render_start_tag
+      "#{start_token} #{@value.raw}#{end_token}"
+    end
+
+    def render_end_tag
+      "#{start_token} #{@value.block_delimiter} #{end_token}"
+    end
+
+    def block_body_start_index
+      return unless block_tag?
+      block_regex.begin(:body)
+    end
+
+    def block_body_end_index
+      return unless block_tag?
+      block_regex.end(:body)
+    end
+
     # Literals are hard-coded values in the liquid file.
     def literal?
       @value.is_a?(String) || @value.is_a?(Integer)
@@ -184,6 +212,11 @@ module ThemeCheck
 
     private
 
+    def block_regex
+      return unless block_tag?
+      /(?<start_token>#{render_start_tag})(?<body>.*)(?<end_token>#{render_end_tag})/m.match(source)
+    end
+
     def position
       @position ||= Position.new(
         markup,

data/lib/theme_check/locale_diff.rb

@@ -14,24 +14,43 @@ module ThemeCheck
       visit_object(@default, @other, [])
     end
 
-    def add_as_offenses(check, key_prefix: [], node: nil, theme_file: nil)
+    def add_as_offenses(check, key_prefix: [], node: nil, theme_file: nil, schema: {})
       if extra_keys.any?
-        add_keys_offense(check, "Extra translation keys", extra_keys,
-          key_prefix: key_prefix, node: node, theme_file: theme_file)
+        remove_extra_keys_offense(check, "Extra translation keys", extra_keys,
+          key_prefix: key_prefix, node: node, theme_file: theme_file, schema: schema)
       end
 
       if missing_keys.any?
-        add_keys_offense(check, "Missing translation keys", missing_keys,
-          key_prefix: key_prefix, node: node, theme_file: theme_file)
+        add_missing_keys_offense(check, "Missing translation keys", missing_keys,
+          key_prefix: key_prefix, node: node, theme_file: theme_file, schema: schema)
       end
     end
 
     private
 
-    def add_keys_offense(check, cause, keys, key_prefix:, node: nil, theme_file: nil)
-      message = "#{cause}: #{format_keys(key_prefix, keys)}"
+    def remove_extra_keys_offense(check, cause, extra_keys, key_prefix:, node: nil, theme_file: nil, schema: {})
+      message = "#{cause}: #{format_keys(key_prefix, extra_keys)}"
       if node
-        check.add_offense(message, node: node)
+        check.add_offense(message, node: node) do |corrector|
+          extra_keys.each do |k|
+            corrector.remove_key(schema, key_prefix + k)
+          end
+          corrector.replace_block_body(node, schema)
+        end
+      else
+        check.add_offense(message, theme_file: theme_file)
+      end
+    end
+
+    def add_missing_keys_offense(check, cause, missing_keys, key_prefix:, node: nil, theme_file: nil, schema: {})
+      message = "#{cause}: #{format_keys(key_prefix, missing_keys)}"
+      if node
+        check.add_offense(message, node: node) do |corrector|
+          missing_keys.each do |k|
+            corrector.add_key(schema, key_prefix + k, "TODO")
+          end
+          corrector.replace_block_body(node, schema)
+        end
       else
         check.add_offense(message, theme_file: theme_file)
       end

data/lib/theme_check/position.rb

@@ -64,6 +64,10 @@ module ThemeCheck
       strict_position.end_column
     end
 
+    def content_line_count
+      @content_line_count ||= contents.count("\n")
+    end
+
     private
 
     def compute_start_offset
@@ -78,10 +82,6 @@ module ThemeCheck
       @contents
     end
 
-    def content_line_count
-      @content_line_count ||= contents.count("\n")
-    end
-
     def line_number
       return 0 if @line_number_1_indexed.nil?
       bounded(0, @line_number_1_indexed - 1, content_line_count)

data/lib/theme_check/tags.rb

@@ -66,7 +66,6 @@ module ThemeCheck
 
       def initialize(tag_name, markup, options)
         super
-
         if (matches = markup.match(SYNTAX))
           @liquid_variable_name = matches[:liquid_variable_name]
           @page_size = parse_expression(matches[:page_size])

data/lib/theme_check/theme_file_rewriter.rb

@@ -25,6 +25,12 @@ module ThemeCheck
       )
     end
 
+    def remove(node)
+      @rewriter.remove(
+        range(node.start_token_index, node.end_token_index)
+      )
+    end
+
     def replace(node, content)
       @rewriter.replace(
         range(node.start_index, node.end_index),
@@ -32,6 +38,13 @@ module ThemeCheck
       )
     end
 
+    def replace_body(node, content)
+      @rewriter.replace(
+        range(node.block_body_start_index, node.block_body_end_index),
+        content
+      )
+    end
+
     def wrap(node, insert_before, insert_after)
       @rewriter.wrap(
         range(node.start_index, node.end_index),

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "1.7.2"
+  VERSION = "1.8.0"
 end

data/lib/theme_check.rb

@@ -51,6 +51,10 @@ Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 module ThemeCheck
+  def self.debug?
+    ENV["THEME_CHECK_DEBUG"] == "true"
+  end
+
   def self.with_liquid_c_disabled
     if defined?(Liquid::C)
       was_enabled = Liquid::C.enabled

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid