theme-check 0.10.1 → 1.2.0

data/lib/theme_check/language_server/constants.rb

@@ -10,5 +10,13 @@ module ThemeCheck
       ^\s*render\s+'(?<partial>[^']*)'|
       ^\s*render\s+"(?<partial>[^"]*)"
     }mix
+    ASSET_INCLUDE = %r{
+      \{\%-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      \{\%-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
+
+      # in liquid tags the whole line is white space until the asset partial
+      ^\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      ^\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
+    }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -13,7 +13,7 @@ module ThemeCheck
       def document_links(relative_path)
         buffer = @storage.read(relative_path)
         return [] unless buffer
-        matches(buffer, PARTIAL_RENDER).map do |match|
+        snippet_matches = matches(buffer, PARTIAL_RENDER).map do |match|
           start_line, start_character = from_index_to_row_column(
             buffer,
             match.begin(:partial),
@@ -25,7 +25,7 @@ module ThemeCheck
           )
 
           {
-            target: link(match[:partial]),
+            target: snippet_link(match[:partial]),
             range: {
               start: {
                 line: start_line,
@@ -38,10 +38,46 @@ module ThemeCheck
             },
           }
         end
+        asset_matches = matches(buffer, ASSET_INCLUDE).map do |match|
+          start_line, start_character = from_index_to_row_column(
+            buffer,
+            match.begin(:partial),
+          )
+
+          end_line, end_character = from_index_to_row_column(
+            buffer,
+            match.end(:partial)
+          )
+
+          {
+            target: asset_link(match[:partial]),
+            range: {
+              start: {
+                line: start_line,
+                character: start_character,
+              },
+              end: {
+                line: end_line,
+                character: end_character,
+              },
+            },
+          }
+        end
+        snippet_matches + asset_matches
+      end
+
+      def snippet_link(partial)
+        file_link('snippets', partial, '.liquid')
       end
 
-      def link(partial)
-        "file://#{@storage.path('snippets/' + partial + '.liquid')}"
+      def asset_link(partial)
+        file_link('assets', partial, '')
+      end
+
+      private
+
+      def file_link(directory, partial, extension)
+        "file://#{@storage.path(directory + '/' + partial + extension)}"
       end
     end
   end

data/lib/theme_check/language_server/handler.rb

@@ -99,7 +99,7 @@ module ThemeCheck
       end
 
       def path_from_uri(uri)
-        uri&.sub('file://', '')
+        uri&.sub('file://', '')&.sub('/c%3A', '')
       end
 
       def relative_path_from_text_document_uri(params)

data/lib/theme_check/language_server/server.rb

@@ -52,8 +52,19 @@ module ThemeCheck
         response_body = JSON.dump(response)
         log(JSON.pretty_generate(response)) if $DEBUG
 
-        @out.write("Content-Length: #{response_body.bytesize}\r\n")
-        @out.write("\r\n")
+        # Because programming is fun,
+        #
+        # Ruby on Windows turns \n into \r\n. Which means that \r\n
+        # gets turned into \r\r\n. Which means that the protocol
+        # breaks on windows unless we turn STDOUT into binary mode and
+        # set the encoding manually (yuk!) or we do this little hack
+        # here and put \n which gets transformed into \r\n on windows
+        # only...
+        #
+        # Hours wasted: 8.
+        eol = Gem.win_platform? ? "\n" : "\r\n"
+        @out.write("Content-Length: #{response_body.bytesize}#{eol}")
+        @out.write(eol)
         @out.write(response_body)
         @out.flush
       end

data/lib/theme_check/liquid_check.rb

@@ -5,17 +5,5 @@ module ThemeCheck
   class LiquidCheck < Check
     extend ChecksTracking
     include ParsingHelpers
-
-    # TODO: remove this once all regex checks are migrate to HtmlCheck# TODO: remove this once all regex checks are migrate to HtmlCheck
-    TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
-    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
-    START_OR_END_QUOTE = /(^['"])|(['"]$)/
-    QUOTED_LIQUID_ATTRIBUTE = %r{
-      '(?:#{TAG}|#{VARIABLE}|[^'])*'| # any combination of tag/variable or non straight quote inside straight quotes
-      "(?:#{TAG}|#{VARIABLE}|[^"])*"  # any combination of tag/variable or non double quotes inside double quotes
-    }omix
-    ATTR = /[a-z0-9-]+/i
-    HTML_ATTRIBUTE = /#{ATTR}(?:=#{QUOTED_LIQUID_ATTRIBUTE})?/omix
-    HTML_ATTRIBUTES = /(?:#{HTML_ATTRIBUTE}|\s)*/omix
   end
 end

data/lib/theme_check/parsing_helpers.rb

@@ -7,8 +7,10 @@ module ThemeCheck
 
       while scanner.scan(/.*?("|')/)
         yield scanner.matched[0..-2]
+        quote = scanner.matched[-1] == "'" ? "'" : "\""
         # Skip to the end of the string
-        scanner.skip_until(scanner.matched[-1] == "'" ? /[^\\]'/ : /[^\\]"/)
+        # Check for empty string first, since follow regexp uses lookahead
+        scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
       end
 
       yield scanner.rest if scanner.rest?

data/lib/theme_check/regex_helpers.rb

@@ -2,6 +2,8 @@
 
 module ThemeCheck
   module RegexHelpers
+    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    START_OR_END_QUOTE = /(^['"])|(['"]$)/
     def matches(s, re)
       start_at = 0
       matches = []
@@ -11,5 +13,20 @@ module ThemeCheck
       end
       matches
     end
+
+    def href_to_file_size(href)
+      # asset_url (+ optional stylesheet_tag) variables
+      if href =~ /^#{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?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{^(https?:)?//}
+        asset = RemoteAssetFile.from_src(href)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/tags.rb

@@ -125,6 +125,42 @@ module ThemeCheck
       end
     end
 
+    class Render < Liquid::Tag
+      SYNTAX = /((?:#{Liquid::QuotedString}|#{Liquid::VariableSegment})+)(\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?(\s+(?:as)\s+(#{Liquid::VariableSegment}+))?/o
+
+      disable_tags "include"
+
+      attr_reader :template_name_expr, :attributes
+
+      def initialize(tag_name, markup, options)
+        super
+
+        raise SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
+
+        template_name = Regexp.last_match(1)
+        with_or_for = Regexp.last_match(3)
+        variable_name = Regexp.last_match(4)
+
+        @alias_name = Regexp.last_match(6)
+        @variable_name_expr = variable_name ? parse_expression(variable_name) : nil
+        @template_name_expr = parse_expression(template_name)
+        @for = (with_or_for == Liquid::Render::FOR)
+
+        @attributes = {}
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @attributes[key] = parse_expression(value)
+        end
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.template_name_expr,
+          ] + @node.attributes.values
+        end
+      end
+    end
+
     class Style < Liquid::Block; end
 
     class Schema < Liquid::Raw; end
@@ -133,13 +169,31 @@ module ThemeCheck
 
     class Stylesheet < Liquid::Raw; end
 
-    Liquid::Template.register_tag('form', Form)
-    Liquid::Template.register_tag('layout', Layout)
-    Liquid::Template.register_tag('paginate', Paginate)
-    Liquid::Template.register_tag('section', Section)
-    Liquid::Template.register_tag('style', Style)
-    Liquid::Template.register_tag('schema', Schema)
-    Liquid::Template.register_tag('javascript', Javascript)
-    Liquid::Template.register_tag('stylesheet', Stylesheet)
+    class << self
+      attr_writer :register_tags
+
+      def register_tags?
+        @register_tags
+      end
+
+      def register_tag(name, klass)
+        Liquid::Template.register_tag(name, klass)
+      end
+
+      def register_tags!
+        return if !register_tags? || (defined?(@registered_tags) && @registered_tags)
+        @registered_tags = true
+        register_tag('form', Form)
+        register_tag('layout', Layout)
+        register_tag('render', Render)
+        register_tag('paginate', Paginate)
+        register_tag('section', Section)
+        register_tag('style', Style)
+        register_tag('schema', Schema)
+        register_tag('javascript', Javascript)
+        register_tag('stylesheet', Stylesheet)
+      end
+    end
+    self.register_tags = true
   end
 end

data/lib/theme_check/template.rb

@@ -1,25 +1,7 @@
 # frozen_string_literal: true
-require "pathname"
 
 module ThemeCheck
-  class Template
-    def initialize(relative_path, storage)
-      @storage = storage
-      @relative_path = relative_path
-    end
-
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def source
-      @source ||= @storage.read(@relative_path)
-    end
-
+  class Template < ThemeFile
     def write
       content = updated_content
       if source != content
@@ -28,14 +10,6 @@ module ThemeCheck
       end
     end
 
-    def name
-      relative_path.sub_ext('').to_s
-    end
-
-    def json?
-      false
-    end
-
     def liquid?
       true
     end
@@ -88,16 +62,13 @@ module ThemeCheck
       parse.root
     end
 
-    def ==(other)
-      other.is_a?(Template) && relative_path == other.relative_path
-    end
-    alias_method :eql?, :==
-
     def self.parse(source)
+      Tags.register_tags!
       Liquid::Template.parse(
         source,
         line_numbers: true,
         error_mode: :warn,
+        disable_liquid_c_nodes: true,
       )
     end
   end

data/lib/theme_check/theme_file.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require "pathname"
+
+module ThemeCheck
+  class ThemeFile
+    def initialize(relative_path, storage)
+      @relative_path = relative_path
+      @storage = storage
+    end
+
+    def path
+      @storage.path(@relative_path)
+    end
+
+    def relative_path
+      @relative_pathname ||= Pathname.new(@relative_path)
+    end
+
+    def name
+      relative_path.sub_ext('').to_s
+    end
+
+    def source
+      @source ||= @storage.read(@relative_path)
+    end
+
+    def json?
+      false
+    end
+
+    def liquid?
+      false
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && relative_path == other.relative_path
+    end
+    alias_method :eql?, :==
+  end
+end

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -44,6 +44,8 @@ email:
 executables:
 - theme-check
 - theme-check-language-server
+- theme-check-language-server.bat
+- theme-check.bat
 extensions: []
 extra_rdoc_files: []
 files:
@@ -62,6 +64,8 @@ files:
 - Rakefile
 - bin/liquid-server
 - config/default.yml
+- config/nothing.yml
+- config/theme_app_extension.yml
 - data/shopify_liquid/deprecated_filters.yml
 - data/shopify_liquid/filters.yml
 - data/shopify_liquid/objects.yml
@@ -74,13 +78,19 @@ files:
 - docs/api/json_check.md
 - docs/api/liquid_check.md
 - docs/checks/TEMPLATE.md.erb
+- docs/checks/asset_size_app_block_css.md
+- docs/checks/asset_size_app_block_javascript.md
 - docs/checks/asset_size_css.md
+- docs/checks/asset_size_css_stylesheet_tag.md
 - docs/checks/asset_size_javascript.md
 - docs/checks/asset_url_filters.md
 - docs/checks/content_for_header_modification.md
 - docs/checks/convert_include_to_render.md
 - docs/checks/default_locale.md
+- docs/checks/deprecate_bgsizes.md
+- docs/checks/deprecate_lazysizes.md
 - docs/checks/deprecated_filter.md
+- docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
 - docs/checks/liquid_tag.md
@@ -109,6 +119,8 @@ 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
@@ -116,13 +128,19 @@ files:
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/TEMPLATE.rb.erb
+- 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
+- lib/theme_check/checks/asset_size_css_stylesheet_tag.rb
 - lib/theme_check/checks/asset_size_javascript.rb
 - lib/theme_check/checks/asset_url_filters.rb
 - lib/theme_check/checks/content_for_header_modification.rb
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
+- 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/html_parsing_error.rb
 - lib/theme_check/checks/img_lazy_loading.rb
 - lib/theme_check/checks/img_width_and_height.rb
 - lib/theme_check/checks/liquid_tag.rb
@@ -201,6 +219,7 @@ files:
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb
 - lib/theme_check/theme.rb
+- lib/theme_check/theme_file.rb
 - lib/theme_check/version.rb
 - lib/theme_check/visitor.rb
 - packaging/homebrew/theme_check.base.rb
@@ -225,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: A Shopify Theme Linter