theme-check 1.7.0 → 1.9.0

data/lib/theme_check/locale_diff.rb

@@ -14,24 +14,55 @@ 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|
+            SchemaHelper.delete(schema, key_prefix + k)
+          end
+          corrector.replace_inner_json(node, schema)
+        end
+      elsif theme_file.is_a?(JsonFile)
+        check.add_offense(message, theme_file: theme_file) do |corrector|
+          extra_keys.each do |k|
+            corrector.remove_translation(theme_file, key_prefix + k)
+          end
+        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|
+            SchemaHelper.set(schema, key_prefix + k, "TODO")
+          end
+          corrector.replace_inner_json(node, schema)
+        end
+      elsif theme_file.is_a?(JsonFile)
+        check.add_offense(message, theme_file: theme_file) do |corrector|
+          missing_keys.each do |k|
+            corrector.add_translation(theme_file, key_prefix + k, "TODO")
+          end
+        end
       else
         check.add_offense(message, theme_file: theme_file)
       end
@@ -46,10 +77,12 @@ module ThemeCheck
       other = {} unless other.is_a?(Hash)
       return if pluralization?(default) && pluralization?(other)
 
-      @extra_keys += (other.keys - default.keys).map { |key| path + [key] }
+      shopify_translations = system_translations(path)
+
+      @extra_keys += (other.keys - default.keys - shopify_translations.keys).map { |key| path + [key] }
 
       default.each do |key, default_value|
-        translated_value = other[key]
+        translated_value = other[key] || shopify_translations[key]
         new_path = path + [key]
 
         if translated_value.nil?
@@ -65,5 +98,10 @@ module ThemeCheck
         PLURALIZATION_KEYS.include?(key) && !value.is_a?(Hash)
       end
     end
+
+    def system_translations(path)
+      return ShopifyLiquid::SystemTranslations.translations_hash if path.empty?
+      ShopifyLiquid::SystemTranslations.translations_hash.dig(*path) || {}
+    end
   end
 end

data/lib/theme_check/node.rb

@@ -30,8 +30,24 @@ module ThemeCheck
       raise NotImplementedError
     end
 
+    def start_row
+      raise NotImplementedError
+    end
+
+    def start_column
+      raise NotImplementedError
+    end
+
     def end_index
       raise NotImplementedError
     end
+
+    def end_row
+      raise NotImplementedError
+    end
+
+    def end_column
+      raise NotImplementedError
+    end
   end
 end

data/lib/theme_check/offense.rb

@@ -39,26 +39,12 @@ module ThemeCheck
       end
 
       @node = node
-      @theme_file = nil
-      if node
-        @theme_file = node.theme_file
-      elsif theme_file
-        @theme_file = theme_file
-      end
-
-      @markup = if markup
-        markup
-      else
-        node&.markup
-      end
+      @theme_file = node&.theme_file || theme_file
+      @markup = markup || node&.markup
 
       raise ArgumentError, "Offense markup cannot be an empty string" if @markup.is_a?(String) && @markup.empty?
 
-      @line_number = if line_number
-        line_number
-      elsif @node
-        @node.line_number
-      end
+      @line_number = line_number || @node&.line_number
 
       @position = Position.new(
         @markup,
@@ -81,11 +67,25 @@ module ThemeCheck
       end
     end
 
+    def in_range?(other_range)
+      # Zero length ranges are OK and considered the same as size 1 ranges
+      other_range = other_range.first..other_range.end if other_range.size == 0 # rubocop:disable Style/ZeroLengthPredicate
+      range.cover?(other_range) || other_range.cover?(range)
+    end
+
+    def range
+      @range ||= if start_index == end_index
+        (start_index..end_index)
+      else
+        (start_index...end_index) # end_index is excluded
+      end
+    end
+
     def start_index
       @position.start_index
     end
 
-    def start_line
+    def start_row
       @position.start_row
     end
 
@@ -97,7 +97,7 @@ module ThemeCheck
       @position.end_index
     end
 
-    def end_line
+    def end_row
       @position.end_row
     end
 
@@ -121,6 +121,10 @@ module ThemeCheck
       StringHelpers.demodulize(check.class.name)
     end
 
+    def version
+      theme_file&.version
+    end
+
     def doc
       check.doc
     end
@@ -139,9 +143,9 @@ module ThemeCheck
       !!correction
     end
 
-    def correct
+    def correct(corrector = nil)
       if correctable?
-        corrector = Corrector.new(theme_file: theme_file)
+        corrector ||= Corrector.new(theme_file: theme_file)
         correction.call(corrector)
       end
     rescue => e
@@ -211,9 +215,9 @@ module ThemeCheck
         check: check.code_name,
         path: theme_file&.relative_path,
         severity: check.severity_value,
-        start_line: start_line,
+        start_row: start_row,
         start_column: start_column,
-        end_line: end_line,
+        end_row: end_row,
         end_column: end_column,
         message: message,
       }

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

