theme-check 0.4.0 → 0.7.2

data/lib/theme_check/checks/translation_key_exists.rb

@@ -1,8 +1,21 @@
 # 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
+    doc docs_url(__FILE__)
 
     def on_variable(node)
       return unless @theme.default_locale_json&.content&.is_a?(Hash)
@@ -11,7 +24,7 @@ module ThemeCheck
       return unless (key_node = node.children.first)
       return unless key_node.value.is_a?(String)
 
-      unless key_exists?(key_node.value)
+      unless key_exists?(key_node.value) || 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

@@ -2,7 +2,7 @@
 module ThemeCheck
   class UndefinedObject < LiquidCheck
     category :liquid
-    doc "https://shopify.dev/docs/themes/liquid/reference/objects"
+    doc docs_url(__FILE__)
     severity :error
 
     class TemplateInfo
@@ -21,7 +21,13 @@ module ThemeCheck
       end
 
       def add_variable_lookup(name:, node:)
-        line_number = node.parent.line_number
+        parent = node
+        line_number = nil
+        loop do
+          line_number = parent.line_number
+          parent = parent.parent
+          break unless line_number.nil? && parent
+        end
         key = [name, line_number]
         @all_variable_lookups[key] = node
       end
@@ -129,7 +135,7 @@ module ThemeCheck
 
     def each_template
       @files.each do |(name, info)|
-        next if name.starts_with?('snippets/')
+        next if name.start_with?('snippets/')
         yield [name, info]
       end
     end
@@ -154,7 +160,7 @@ module ThemeCheck
       all_variables = info.all_variables
 
       info.each_variable_lookup(!!render_node) do |(key, node)|
-        name, _line_number = key
+        name, line_number = key
         next if all_variables.include?(name)
         next if all_global_objects.include?(name)
 
@@ -164,7 +170,7 @@ module ThemeCheck
         if render_node
           add_offense("Missing argument `#{name}`", node: render_node)
         else
-          add_offense("Undefined object `#{name}`", node: node)
+          add_offense("Undefined object `#{name}`", node: node, line_number: line_number)
         end
       end
     end

data/lib/theme_check/checks/unknown_filter.rb

@@ -12,6 +12,7 @@ module ThemeCheck
   class UnknownFilter < LiquidCheck
     severity :error
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }

data/lib/theme_check/checks/unused_assign.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class UnusedAssign < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     class TemplateInfo < Struct.new(:used_assigns, :assign_nodes, :includes)
       def collect_used_assigns(templates, visited = Set.new)

data/lib/theme_check/checks/unused_snippet.rb

@@ -5,6 +5,7 @@ module ThemeCheck
   class UnusedSnippet < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     def initialize
       @used_templates = Set.new

data/lib/theme_check/checks/valid_html_translation.rb

@@ -5,9 +5,10 @@ require 'nokogumbo'
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck
     severity :suggestion
+    doc docs_url(__FILE__)
 
     def on_file(file)
-      return unless file.name.starts_with?("locales/")
+      return unless file.name.start_with?("locales/")
       return unless file.content.is_a?(Hash)
 
       visit_nested(file.content)

data/lib/theme_check/checks/valid_json.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class ValidJson < JsonCheck
     severity :error
     category :json
+    doc docs_url(__FILE__)
 
     def on_file(file)
       if file.parse_error

data/lib/theme_check/checks/valid_schema.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class ValidSchema < LiquidCheck
     severity :suggestion
     category :json
+    doc docs_url(__FILE__)
 
     def on_schema(node)
       JSON.parse(node.value.nodelist.join)

data/lib/theme_check/cli.rb

@@ -6,14 +6,18 @@ module ThemeCheck
     USAGE = <<~END
       Usage: theme-check [options] /path/to/your/theme
 
-      Options:
-        -c, [--category]          # Only run this category of checks
-        -x, [--exclude-category]  # Exclude this category of checks
-        -l, [--list]              # List enabled checks
-        -a, [--auto-correct]      # Automatically fix offenses
-        --init                    # Generate a .theme-check.yml file in the current directory
-        -h, [--help]              # Show this. Hi!
-        -v, [--version]           # Print Theme Check version
+      Basic Options:
+        -C, --config <path>                  Use the config provided, overriding .theme-check.yml if present
+        -c, --category <category>            Only run this category of checks
+        -x, --exclude-category  <category>   Exclude this category of checks
+        -a, --auto-correct                   Automatically fix offenses
+
+      Miscellaneous:
+        --init                               Generate a .theme-check.yml file
+        --print-config                       Output active config to STDOUT
+        -h, --help                           Show this. Hi!
+        -l, --list                           List enabled checks
+        -v, --version                        Print Theme Check version
 
       Description:
         Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
