theme-check 1.6.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e992338f154cdf5da965bae74af6907af89156170b5bdcf599f8f15b9708bb87
-  data.tar.gz: 27071bf8d98359410d2486a62502f2e7453465771b932a77a6c27785ba00abbb
+  metadata.gz: e8f59cffd194662dc9f66474d70310caeec0a713a3029c92efaefbf605ee69bc
+  data.tar.gz: 7bc65dd34a4b387c13cb0395d3d1cec4d60095a7ba2c3e6fa8fc5fa50bea2df8
 SHA512:
-  metadata.gz: 33969efb3cc9bd670ce7a15a419e7419824e8e48ab5951e1f527f116e3aec42ca01c214eb50cd0eb1058fd6c5975c353f3b84024b990dcbad3a45f27cbb9380f
-  data.tar.gz: 410dd3f410c5dd0fe23533eae5716d8bfefec6fd4bc57e68c77dfe14832e7c498854d2dc6728b25467188d887860d97d92747cf915ab1c669f40226b46a371ad
+  metadata.gz: 2ed214b8d5abb83dd3b9ede347fc52f6ed4cce4ddc42b2e0879c24e54b21c0ff30055b5ac8b3e45c3fa5da9efc5da5343c168c6cd818af863d5a73e4841b796b
+  data.tar.gz: 8777e953d57ae33ce11c8bd527e061567ddc179dad28c612d1c7e6f80dd8a5d2534e786b86d5f55d944695c10c08f34b3aeb26057700b50b7b6642fbf8007290

data/CHANGELOG.md

@@ -1,4 +1,41 @@
 
+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
+===================
+
+  * Fixup a multithreading problem with our IO Messenger (regression from 1.7.1) ([#468](https://github.com/shopify/theme-check/issues/468))
+
+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
 ===================
 

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/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/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/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 = LiquidVisitor.new(@liquid_checks, @disabled_checks)
       html_visitor = HtmlVisitor.new(@html_checks)
+
       ThemeCheck.with_liquid_c_disabled do
-        @theme.liquid.each do |liquid_file|
+        @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
@@ -53,16 +70,23 @@ module ThemeCheck
         # Call all checks that run on the whole theme
         liquid_visitor = LiquidVisitor.new(@liquid_checks.whole_theme, @disabled_checks)
         html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
-        @theme.liquid.each do |liquid_file|
+        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 { |json_file| @json_checks.whole_theme.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) if block_given?
+          @json_checks.whole_theme.call(:on_file, json_file)
+        end
 
         # Call checks that run on a single files, only on specified file
         liquid_visitor = LiquidVisitor.new(@liquid_checks.single_file, @disabled_checks)
         html_visitor = HtmlVisitor.new(@html_checks.single_file)
-        files.each do |theme_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)

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/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/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/exceptions.rb

@@ -22,6 +22,7 @@ module ThemeCheck
     Errno::EAGAIN,
     Errno::EHOSTUNREACH,
     Errno::ENETUNREACH,
+    Errno::EADDRNOTAVAIL,
   ]
 
   NET_HTTP_EXCEPTIONS = [

data/lib/theme_check/file_system_storage.rb

@@ -11,6 +11,10 @@ module ThemeCheck
       @files = {}
     end
 
+    def relative_path(absolute_path)
+      Pathname.new(absolute_path).relative_path_from(@root).to_s
+    end
+
     def path(relative_path)
       @root.join(relative_path)
     end

data/lib/theme_check/language_server/bridge.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+# This class exists as a bridge (or boundary) between our handlers and the outside world.
+#
+# It is concerned with all the Language Server Protocol constructs. i.e.
+#
+#   - sending Hash messages as JSON
+#   - reading JSON messages as Hashes
+#   - preparing, sending and resolving requests
+#   - preparing and sending responses
+#   - preparing and sending notifications
+#   - preparing and sending progress notifications
+#
+# But it _not_ concerned by _how_ those messages are sent to the
+# outside world. That's the job of the messenger.
+#
+# This enables us to have all the language server protocol logic
+# in here living independently of how we communicate with the
+# client (STDIO or websocket)
+module ThemeCheck
+  module LanguageServer
+    class Bridge
+      attr_writer :supports_work_done_progress
+
+      def initialize(messenger)
+        # The messenger is responsible for IO.
+        # Could be STDIO or WebSockets or Mock.
+        @messenger = messenger
+
+        # Whether the client supports work done progress notifications
+        @supports_work_done_progress = false
+      end
+
+      def log(message)
+        @messenger.log(message)
+      end
+
+      def read_message
+        message_body = @messenger.read_message
+        message_json = JSON.parse(message_body)
+        @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 ThemeCheck.debug?
+        @messenger.send_message(message_body)
+      end
+
+      # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#requestMessage
+      def send_request(method, params = nil)
+        channel = Channel.create
+        message = { id: channel.id }
+        message[:method] = method
+        message[:params] = params if params
+        send_message(message)
+        channel.pop
+      ensure
+        channel.close
+      end
+
+      def receive_response(id, result)
+        Channel.by_id(id) << result
+      end
+
+      # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#responseMessage
+      def send_response(id, result = nil, error = nil)
+        message = { id: id }
+        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 }
+        message[:params] = params
+        send_message(message)
+      end
+
+      # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#progress
+      def send_progress(token, value)
+        send_notification("$/progress", token: token, value: value)
+      end
+
+      def supports_work_done_progress?
+        @supports_work_done_progress
+      end
+
+      def send_create_work_done_progress_request(token)
+        return unless supports_work_done_progress?
+        send_request("window/workDoneProgress/create", {
+          token: token,
+        })
+      end
+
+      def send_work_done_progress_begin(token, title)
+        return unless supports_work_done_progress?
+        send_progress(token, {
+          kind: 'begin',
+          title: title,
+          cancellable: false,
+          percentage: 0,
+        })
+      end
+
+      def send_work_done_progress_report(token, message, percentage)
+        return unless supports_work_done_progress?
+        send_progress(token, {
+          kind: 'report',
+          message: message,
+          cancellable: false,
+          percentage: percentage,
+        })
+      end
+
+      def send_work_done_progress_end(token, message)
+        return unless supports_work_done_progress?
+        send_progress(token, {
+          kind: 'end',
+          message: message,
+        })
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/channel.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    # How you'd use this class:
+    #
+    # In thread #1:
+    #   def foo
+    #     chan = Channel.create
+    #     send_request(chan.id, ...)
+    #     result = chan.pop
+    #     do_stuff_with_result(result)
+    #   ensure
+    #     chan.close
+    #   end
+    #
+    # In thread #2:
+    #   Channel.by_id(id) << result
+    class Channel
+      MUTEX = Mutex.new
+      CHANNELS = {}
+
+      class << self
+        def create
+          id = new_id
+          CHANNELS[id] = new(id)
+          CHANNELS[id]
+        end
+
+        def by_id(id)
+          CHANNELS[id]
+        end
+
+        def close(id)
+          CHANNELS.delete(id)
+        end
+
+        private
+
+        def new_id
+          MUTEX.synchronize do
+            @id ||= 0
+            @id += 1
+          end
+        end
+      end
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+        @response = SizedQueue.new(1)
+      end
+
+      def pop
+        @response.pop
+      end
+
+      def <<(value)
+        @response << value
+      end
+
+      def close
+        @response.close
+        Channel.close(id)
+      end
+    end
+  end
+end