@@ -5,7 +5,7 @@ module ThemeCheck
     LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
     LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
     LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
-    HTML_LIQUID_PLACEHOLDER = /≬[0-9a-z]+#*≬/m
+    HTML_LIQUID_PLACEHOLDER = /≬[0-9a-z\n]+[#\n]*≬/m
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
 
     def matches(s, re)

data/lib/theme_check/schema_helper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class SchemaHelper
+    # Deeply sets a value in a hash. Accepts both arrays and strings for path.
+    def self.set(hash, path, value)
+      path = path.split('.') if path.is_a?(String)
+      path.each_with_index.reduce(hash) do |pointer, (token, index)|
+        if index == path.size - 1
+          pointer[token] = value
+        elsif !pointer.key?(token)
+          pointer[token] = {}
+        end
+        pointer[token]
+      end
+      hash
+    end
+
+    # Deeply delete a key from a hash
+    def self.delete(hash, path)
+      path = path.split('.') if path.is_a?(String)
+      path.each_with_index.reduce(hash) do |pointer, (token, index)|
+        break pointer.delete(token) if index == path.size - 1
+        pointer[token]
+      end
+    end
+
+    # Deeply add key/values inside a hash.
+    #
+    # Handles arrays by adding the key/value to all hashes inside the array.
+    #
+    # Specially handles objects that have the "id" key like this:
+    #
+    # e.g.
+    #
+    # schema = {
+    #   "deep" => [
+    #     { "id" => "hi" },
+    #     { "id" => "oh" },
+    #   ],
+    # }
+    # assert_equal(
+    #   {
+    #     "deep" => [
+    #       { "id" => "hi", "ho" => "ho" },
+    #       { "id" => "oh" },
+    #     ],
+    #   },
+    #   SchemaHelper.schema_corrector(schema, "deep.hi.ho", "ho")
+    # )
+    def self.schema_corrector(schema, path, value)
+      return schema unless schema.is_a?(Hash)
+      path = path.split('.') if path.is_a?(String)
+      path.each_with_index.reduce(schema) do |pointer, (token, index)|
+        case pointer
+        when Array
+          pointer.each do |item|
+            schema_corrector(item, path.drop(1), value)
+          end
+
+        when Hash
+          break pointer[token] = value if index == path.size - 1
+          pointer[token] = {} unless pointer.key?(token) || pointer.key?("id")
+          pointer[token].nil? && pointer["id"] == token ? pointer : pointer[token]
+        end
+      end
+      schema
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/system_translations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module ThemeCheck
+  module ShopifyLiquid
+    module SystemTranslations
+      extend self
+
+      def translations
+        @translations ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_translation_keys.yml")).to_set
+      end
+
+      def translations_hash
+        @translations_hash ||= translations.reduce({}) do |acc, k|
+          dig_set(acc, k.split('.'), "")
+        end
+      end
+
+      def include?(key)
+        translations.include?(key)
+      end
+
+      private
+
+      def dig_set(obj, keys, value)
+        key = keys.first
+        if keys.length == 1
+          obj[key] = value
+        else
+          obj[key] = {} unless obj[key]
+          dig_set(obj[key], keys.slice(1..-1), value)
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/theme_check/shopify_liquid/tag.rb

@@ -7,10 +7,17 @@ module ThemeCheck
       extend self
 
       def labels
-        @tags ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+        @labels ||= tags_file_contents
+          .map { |x| to_label(x) }
           .to_set
       end
 
+      def end_labels
+        @end_labels ||= tags_file_contents
+          .select { |x| x.is_a?(Hash) }
+          .map { |x| x.values[0] }
+      end
+
       def tag_regex(tag)
         return unless labels.include?(tag)
         @tag_regexes ||= {}
@@ -22,6 +29,17 @@ module ThemeCheck
         @tag_liquid_regexes ||= {}
         @tag_liquid_regexes[tag] ||= /^\s*#{tag}/m
       end
+
+      private
+
+      def to_label(label)
+        return label if label.is_a?(String)
+        label.keys[0]
+      end
+
+      def tags_file_contents
+        @tags_file_contents ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+      end
     end
   end
 end

data/lib/theme_check/shopify_liquid.rb

@@ -3,3 +3,4 @@ require_relative 'shopify_liquid/deprecated_filter'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'
 require_relative 'shopify_liquid/tag'
+require_relative 'shopify_liquid/system_translations'

data/lib/theme_check/storage.rb

@@ -21,5 +21,9 @@ module ThemeCheck
     def directories
       raise NotImplementedError
     end
+
+    def versioned?
+      false
+    end
   end
 end

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

@@ -3,7 +3,7 @@ require "pathname"
 
 module ThemeCheck
   class Theme
-    DEFAULT_LOCALE_REGEXP = %r{^locales/(.*)\.default$}
+    DEFAULT_LOCALE_REGEXP = %r{locales/(.*)\.default$}
     LIQUID_REGEX = /\.liquid$/i
     JSON_REGEX = /\.json$/i
 

data/lib/theme_check/theme_file.rb

@@ -3,10 +3,13 @@ require "pathname"
 
 module ThemeCheck
   class ThemeFile
+    attr_reader :version, :storage
+
     def initialize(relative_path, storage)
       @relative_path = relative_path
       @storage = storage
       @source = nil
+      @version = nil
       @eol = "\n"
     end
 
@@ -36,7 +39,11 @@ module ThemeCheck
     # source file.
     def source
       return @source if @source
-      @source = @storage.read(@relative_path)
+      if @storage.versioned?
+        @source, @version = @storage.read_version(@relative_path)
+      else
+        @source = @storage.read(@relative_path)
+      end
       @eol = @source.include?("\r\n") ? "\r\n" : "\n"
       @source = @source.gsub("\r\n", "\n")
     end

data/lib/theme_check/theme_file_rewriter.rb

@@ -11,23 +11,45 @@ module ThemeCheck
       )
     end
 