@@ -29,6 +33,7 @@ module ThemeCheck
       only_categories = []
       exclude_categories = []
       auto_correct = false
+      config_path = nil
 
       args = argv.dup
       while (arg = args.shift)
@@ -37,6 +42,8 @@ module ThemeCheck
           raise Abort, USAGE
         when "--version", "-v"
           command = :version
+        when "--config", "-C"
+          config_path = Pathname.new(args.shift)
         when "--category", "-c"
           only_categories << args.shift.to_sym
         when "--exclude-category", "-x"
@@ -47,13 +54,22 @@ module ThemeCheck
           auto_correct = true
         when "--init"
           command = :init
+        when "--print"
+          command = :print
         else
           @path = arg
         end
       end
 
       unless [:version, :init].include?(command)
-        @config = ThemeCheck::Config.from_path(@path)
+        @config = if config_path
+          ThemeCheck::Config.new(
+            root: @path,
+            configuration: ThemeCheck::Config.load_file(config_path)
+          )
+        else
+          ThemeCheck::Config.from_path(@path)
+        end
         @config.only_categories = only_categories
         @config.exclude_categories = exclude_categories
         @config.auto_correct = auto_correct
@@ -91,6 +107,10 @@ module ThemeCheck
       end
     end
 
+    def print
+      puts YAML.dump(@config.to_h)
+    end
+
     def check
       puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)

data/lib/theme_check/config.rb

@@ -10,6 +10,8 @@ module ThemeCheck
     attr_accessor :only_categories, :exclude_categories, :auto_correct
 
     class << self
+      attr_reader :last_loaded_config
+
       def from_path(path)
         if (filename = find(path))
           new(root: filename.dirname, configuration: load_file(filename))
@@ -36,6 +38,7 @@ module ThemeCheck
       end
 
       def load_file(absolute_path)
+        @last_loaded_config = absolute_path
         YAML.load_file(absolute_path)
       end
 
@@ -83,8 +86,8 @@ module ThemeCheck
 
         check_class = ThemeCheck.const_get(check_name)
 
-        next if exclude_categories.include?(check_class.category)
-        next if only_categories.any? && !only_categories.include?(check_class.category)
+        next if check_class.categories.any? { |category| exclude_categories.include?(category) }
+        next if only_categories.any? && check_class.categories.none? { |category| only_categories.include?(category) }
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)

data/lib/theme_check/disabled_checks.rb

@@ -61,11 +61,11 @@ module ThemeCheck
     end
 
     def start_disabling?(text)
-      text.strip.starts_with?(DISABLE_START)
+      text.strip.start_with?(DISABLE_START)
     end
 
     def stop_disabling?(text)
-      text.strip.starts_with?(DISABLE_END)
+      text.strip.start_with?(DISABLE_END)
     end
 
     # Return a list of checks from a theme-check-disable comment

data/lib/theme_check/in_memory_storage.rb

@@ -6,24 +6,25 @@
 # as a big hash already, leave it like that and save yourself some IO.
 module ThemeCheck
   class InMemoryStorage < Storage
-    def initialize(files = {})
+    def initialize(files = {}, root = "/dev/null")
       @files = files
+      @root = Pathname.new(root)
     end
 
-    def path(name)
-      name
+    def path(relative_path)
+      @root.join(relative_path)
     end
 
-    def read(name)
-      @files[name]
+    def read(relative_path)
+      @files[relative_path]
     end
 
-    def write(name, content)
-      @files[name] = content
+    def write(relative_path, content)
+      @files[relative_path] = content
     end
 
     def files
-      @values ||= @files.keys
+      @files.keys
     end
 
     def directories
@@ -33,5 +34,9 @@ module ThemeCheck
         .map(&:to_s)
         .uniq
     end
+
+    def relative_path(absolute_path)
+      Pathname.new(absolute_path).relative_path_from(@root).to_s
+    end
   end
 end

