theme-check 0.6.0 → 0.8.0

data/lib/theme_check/checks/undefined_object.rb

@@ -135,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

data/lib/theme_check/checks/valid_html_translation.rb

@@ -8,7 +8,7 @@ module ThemeCheck
     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/cli.rb

@@ -1,80 +1,104 @@
 # frozen_string_literal: true
+require "optparse"
+
 module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
-    USAGE = <<~END
-      Usage: theme-check [options] /path/to/your/theme
+    attr_accessor :path
 
-      Options:
-        --init                               Generate a .theme-check.yml file in the current directory
-        -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
-        -l, --list                           List enabled checks
-        -a, --auto-correct                   Automatically fix offenses
-        -h, --help                           Show this. Hi!
-        -v, --version                        Print Theme Check version
+    def initialize
+      @path = "."
+      @command = :check
+      @only_categories = []
+      @exclude_categories = []
+      @auto_correct = false
+      @config_path = nil
+    end
 
-      Description:
-        Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
-        Liquid & JSON inside your theme.
+    def option_parser(parser = OptionParser.new, help: true)
+      return @option_parser if defined?(@option_parser)
+      @option_parser = parser
+      @option_parser.banner = "Usage: theme-check [options] [/path/to/your/theme]"
 
-        You can configure checks in the .theme-check.yml file of your theme root directory.
-    END
+      @option_parser.separator("")
+      @option_parser.separator("Basic Options:")
+      @option_parser.on(
+        "-C", "--config PATH",
+        "Use the config provided, overriding .theme-check.yml if present"
+      ) { |path| @config_path = path }
+      @option_parser.on(
+        "-c", "--category CATEGORY",
+        "Only run this category of checks"
+      ) { |category| @only_categories << category.to_sym }
+      @option_parser.on(
+        "-x", "--exclude-category CATEGORY",
+        "Exclude this category of checks"
+      ) { |category| @exclude_categories << category.to_sym }
+      @option_parser.on(
+        "-a", "--auto-correct",
+        "Automatically fix offenses"
+      ) { @auto_correct = true }
 
-    def run(argv)
-      @path = "."
+      @option_parser.separator("")
+      @option_parser.separator("Miscellaneous:")
+      @option_parser.on(
+        "--init",
+        "Generate a .theme-check.yml file"
+      ) { @command = :init }
+      @option_parser.on(
+        "--print",
+        "Output active config to STDOUT"
+      ) { @command = :print }
+      @option_parser.on(
+        "-h", "--help",
+        "Show this. Hi!"
+      ) { @command = :help } if help
+      @option_parser.on(
+        "-l", "--list",
+        "List enabled checks"
+      ) { @command = :list }
+      @option_parser.on(
+        "-v", "--version",
+        "Print Theme Check version"
+      ) { @command = :version }
 
-      command = :check
-      only_categories = []
-      exclude_categories = []
-      auto_correct = false
-      config_path = nil
-
-      args = argv.dup
-      while (arg = args.shift)
-        case arg
-        when "--help", "-h"
-          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"
-          exclude_categories << args.shift.to_sym
-        when "--list", "-l"
-          command = :list
-        when "--auto-correct", "-a"
-          auto_correct = true
-        when "--init"
-          command = :init
-        else
-          @path = arg
-        end
-      end
+      @option_parser.separator("")
+      @option_parser.separator(<<~EOS)
+        Description:
+            Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
+            Liquid & JSON inside your theme.
+
+            You can configure checks in the .theme-check.yml file of your theme root directory.
+      EOS
+
+      @option_parser
+    end
 
