theme-check 1.2.0 → 1.3.0

data/lib/theme_check/json_check.rb

@@ -4,8 +4,8 @@ module ThemeCheck
   class JsonCheck < Check
     extend ChecksTracking
 
-    def add_offense(message, markup: nil, line_number: nil, template: nil)
-      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template)
+    def add_offense(message, markup: nil, line_number: nil, template: nil, &block)
+      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template, correction: block)
     end
   end
 end

data/lib/theme_check/json_printer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'json'
+
+module ThemeCheck
+  class JsonPrinter
+    def print(offenses)
+      json = offenses_by_path(offenses)
+      puts JSON.dump(json)
+    end
+
+    def offenses_by_path(offenses)
+      offenses
+        .map(&:to_h)
+        .group_by { |offense| offense[:path] }
+        .map do |(path, path_offenses)|
+          {
+            path: path,
+            offenses: path_offenses.map { |offense| offense.filter { |k, _v| k != :path } },
+            errorCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:error] },
+            suggestionCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:suggestion] },
+            styleCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:style] },
+          }
+        end
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 require "benchmark"
+require "uri"
+require "cgi"
 
 module ThemeCheck
   module LanguageServer
@@ -98,8 +100,10 @@ module ThemeCheck
         path_from_uri(params.dig('textDocument', 'uri'))
       end
 
-      def path_from_uri(uri)
-        uri&.sub('file://', '')&.sub('/c%3A', '')
+      def path_from_uri(uri_string)
+        return if uri_string.nil?
+        uri = URI(uri_string)
+        CGI.unescape(uri.path)
       end
 
       def relative_path_from_text_document_uri(params)

data/lib/theme_check/node.rb

@@ -22,9 +22,7 @@ module ThemeCheck
     end
 
     def markup=(markup)
-      if tag?
-        @value.raw = markup
-      elsif @value.instance_variable_defined?(:@markup)
+      if @value.instance_variable_defined?(:@markup)
         @value.instance_variable_set(:@markup, markup)
       end
     end
@@ -127,7 +125,11 @@ module ThemeCheck
     end
 
     def position
-      @position ||= Position.new(markup, template&.source, line_number)
+      @position ||= Position.new(
+        markup,
+        template&.source,
+        line_number_1_indexed: line_number
+      )
     end
 
     def start_index

data/lib/theme_check/offense.rb

@@ -1,11 +1,32 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Offense
+    include PositionHelper
+
     MAX_SOURCE_EXCERPT_SIZE = 120
 
     attr_reader :check, :message, :template, :node, :markup, :line_number, :correction
 
-    def initialize(check:, message: nil, template: nil, node: nil, markup: nil, line_number: nil, correction: nil)
+    def initialize(
+      check:, # instance of a ThemeCheck::Check
+      message: nil, # error message for the offense
+      template: nil, # Template
+      node: nil, # Node or HtmlNode
+      markup: nil, # string
+      line_number: nil, # line number of the error (1-indexed)
+      # node_markup_offset is the index inside node.markup to start
+      # looking for markup :mindblow:.
+      # This is so we can accurately highlight node substrings.
+      # e.g. if we have the following scenario in which we
+      # want to highlight the middle comma
+      #   * node.markup == "replace ',',', '"
+      #   * markup == ","
+      # Then we need some way of telling our Position class to start
+      # looking for the second comma. This is done with node_markup_offset.
+      # More context can be found in #376.
+      node_markup_offset: 0,
+      correction: nil # block
+    )
       @check = check
       @correction = correction
 
@@ -39,7 +60,13 @@ module ThemeCheck
         @node.line_number
       end
 
-      @position = Position.new(@markup, @template&.source, @line_number)
+      @position = Position.new(
+        @markup,
+        @template&.source,
+        line_number_1_indexed: @line_number,
+        node_markup_offset: node_markup_offset,
+        node_markup: node&.markup
+      )
     end
 
     def source_excerpt
@@ -103,8 +130,13 @@ module ThemeCheck
       tokens.join(":") if tokens.any?
     end
 
+    def location_range
+      tokens = [template&.relative_path, start_index, end_index].compact
+      tokens.join(":") if tokens.any?
+    end
+
     def correctable?
-      line_number && correction
+      !!correction
     end
 
     def correct
@@ -139,5 +171,26 @@ module ThemeCheck
         message
       end
     end
+
+    def to_s_range
+      if template
+        "#{message} at #{location_range}"
+      else
+        message
+      end
+    end
+
+    def to_h
+      {
+        check: check.code_name,
+        path: template&.relative_path,
+        severity: check.severity_value,
+        start_line: start_line,
+        start_column: start_column,
+        end_line: end_line,
+        end_column: end_column,
+        message: message,
+      }
+    end
   end
 end