-    def insert_before(node, content)
+    def insert_before(node, content, character_range = nil)
       @rewriter.insert_before(
-        range(node.start_index, node.end_index),
+        range(
+          character_range&.begin || node.start_index,
+          character_range&.end || node.end_index,
+        ),
         content
       )
     end
 
-    def insert_after(node, content)
+    def insert_after(node, content, character_range = nil)
       @rewriter.insert_after(
-        range(node.start_index, node.end_index),
+        range(
+          character_range&.begin || node.start_index,
+          character_range&.end || node.end_index,
+        ),
         content
       )
     end
 
-    def replace(node, content)
+    def remove(node)
+      @rewriter.remove(
+        range(node.outer_markup_start_index, node.outer_markup_end_index)
+      )
+    end
+
+    def replace(node, content, character_range = nil)
       @rewriter.replace(
-        range(node.start_index, node.end_index),
+        range(
+          character_range&.begin || node.start_index,
+          character_range&.end || node.end_index,
+        ),
+        content
+      )
+    end
+
+    def replace_inner_markup(node, content)
+      @rewriter.replace(
+        range(node.inner_markup_start_index, node.inner_markup_end_index),
         content
       )
     end

data/lib/theme_check/version.rb

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

data/lib/theme_check.rb

@@ -4,6 +4,7 @@ require "liquid"
 require_relative "theme_check/version"
 require_relative "theme_check/bug"
 require_relative "theme_check/exceptions"
+require_relative "theme_check/schema_helper"
 require_relative "theme_check/theme_file_rewriter"
 require_relative "theme_check/theme_file"
 require_relative "theme_check/liquid_file"
@@ -24,10 +25,10 @@ require_relative "theme_check/regex_helpers"
 require_relative "theme_check/json_helpers"
 require_relative "theme_check/position_helper"
 require_relative "theme_check/position"
-require_relative "theme_check/language_server"
 require_relative "theme_check/checks"
 require_relative "theme_check/config"
 require_relative "theme_check/node"
+require_relative "theme_check/tags"
 require_relative "theme_check/liquid_node"
 require_relative "theme_check/html_node"
 require_relative "theme_check/offense"
@@ -38,11 +39,11 @@ require_relative "theme_check/string_helpers"
 require_relative "theme_check/storage"
 require_relative "theme_check/file_system_storage"
 require_relative "theme_check/in_memory_storage"
-require_relative "theme_check/tags"
 require_relative "theme_check/theme"
 require_relative "theme_check/corrector"
 require_relative "theme_check/liquid_visitor"
 require_relative "theme_check/html_visitor"
+require_relative "theme_check/language_server"
 
 Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }
 
@@ -51,6 +52,14 @@ 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.debug_log_file
+    ENV["THEME_CHECK_DEBUG_LOG_FILE"]
+  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.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -121,6 +121,7 @@ files:
 - docs/checks/remote_asset.md
 - docs/checks/required_directories.md
 - docs/checks/required_layout_theme_object.md