data/lib/theme_check/language_server.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "language_server/protocol"
+require_relative "language_server/constants"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"
@@ -7,6 +8,7 @@ require_relative "language_server/position_helper"
 require_relative "language_server/completion_helper"
 require_relative "language_server/completion_provider"
 require_relative "language_server/completion_engine"
+require_relative "language_server/document_link_engine"
 
 Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file

data/lib/theme_check/language_server/completion_engine.rb

@@ -7,11 +7,11 @@ module ThemeCheck
 
       def initialize(storage)
         @storage = storage
-        @providers = CompletionProvider.all.map(&:new)
+        @providers = CompletionProvider.all.map { |x| x.new(storage) }
       end
 
-      def completions(name, line, col)
-        buffer = @storage.read(name)
+      def completions(relative_path, line, col)
+        buffer = @storage.read(relative_path)
         cursor = from_line_column_to_index(buffer, line, col)
         token = find_token(buffer, cursor)
         return [] if token.nil?

data/lib/theme_check/language_server/completion_helper.rb

@@ -20,16 +20,6 @@ module ThemeCheck
       def first_word(content)
         return content.match(WORD)[0] if content.match?(WORD)
       end
-
-      def matches(s, re)
-        start_at = 0
-        matches = []
-        while (m = s.match(re, start_at))
-          matches.push(m)
-          start_at = m.end(0)
-        end
-        matches
-      end
     end
   end
 end

data/lib/theme_check/language_server/completion_provider.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   module LanguageServer
     class CompletionProvider
       include CompletionHelper
+      include RegexHelpers
 
       class << self
         def all
@@ -15,6 +16,10 @@ module ThemeCheck
         end
       end
 
+      def initialize(storage = InMemoryStorage.new)
+        @storage = storage
+      end
+
       def completions(content, cursor)
         raise NotImplementedError
       end

data/lib/theme_check/language_server/completion_providers/filter_completion_provider.rb

@@ -7,8 +7,8 @@ module ThemeCheck
 
       def completions(content, cursor)
         return [] unless can_complete?(content, cursor)
-        ShopifyLiquid::Filter.labels
-          .select { |w| w.starts_with?(partial(content, cursor)) }
+        available_labels
+          .select { |w| w.start_with?(partial(content, cursor)) }
           .map { |filter| filter_to_completion(filter) }
       end
 
@@ -21,6 +21,10 @@ module ThemeCheck
 
       private
 
+      def available_labels
+        @labels ||= ShopifyLiquid::Filter.labels - ShopifyLiquid::DeprecatedFilter.labels
+      end
+
       def cursor_on_filter?(content, cursor)
         return false unless content.match?(NAMED_FILTER)
         matches(content, NAMED_FILTER).any? do |match|

data/lib/theme_check/language_server/completion_providers/object_completion_provider.rb

@@ -7,7 +7,7 @@ module ThemeCheck
         return [] unless can_complete?(content, cursor)
         partial = first_word(content) || ''
         ShopifyLiquid::Object.labels
-          .select { |w| w.starts_with?(partial) }
+          .select { |w| w.start_with?(partial) }
           .map { |object| object_to_completion(object) }
       end
 

data/lib/theme_check/language_server/completion_providers/render_snippet_completion_provider.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class RenderSnippetCompletionProvider < CompletionProvider
+      def completions(content, cursor)
+        return [] unless cursor_on_quoted_argument?(content, cursor)
+        partial = snippet(content) || ''
+        snippets
+          .select { |x| x.start_with?(partial) }
+          .map { |x| snippet_to_completion(x) }
+      end
+
+      private
+
+      def cursor_on_quoted_argument?(content, cursor)
+        match = content.match(PARTIAL_RENDER)
+        return false if match.nil?
+        match.begin(:partial) <= cursor && cursor <= match.end(:partial)
+      end
+
+      def snippet(content)
+        match = content.match(PARTIAL_RENDER)
+        return if match.nil?
+        match[:partial]
+      end
+
+      def snippets
+        @storage
+          .files
+          .select { |x| x.include?('snippets/') }
+      end
+
+      def snippet_to_completion(file)
+        {
+          label: File.basename(file, '.liquid'),
+          kind: CompletionItemKinds::SNIPPET,
+          detail: file,
+        }
+      end
+    end
+  end
+end