data/lib/theme_check/parsing_helpers.rb

@@ -5,15 +5,16 @@ module ThemeCheck
     def outside_of_strings(markup)
       scanner = StringScanner.new(markup)
 
-      while scanner.scan(/.*?("|')/)
-        yield scanner.matched[0..-2]
+      while scanner.scan(/.*?("|')/m)
+        chunk_start = scanner.pre_match.size
+        yield scanner.matched[0..-2], chunk_start
         quote = scanner.matched[-1] == "'" ? "'" : "\""
         # Skip to the end of the string
         # Check for empty string first, since follow regexp uses lookahead
         scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
       end
 
-      yield scanner.rest if scanner.rest?
+      yield scanner.rest, scanner.charpos if scanner.rest?
     end
   end
 end

data/lib/theme_check/position.rb

@@ -4,42 +4,64 @@ module ThemeCheck
   class Position
     include PositionHelper
 
-    def initialize(needle, contents, line_number_1_indexed)
-      @needle = needle
-      @contents = contents
+    def initialize(
+      needle_arg,
+      contents_arg,
+      line_number_1_indexed: nil,
+      node_markup: nil,
+      node_markup_offset: 0 # the index of markup inside the node_markup
+    )
+      @needle = needle_arg
+      @contents = contents_arg
       @line_number_1_indexed = line_number_1_indexed
-      @start_row_column = nil
-      @end_row_column = nil
+      @node_markup_offset = node_markup_offset
+      @node_markup = node_markup
+      @strict_position = StrictPosition.new(
+        needle,
+        contents,
+        start_index,
+      )
     end
 
-    def start_line_index
+    def start_line_offset
       from_row_column_to_index(contents, line_number, 0)
     end
 
+    def start_offset
+      return start_line_offset if @node_markup.nil?
+      node_markup_start = contents.index(@node_markup, start_line_offset)
+      return start_line_offset if node_markup_start.nil?
+      node_markup_start + @node_markup_offset
+    end
+
     # 0-indexed, inclusive
     def start_index
-      contents.index(needle, start_line_index) || start_line_index
+      contents.index(needle, start_offset)
     end
 
     # 0-indexed, exclusive
     def end_index
-      start_index + needle.size
+      @strict_position.end_index
     end
 
+    # 0-indexed, inclusive
     def start_row
-      start_row_column[0]
+      @strict_position.start_row
     end
 
+    # 0-indexed, inclusive
     def start_column
-      start_row_column[1]
+      @strict_position.start_column
     end
 
+    # 0-indexed, exclusive (both taken together are) therefore you
+    # might end up on a newline character or the next line
     def end_row
-      end_row_column[0]
+      @strict_position.end_row
     end
 
     def end_column
-      end_row_column[1]
+      @strict_position.end_column
     end
 
     private
@@ -55,15 +77,77 @@ module ThemeCheck
     end
 
     def needle
-      if @needle.nil? && !contents.empty? && !@line_number_1_indexed.nil?
-        contents.lines(chomp: true)[line_number] || ''
+      if has_content_and_line_number_but_no_needle?
+        entire_line_needle
       elsif contents.empty? || @needle.nil?
         ''
+      elsif !can_find_needle?
+        entire_line_needle
       else
         @needle
       end
     end
 
+    def has_content_and_line_number_but_no_needle?
+      @needle.nil? && !contents.empty? && @line_number_1_indexed.is_a?(Integer)
+    end
+
+    def can_find_needle?
+      !!contents.index(@needle)
+    end
+
+    def entire_line_needle
+      contents.lines(chomp: true)[line_number] || ''
+    end
+  end
+
+  # This method is stricter than Position in the sense that it doesn't
+  # accept invalid inputs. Makes for code that is easier to understand.
+  class StrictPosition
+    include PositionHelper
+
+    attr_reader :needle, :contents
+
+    def initialize(needle, contents, start_index)
+      raise ArgumentError, 'Bad start_index' unless start_index.is_a?(Integer)
+      raise ArgumentError, 'Bad contents' unless contents.is_a?(String)
+      raise ArgumentError, 'Bad needle' unless needle.is_a?(String) || !contents.index(needle, start_index)
+
+      @needle = needle
+      @contents = contents
+      @start_index = start_index
+      @start_row_column = nil
+      @end_row_column = nil
+    end
+
+    # 0-indexed, inclusive
+    def start_index
+      @contents.index(needle, @start_index)
+    end
+
+    # 0-indexed, exclusive
+    def end_index
+      start_index + needle.size
+    end
+
+    def start_row
+      start_row_column[0]
+    end
+
+    def start_column
+      start_row_column[1]
+    end
+
+    def end_row
+      end_row_column[0]
+    end
+
+    def end_column
+      end_row_column[1]
+    end
+
+    private
+
     def start_row_column
       return @start_row_column unless @start_row_column.nil?
       @start_row_column = from_index_to_row_column(contents, start_index)

data/lib/theme_check/regex_helpers.rb

@@ -2,8 +2,11 @@
 
 module ThemeCheck
   module RegexHelpers
-    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
+    LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
+
     def matches(s, re)
       start_at = 0
       matches = []
@@ -16,7 +19,7 @@ module ThemeCheck
 
     def href_to_file_size(href)
       # asset_url (+ optional stylesheet_tag) variables
-      if href =~ /^#{VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
+      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
         asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
         asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
         return if asset.nil?

data/lib/theme_check/theme.rb

@@ -7,6 +7,8 @@ module ThemeCheck
     LIQUID_REGEX = /\.liquid$/i
     JSON_REGEX = /\.json$/i
 
+    attr_accessor :storage
+
     def initialize(storage)
       @storage = storage
     end

data/lib/theme_check/version.rb

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

data/lib/theme_check.rb

@@ -27,6 +27,7 @@ require_relative "theme_check/config"
 require_relative "theme_check/node"
 require_relative "theme_check/offense"
 require_relative "theme_check/printer"
+require_relative "theme_check/json_printer"
 require_relative "theme_check/shopify_liquid"
 require_relative "theme_check/storage"
 require_relative "theme_check/string_helpers"

data/theme-check.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('liquid', '>= 5.0.1')
-  spec.add_dependency('nokogumbo')
+  spec.add_dependency('nokogiri', '>= 1.12')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -25,27 +25,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.1
 - !ruby/object:Gem::Dependency
-  name: nokogumbo
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
 description: 
 email:
 - marcandre.cournoyer@shopify.com
 executables:
 - theme-check
 - theme-check-language-server
-- theme-check-language-server.bat
-- theme-check.bat
 extensions: []
 extra_rdoc_files: []
 files:
@@ -62,7 +60,8 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- bin/liquid-server
+- bin/theme-check
+- bin/theme-check-language-server
 - config/default.yml
 - config/nothing.yml
 - config/theme_app_extension.yml
@@ -78,6 +77,7 @@ files:
 - docs/api/json_check.md
 - docs/api/liquid_check.md
 - docs/checks/TEMPLATE.md.erb
+- docs/checks/app_block_valid_tags.md
 - docs/checks/asset_size_app_block_css.md
 - docs/checks/asset_size_app_block_javascript.md
 - docs/checks/asset_size_css.md
@@ -100,6 +100,7 @@ files:
 - docs/checks/missing_required_template_files.md
 - docs/checks/missing_template.md
 - docs/checks/nested_snippet.md
+- docs/checks/pagination_size.md
 - docs/checks/parser_blocking_javascript.md
 - docs/checks/parser_blocking_script_tag.md
 - docs/checks/remote_asset.md
@@ -119,8 +120,6 @@ files:
 - docs/preview.png
 - exe/theme-check
 - exe/theme-check-language-server
-- exe/theme-check-language-server.bat
-- exe/theme-check.bat
 - lib/theme_check.rb
 - lib/theme_check/analyzer.rb
 - lib/theme_check/asset_file.rb
@@ -128,6 +127,7 @@ files:
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/TEMPLATE.rb.erb
+- lib/theme_check/checks/app_block_valid_tags.rb
 - lib/theme_check/checks/asset_size_app_block_css.rb
 - lib/theme_check/checks/asset_size_app_block_javascript.rb
 - lib/theme_check/checks/asset_size_css.rb
@@ -150,6 +150,7 @@ files:
 - lib/theme_check/checks/missing_required_template_files.rb
 - lib/theme_check/checks/missing_template.rb
 - lib/theme_check/checks/nested_snippet.rb
+- lib/theme_check/checks/pagination_size.rb
 - lib/theme_check/checks/parser_blocking_javascript.rb
 - lib/theme_check/checks/parser_blocking_script_tag.rb
 - lib/theme_check/checks/remote_asset.rb
@@ -181,6 +182,7 @@ files:
 - lib/theme_check/json_check.rb
 - lib/theme_check/json_file.rb
 - lib/theme_check/json_helpers.rb
+- lib/theme_check/json_printer.rb
 - lib/theme_check/language_server.rb
 - lib/theme_check/language_server/completion_engine.rb
 - lib/theme_check/language_server/completion_helper.rb