+- docs/checks/schema_json_format.md
 - docs/checks/space_inside_braces.md
 - docs/checks/syntax_error.md
 - docs/checks/template_length.md
@@ -133,6 +134,13 @@ files:
 - docs/checks/valid_json.md
 - docs/checks/valid_schema.md
 - docs/flamegraph.svg
+- docs/language_server/code-action-command-palette.png
+- docs/language_server/code-action-flow.png
+- docs/language_server/code-action-keyboard.png
+- docs/language_server/code-action-light-bulb.png
+- docs/language_server/code-action-problem.png
+- docs/language_server/code-action-quickfix.png
+- docs/language_server/how_to_correct_code_with_code_actions_and_execute_command.md
 - docs/preview.png
 - exe/theme-check
 - exe/theme-check-language-server
@@ -173,6 +181,7 @@ files:
 - lib/theme_check/checks/remote_asset.rb
 - lib/theme_check/checks/required_directories.rb
 - lib/theme_check/checks/required_layout_theme_object.rb
+- lib/theme_check/checks/schema_json_format.rb
 - lib/theme_check/checks/space_inside_braces.rb
 - lib/theme_check/checks/syntax_error.rb
 - lib/theme_check/checks/template_length.rb
@@ -201,6 +210,13 @@ files:
 - lib/theme_check/json_helpers.rb
 - lib/theme_check/json_printer.rb
 - lib/theme_check/language_server.rb
+- lib/theme_check/language_server/bridge.rb
+- lib/theme_check/language_server/channel.rb
+- lib/theme_check/language_server/client_capabilities.rb
+- lib/theme_check/language_server/code_action_engine.rb
+- lib/theme_check/language_server/code_action_provider.rb
+- lib/theme_check/language_server/code_action_providers/quickfix_code_action_provider.rb
+- lib/theme_check/language_server/code_action_providers/source_fix_all_code_action_provider.rb
 - lib/theme_check/language_server/completion_engine.rb
 - lib/theme_check/language_server/completion_helper.rb
 - lib/theme_check/language_server/completion_provider.rb
@@ -208,21 +224,31 @@ files:
 - lib/theme_check/language_server/completion_providers/object_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/render_snippet_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/tag_completion_provider.rb
+- lib/theme_check/language_server/configuration.rb
 - lib/theme_check/language_server/constants.rb
-- lib/theme_check/language_server/diagnostics_tracker.rb
+- lib/theme_check/language_server/diagnostic.rb
+- lib/theme_check/language_server/diagnostics_engine.rb
+- lib/theme_check/language_server/diagnostics_manager.rb
+- lib/theme_check/language_server/document_change_corrector.rb
 - lib/theme_check/language_server/document_link_engine.rb
 - lib/theme_check/language_server/document_link_provider.rb
 - lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb
 - lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb
 - lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb
 - lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb
+- lib/theme_check/language_server/execute_command_engine.rb
+- lib/theme_check/language_server/execute_command_provider.rb
+- lib/theme_check/language_server/execute_command_providers/correction_execute_command_provider.rb
+- lib/theme_check/language_server/execute_command_providers/run_checks_execute_command_provider.rb
 - lib/theme_check/language_server/handler.rb
+- lib/theme_check/language_server/io_messenger.rb
 - lib/theme_check/language_server/messenger.rb
 - lib/theme_check/language_server/protocol.rb
 - lib/theme_check/language_server/server.rb
 - lib/theme_check/language_server/tokens.rb
 - lib/theme_check/language_server/uri_helper.rb
 - lib/theme_check/language_server/variable_lookup_finder.rb
+- lib/theme_check/language_server/versioned_in_memory_storage.rb
 - lib/theme_check/liquid_check.rb
 - lib/theme_check/liquid_file.rb
 - lib/theme_check/liquid_node.rb
@@ -238,10 +264,12 @@ files:
 - lib/theme_check/regex_helpers.rb
 - lib/theme_check/releaser.rb
 - lib/theme_check/remote_asset_file.rb
+- lib/theme_check/schema_helper.rb
 - lib/theme_check/shopify_liquid.rb
 - lib/theme_check/shopify_liquid/deprecated_filter.rb
 - lib/theme_check/shopify_liquid/filter.rb
 - lib/theme_check/shopify_liquid/object.rb
+- lib/theme_check/shopify_liquid/system_translations.rb
 - lib/theme_check/shopify_liquid/tag.rb
 - lib/theme_check/storage.rb
 - lib/theme_check/string_helpers.rb