-      unless [:version, :init].include?(command)
-        @config = if config_path.present?
+    def parse(argv)
+      @path = option_parser.parse(argv).first || "."
+    end
+
+    def run!
+      unless [:version, :init, :help].include?(@command)
+        @config = if @config_path
           ThemeCheck::Config.new(
             root: @path,
-            configuration: ThemeCheck::Config.load_file(config_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
+        @config.only_categories = @only_categories
+        @config.exclude_categories = @exclude_categories
+        @config.auto_correct = @auto_correct
       end
 
-      send(command)
+      send(@command)
     end
 
-    def run!(argv)
-      run(argv)
+    def run
+      run!
     rescue Abort => e
       if e.message.empty?
         exit(1)
@@ -83,6 +107,18 @@ module ThemeCheck
       end
     end
 
+    def self.parse_and_run!(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run!
+    end
+
+    def self.parse_and_run(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run
+    end
+
     def list
       puts @config.enabled_checks
     end
@@ -102,12 +138,20 @@ module ThemeCheck
       end
     end
 
+    def print
+      puts YAML.dump(@config.to_h)
+    end
+
+    def help
+      puts option_parser.to_s
+    end
+
     def check
       puts "Checking #{@config.root} ..."
       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.\n#{USAGE}"
+        raise Abort, "No templates found."
       end
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme

data/lib/theme_check/config.rb

@@ -91,7 +91,11 @@ module ThemeCheck
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
-        check = check_class.new(**options_for_check)
+        check = if options_for_check.empty?
+          check_class.new
+        else
+          check_class.new(**options_for_check)
+        end
         check.options = options_for_check
         check
       end.compact
@@ -104,7 +108,7 @@ module ThemeCheck
     private
 
     def check_name?(name)
-      name.start_with?(/[A-Z]/)
+      name.to_s.start_with?(/[A-Z]/)
     end
 
     def validate_configuration(configuration, default_configuration = self.class.default, parent_keys = [])

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,32 +6,25 @@
 # as a big hash already, leave it like that and save yourself some IO.
 module ThemeCheck
   class InMemoryStorage < Storage
-    def initialize(files = {}, root = nil)
+    def initialize(files = {}, root = "/dev/null")
       @files = files
-      @root = root
+      @root = Pathname.new(root)
     end
 
-    def path(name)
-      return File.join(@root, name) unless @root.nil?
-      name
+    def path(relative_path)
+      @root.join(relative_path)
     end
 
-    def relative_path(name)
-      path = Pathname.new(name)
-      return path.relative_path_from(@root).to_s unless path.relative? || @root.nil?
-      name
+    def read(relative_path)
+      @files[relative_path]
     end
 
-    def read(name)
-      @files[relative_path(name)]
-    end
-
-    def write(name, content)
-      @files[relative_path(name)] = content
+    def write(relative_path, content)
+      @files[relative_path] = content
     end
 
     def files
-      @values ||= @files.keys
+      @files.keys
     end
 
     def directories
@@ -41,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/completion_engine.rb

@@ -10,8 +10,8 @@ module ThemeCheck
         @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_providers/filter_completion_provider.rb

@@ -8,7 +8,7 @@ module ThemeCheck
       def completions(content, cursor)
         return [] unless can_complete?(content, cursor)
         available_labels
-          .select { |w| w.starts_with?(partial(content, cursor)) }
+          .select { |w| w.start_with?(partial(content, cursor)) }
           .map { |filter| filter_to_completion(filter) }
       end
 

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

@@ -7,7 +7,7 @@ module ThemeCheck
         return [] unless cursor_on_quoted_argument?(content, cursor)
         partial = snippet(content) || ''
         snippets
-          .select { |x| x.starts_with?(partial) }
+          .select { |x| x.start_with?(partial) }
           .map { |x| snippet_to_completion(x) }
       end
 

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

@@ -7,12 +7,12 @@ module ThemeCheck
         return [] unless can_complete?(content, cursor)
         partial = first_word(content) || ''
         ShopifyLiquid::Tag.labels
-          .select { |w| w.starts_with?(partial) }
+          .select { |w| w.start_with?(partial) }
           .map { |tag| tag_to_completion(tag) }
       end
 
       def can_complete?(content, cursor)
-        content.starts_with?(Liquid::TagStart) && (
+        content.start_with?(Liquid::TagStart) && (
           cursor_on_first_word?(content, cursor) ||
           cursor_on_start_content?(content, cursor, Liquid::TagStart)
         )

data/lib/theme_check/language_server/constants.rb

@@ -3,8 +3,8 @@
 module ThemeCheck
   module LanguageServer
     PARTIAL_RENDER = %r{
-      \{\%\s*render\s+'(?<partial>[^']*)'|
-      \{\%\s*render\s+"(?<partial>[^"]*)"
+      \{\%-?\s*render\s+'(?<partial>[^']*)'|
+      \{\%-?\s*render\s+"(?<partial>[^"]*)"
     }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -10,8 +10,9 @@ module ThemeCheck
         @storage = storage
       end
 
-      def document_links(uri)
-        buffer = @storage.read(uri)
+      def document_links(relative_path)
+        buffer = @storage.read(relative_path)
+        return [] unless buffer
         matches(buffer, PARTIAL_RENDER).map do |match|
           start_line, start_character = from_index_to_line_column(
             buffer,
@@ -40,7 +41,7 @@ module ThemeCheck
       end
 
       def link(partial)
-        'file://' + @storage.path('snippets/' + partial + '.liquid')
+        "file://#{@storage.path('snippets/' + partial + '.liquid')}"
       end
     end
   end

data/lib/theme_check/language_server/handler.rb

@@ -42,19 +42,19 @@ module ThemeCheck
       alias_method :on_shutdown, :on_exit
 
       def on_text_document_did_change(_id, params)
-        uri = text_document_uri(params)
-        @storage.write(uri, content_changes_text(params))
+        relative_path = relative_path_from_text_document_uri(params)
+        @storage.write(relative_path, content_changes_text(params))
       end
 
       def on_text_document_did_close(_id, params)
-        uri = text_document_uri(params)
-        @storage.write(uri, nil)
+        relative_path = relative_path_from_text_document_uri(params)
+        @storage.write(relative_path, "")
       end
 
       def on_text_document_did_open(_id, params)
-        uri = text_document_uri(params)
-        @storage.write(uri, text_document_text(params))
-        analyze_and_send_offenses(uri)
+        relative_path = relative_path_from_text_document_uri(params)
+        @storage.write(relative_path, text_document_text(params))
+        analyze_and_send_offenses(text_document_uri(params))
       end
 
       def on_text_document_did_save(_id, params)
@@ -62,27 +62,27 @@ module ThemeCheck
       end
 
       def on_text_document_document_link(id, params)
-        uri = text_document_uri(params)
+        relative_path = relative_path_from_text_document_uri(params)
         send_response(
           id: id,
-          result: document_links(uri)
+          result: document_links(relative_path)
         )
       end
 
       def on_text_document_completion(id, params)
-        uri = text_document_uri(params)
+        relative_path = relative_path_from_text_document_uri(params)
         line = params.dig('position', 'line')
         col = params.dig('position', 'character')
         send_response(
           id: id,
-          result: completions(uri, line, col)
+          result: completions(relative_path, line, col)
         )
       end
 
       private
 
       def in_memory_storage(root)
-        config = ThemeCheck::Config.from_path(root)
+        config = config_for_path(root)
 
         # Make a real FS to get the files from the snippets folder
         fs = ThemeCheck::FileSystemStorage.new(
@@ -95,13 +95,17 @@ module ThemeCheck
           .map { |fn| [fn, ""] }
           .to_h
 
-        InMemoryStorage.new(files, root)
+        InMemoryStorage.new(files, config.root)
       end
 
       def text_document_uri(params)
         params.dig('textDocument', 'uri').sub('file://', '')
       end
 
+      def relative_path_from_text_document_uri(params)
+        @storage.relative_path(text_document_uri(params))
+      end
+
       def text_document_text(params)
         params.dig('textDocument', 'text')
       end
@@ -110,9 +114,13 @@ module ThemeCheck
         params.dig('contentChanges', 0, 'text')
       end
 
-      def analyze_and_send_offenses(file_path)
-        root = ThemeCheck::Config.find(file_path) || @root_path
-        config = ThemeCheck::Config.from_path(root)
+      def config_for_path(path)
+        root = ThemeCheck::Config.find(path) || @root_path
+        ThemeCheck::Config.from_path(root)
+      end
+
+      def analyze_and_send_offenses(absolute_path)
+        config = config_for_path(absolute_path)
         storage = ThemeCheck::FileSystemStorage.new(
           config.root,
           ignored_patterns: config.ignored_patterns
@@ -131,12 +139,12 @@ module ThemeCheck
         analyzer.offenses
       end
 
-      def completions(uri, line, col)
-        @completion_engine.completions(uri, line, col)
+      def completions(relative_path, line, col)
+        @completion_engine.completions(relative_path, line, col)
       end
 
-      def document_links(uri)
-        @document_link_engine.document_links(uri)
+      def document_links(relative_path)
+        @document_link_engine.document_links(relative_path)
       end
 
       def send_diagnostics(offenses)
@@ -162,7 +170,7 @@ module ThemeCheck
         send_response(
           method: 'textDocument/publishDiagnostics',
           params: {
-            uri: "file:#{path}",
+            uri: "file://#{path}",
             diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
           },
         )