theme-check 0.4.0 → 0.5.0

data/lib/theme_check/checks/nested_snippet.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class NestedSnippet < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     class TemplateInfo < Struct.new(:includes)
       def with_deep_nested(templates, max, current_level = 0)

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -3,7 +3,8 @@ module ThemeCheck
   # Reports errors when trying to use parser-blocking script tags
   class ParserBlockingJavaScript < LiquidCheck
     severity :error
-    category :liquid
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
 
     PARSER_BLOCKING_SCRIPT_TAG = %r{
       <script                                    # Find the start of a script tag

data/lib/theme_check/checks/required_directories.rb

@@ -5,7 +5,7 @@ module ThemeCheck
   class RequiredDirectories < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/tutorials/develop-theme-files"
+    doc docs_url(__FILE__)
 
     REQUIRED_DIRECTORIES = %w(assets config layout locales sections snippets templates)
 

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -4,7 +4,7 @@ module ThemeCheck
   class RequiredLayoutThemeObject < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/docs/themes/theme-templates/theme-liquid"
+    doc docs_url(__FILE__)
 
     LAYOUT_FILENAME = "layout/theme"
 

data/lib/theme_check/checks/space_inside_braces.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class SpaceInsideBraces < LiquidCheck
     severity :style
     category :liquid
+    doc docs_url(__FILE__)
 
     def initialize
       @ignore = false

data/lib/theme_check/checks/syntax_error.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class SyntaxError < LiquidCheck
     severity :error
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_document(node)
       node.template.warnings.each do |warning|

data/lib/theme_check/checks/template_length.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class TemplateLength < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     def initialize(max_length: 200, exclude_schema: true)
       @max_length = max_length

data/lib/theme_check/checks/translation_key_exists.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   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)

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
@@ -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,6 +5,7 @@ require 'nokogumbo'
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck
     severity :suggestion
+    doc docs_url(__FILE__)
 
     def on_file(file)
       return unless file.name.starts_with?("locales/")

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/config.rb

@@ -83,8 +83,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/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

data/lib/theme_check/language_server/handler.rb

@@ -138,12 +138,20 @@ module ThemeCheck
       end
 
       def offense_to_diagnostic(offense)
-        {
+        diagnostic = {
+          code: offense.code_name,
+          message: offense.message,
           range: range(offense),
           severity: severity(offense),
-          code: offense.code_name,
           source: "theme-check",
-          message: offense.message,
+        }
+        diagnostic["codeDescription"] = code_description(offense) unless offense.doc.nil?
+        diagnostic
+      end
+
+      def code_description(offense)
+        {
+          href: offense.doc,
         }
       end
 

data/lib/theme_check/language_server/server.rb

@@ -10,11 +10,13 @@ module ThemeCheck
 
     class Server
       attr_reader :handler
+      attr_reader :should_raise_errors
 
       def initialize(
         in_stream: STDIN,
         out_stream: STDOUT,
-        err_stream: $DEBUG ? File.open('/tmp/lsp.log', 'a') : STDERR
+        err_stream: $DEBUG ? File.open('/tmp/lsp.log', 'a') : STDERR,
+        should_raise_errors: false
       )
         validate!([in_stream, out_stream, err_stream])
 
@@ -25,6 +27,8 @@ module ThemeCheck
 
         @out.sync = true # do not buffer
         @err.sync = true # do not buffer
+
+        @should_raise_errors = should_raise_errors
       end
 
       def listen
@@ -37,6 +41,7 @@ module ThemeCheck
           return 0
 
         rescue Exception => e # rubocop:disable Lint/RescueException
+          raise e if should_raise_errors
           log(e)
           log(e.backtrace)
           return 1

data/lib/theme_check/regex_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module RegexHelpers
+    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

data/lib/theme_check/remote_asset_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "net/http"
+require "pathname"
+
+module ThemeCheck
+  class RemoteAssetFile
+    class << self
+      def cache
+        @cache ||= {}
+      end
+
+      def from_src(src)
+        key = uri(src).to_s
+        cache[key] = RemoteAssetFile.new(src) unless cache.key?(key)
+        cache[key]
+      end
+
+      def uri(src)
+        URI.parse(src.sub(%r{^//}, "https://"))
+      end
+    end
+
+    def initialize(src)
+      @uri = RemoteAssetFile.uri(src)
+      @content = nil
+    end
+
+    def content
+      return @content unless @content.nil?
+
+      res = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: @uri.scheme == 'https') do |http|
+        req = Net::HTTP::Get.new(@uri)
+        req['Accept-Encoding'] = 'gzip, deflate, br'
+        http.request(req)
+      end
+
+      @content = res.body
+    end
+
+    def gzipped_size
+      @gzipped_size ||= @content.bytesize
+    end
+  end
+end

data/lib/theme_check/theme.rb

@@ -11,6 +11,12 @@ module ThemeCheck
       @storage = storage
     end
 
+    def assets
+      @assets ||= @storage.files
+        .select { |path| path.starts_with?("assets/") }
+        .map { |path| AssetFile.new(path, @storage) }
+    end
+
     def liquid
       @liquid ||= @storage.files
         .select { |path| LIQUID_REGEX.match?(path) }
@@ -43,7 +49,7 @@ module ThemeCheck
     end
 
     def all
-      @all ||= json + liquid
+      @all ||= json + liquid + assets
     end
 
     def [](name)

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -82,13 +82,41 @@ files:
 - data/shopify_liquid/plus_objects.yml
 - data/shopify_liquid/tags.yml
 - dev.yml
+- docs/checks/CHECK_DOCS_TEMPLATE.md
+- docs/checks/asset_size_javascript.md
+- docs/checks/convert_include_to_render.md
+- docs/checks/default_locale.md
+- docs/checks/deprecated_filter.md
+- docs/checks/liquid_tag.md
+- docs/checks/matching_schema_translations.md
+- docs/checks/matching_translations.md
+- docs/checks/missing_enable_comment.md
+- docs/checks/missing_required_template_files.md
+- docs/checks/missing_template.md
+- docs/checks/nested_snippet.md
+- docs/checks/parser_blocking_javascript.md
+- docs/checks/required_directories.md
+- docs/checks/required_layout_theme_object.md
+- docs/checks/space_inside_braces.md
+- docs/checks/syntax_error.md
+- docs/checks/template_length.md
+- docs/checks/translation_key_exists.md
+- docs/checks/undefined_object.md
+- docs/checks/unknown_filter.md
+- docs/checks/unused_assign.md
+- docs/checks/unused_snippet.md
+- docs/checks/valid_html_translation.md
+- docs/checks/valid_json.md
+- docs/checks/valid_schema.md
 - docs/preview.png
 - exe/theme-check
 - exe/theme-check-language-server
 - lib/theme_check.rb
 - lib/theme_check/analyzer.rb
+- lib/theme_check/asset_file.rb
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
+- lib/theme_check/checks/asset_size_javascript.rb
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
 - lib/theme_check/checks/deprecated_filter.rb
@@ -142,6 +170,8 @@ files:
 - lib/theme_check/packager.rb
 - lib/theme_check/parsing_helpers.rb
 - lib/theme_check/printer.rb
+- lib/theme_check/regex_helpers.rb
+- lib/theme_check/remote_asset_file.rb
 - lib/theme_check/shopify_liquid.rb
 - lib/theme_check/shopify_liquid/deprecated_filter.rb
 - lib/theme_check/shopify_liquid/filter.rb