theme-check 1.1.0 → 1.5.0

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,9 @@ module ThemeCheck
     LIQUID_REGEX = /\.liquid$/i
     JSON_REGEX = /\.json$/i
 
+    attr_reader :storage
+    attr_writer :default_locale_json
+
     def initialize(storage)
       @storage = storage
     end

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "1.1.0"
+  VERSION = "1.5.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.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -25,19 +25,19 @@ 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
@@ -60,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
@@ -76,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
@@ -88,6 +90,7 @@ files:
 - docs/checks/deprecate_bgsizes.md
 - docs/checks/deprecate_lazysizes.md
 - docs/checks/deprecated_filter.md
+- docs/checks/deprecated_global_app_block_type.md
 - docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
@@ -98,6 +101,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
@@ -124,6 +128,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
@@ -136,6 +141,7 @@ files:
 - lib/theme_check/checks/deprecate_bgsizes.rb
 - lib/theme_check/checks/deprecate_lazysizes.rb
 - lib/theme_check/checks/deprecated_filter.rb
+- lib/theme_check/checks/deprecated_global_app_block_type.rb
 - lib/theme_check/checks/html_parsing_error.rb
 - lib/theme_check/checks/img_lazy_loading.rb
 - lib/theme_check/checks/img_width_and_height.rb
@@ -146,6 +152,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
@@ -177,6 +184,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
@@ -188,10 +196,16 @@ files:
 - lib/theme_check/language_server/constants.rb
 - lib/theme_check/language_server/diagnostics_tracker.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/handler.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/liquid_check.rb
 - lib/theme_check/locale_diff.rb

data/bin/liquid-server

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-dev="/opt/dev/bin/dev"
-cd "$($dev project-path theme-check)"
-"$dev" language-server