theme-check 0.3.0 → 0.5.0

data/lib/theme_check/checks/default_locale.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class DefaultLocale < JsonCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def on_end
       return if @theme.default_locale_json

data/lib/theme_check/checks/deprecated_filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module ThemeCheck
   class DeprecatedFilter < LiquidCheck
-    doc "https://shopify.dev/docs/themes/liquid/reference/filters/deprecated-filters"
+    doc docs_url(__FILE__)
     category :liquid
     severity :suggestion
 

data/lib/theme_check/checks/liquid_tag.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 module ThemeCheck
-  # Recommends using {% liquid ... %} if 3 or more consecutive {% ... %} are found.
+  # Recommends using {% liquid ... %} if 4 or more consecutive {% ... %} are found.
   class LiquidTag < LiquidCheck
     severity :suggestion
     category :liquid
-    doc "https://shopify.dev/docs/themes/liquid/reference/tags/theme-tags#liquid"
+    doc docs_url(__FILE__)
 
-    def initialize(min_consecutive_statements: 10)
+    def initialize(min_consecutive_statements: 4)
       @first_statement = nil
       @consecutive_statements = 0
       @min_consecutive_statements = min_consecutive_statements

data/lib/theme_check/checks/matching_schema_translations.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class MatchingSchemaTranslations < LiquidCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def on_schema(node)
       schema = JSON.parse(node.value.nodelist.join)

data/lib/theme_check/checks/matching_translations.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class MatchingTranslations < JsonCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def initialize
       @files = []

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -2,6 +2,7 @@
 module ThemeCheck
   class MissingEnableComment < LiquidCheck
     severity :error
+    doc docs_url(__FILE__)
 
     # Don't allow this check to be disabled with a comment,
     # as we need to be able to check for disabled checks.

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -3,11 +3,10 @@
 module ThemeCheck
   # Reports missing shopify required theme files
   # required templates: https://shopify.dev/tutorials/review-theme-store-requirements-files
-
   class MissingRequiredTemplateFiles < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/docs/themes/theme-templates"
+    doc docs_url(__FILE__)
 
     REQUIRED_LIQUID_FILES = %w(layout/theme)
     REQUIRED_TEMPLATE_FILES = %w(

data/lib/theme_check/checks/missing_template.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class MissingTemplate < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_include(node)
       template = node.value.template_name_expr

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
@@ -49,23 +55,28 @@ module ThemeCheck
       end
     end
 
-    def initialize
+    def initialize(exclude_snippets: false)
+      @exclude_snippets = exclude_snippets
       @files = {}
     end
 
     def on_document(node)
+      return if ignore?(node)
       @files[node.template.name] = TemplateInfo.new
     end
 
     def on_assign(node)
+      return if ignore?(node)
       @files[node.template.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
+      return if ignore?(node)
       @files[node.template.name].all_captures[node.value.instance_variable_get('@to')] = node
     end
 
     def on_for(node)
+      return if ignore?(node)
       @files[node.template.name].all_forloops[node.value.variable_name] = node
     end
 
@@ -75,6 +86,7 @@ module ThemeCheck
     end
 
     def on_render(node)
+      return if ignore?(node)
       return unless node.value.template_name_expr.is_a?(String)
 
       snippet_name = "snippets/#{node.value.template_name_expr}"
@@ -85,6 +97,7 @@ module ThemeCheck
     end
 
     def on_variable_lookup(node)
+      return if ignore?(node)
       @files[node.template.name].add_variable_lookup(
         name: node.value.name,
         node: node,
@@ -114,15 +127,20 @@ module ThemeCheck
       end
     end
 
+    private
+
+    def ignore?(node)
+      @exclude_snippets && node.template.snippet?
+    end
+
     def each_template
       @files.each do |(name, info)|
         next if name.starts_with?('snippets/')
         yield [name, info]
       end
     end
-    private :each_template
 
-    def check_object(info, all_global_objects, render_node = nil)
+    def check_object(info, all_global_objects, render_node = nil, visited_snippets = Set.new)
       check_undefined(info, all_global_objects, render_node)
 
       info.each_snippet do |(snippet_name, node)|
@@ -131,16 +149,18 @@ module ThemeCheck
 
         snippet_variables = node.value.attributes.keys +
           Array[node.value.instance_variable_get("@alias_name")]
-        check_object(snippet_info, all_global_objects + snippet_variables, node)
+        unless visited_snippets.include?(snippet_name)
+          visited_snippets << snippet_name
+          check_object(snippet_info, all_global_objects + snippet_variables, node, visited_snippets)
+        end
       end
     end
-    private :check_object
 
     def check_undefined(info, all_global_objects, render_node)
       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)
 
@@ -150,10 +170,9 @@ 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
-    private :check_undefined
   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,14 +4,16 @@ 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)
+      def collect_used_assigns(templates, visited = Set.new)
         collected = used_assigns
         # Check recursively inside included snippets for use
         includes.each do |name|
-          if templates[name]
-            collected += templates[name].collect_used_assigns(templates)
+          if templates[name] && !visited.include?(name)
+            visited << name
+            collected += templates[name].collect_used_assigns(templates, visited)
           end
         end
         collected

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

@@ -11,6 +11,7 @@ module ThemeCheck
         -x, [--exclude-category]  # Exclude this category of checks
         -l, [--list]              # List enabled checks
         -a, [--auto-correct]      # Automatically fix offenses
+        --init                    # Generate a .theme-check.yml file in the current directory
         -h, [--help]              # Show this. Hi!
         -v, [--version]           # Print Theme Check version
 
@@ -22,7 +23,7 @@ module ThemeCheck
     END
 
     def run(argv)
-      path = "."
+      @path = "."
 
       command = :check
       only_categories = []
@@ -44,15 +45,19 @@ module ThemeCheck
           command = :list
         when "--auto-correct", "-a"
           auto_correct = true
+        when "--init"
+          command = :init
         else
-          path = arg
+          @path = arg
         end
       end
 
-      @config = ThemeCheck::Config.from_path(path)
-      @config.only_categories = only_categories
-      @config.exclude_categories = exclude_categories
-      @config.auto_correct = auto_correct
+      unless [:version, :init].include?(command)
+        @config = ThemeCheck::Config.from_path(@path)
+        @config.only_categories = only_categories
+        @config.exclude_categories = exclude_categories
+        @config.auto_correct = auto_correct
+      end
 
       send(command)
     end
@@ -75,6 +80,17 @@ module ThemeCheck
       puts ThemeCheck::VERSION
     end
 
+    def init
+      dotfile_path = ThemeCheck::Config.find(@path)
+      if dotfile_path.nil?
+        File.write(File.join(@path, ThemeCheck::Config::DOTFILE), File.read(ThemeCheck::Config::DEFAULT_CONFIG))
+
+        puts "Writing new #{ThemeCheck::Config::DOTFILE} to #{@path}"
+      else
+        raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}."
+      end
+    end
+
     def check
       puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)

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

@@ -6,7 +6,7 @@
 # as a big hash already, leave it like that and save yourself some IO.
 module ThemeCheck
   class InMemoryStorage < Storage
-    def initialize(files)
+    def initialize(files = {})
       @files = files
     end
 

data/lib/theme_check/language_server.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
+require_relative "language_server/protocol"
 require_relative "language_server/handler"
 require_relative "language_server/server"
+require_relative "language_server/tokens"
+require_relative "language_server/position_helper"
+require_relative "language_server/completion_helper"
+require_relative "language_server/completion_provider"
+require_relative "language_server/completion_engine"
+
+Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
+  require file
+end
 
 module ThemeCheck
   module LanguageServer