theme-check 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b17d14eb5abc8211b6b6ae9f3a676c44770775821a87ce0909412d3eddb81c35
-  data.tar.gz: 7bcad0d34832338dd8cd83f220b14c45b061b84b81c5ae2b3a18805aeb9400eb
+  metadata.gz: 5543690a150f2a864a5a9900feca80286ffe4c00d545885ee31dc02c9d389b71
+  data.tar.gz: c1c518e2013a1106dc7ace3a14ef5158853e06929694503777a37c0fc695025a
 SHA512:
-  metadata.gz: 241dfdae6ec38c560ca4697c4b9256d4ceaed0300e9a575c3c92e864ea4fa2fd56420efd87ec2c0f744240fe9db5c6cc7df24c1da8d9606fab020bdd1d630450
-  data.tar.gz: bbb52dcf01cf1dcbc3f73fe90d822b9ee22407a31525aab314ad0121e1bd9f52c786b6528594e5eb6224d97e567108bd7962a8c7a67d6e17702a976bab3edb1a
+  metadata.gz: 405832fbd93d17f3412abb83181b8c76c0aee43e2405bc7329b7ace746c20887c32ab638bf49c99adf4598532fc92d5840a46dc24d2a20b89909849b8c2813a3
+  data.tar.gz: 40316910f51d646017059d4256cba23dfcb9e20822a0987b65a04ab79c40c160c882d4bdf7e0cc4d646b08971ba04bb58999a7c5b93a4741233a8ce1c5ce4ad9

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+v0.4.0 / 2021-02-25
+==================
+
+  * Add Completion Engine ([#161](https://github.com/shopify/theme-check/issues/161))
+  * Add init command to CLI ([#174](https://github.com/shopify/theme-check/issues/174))
+  * Refactor start and end Position logic ([#172](https://github.com/shopify/theme-check/issues/172))
+
 v0.3.3 / 2021-02-18
 ==================
 

data/README.md

@@ -8,8 +8,6 @@ Theme Check is also available [inside some code editors](https://github.com/Shop
 
 ![](docs/preview.png)
 
-_Disclaimer: This tool is not supported as part of the Partners program._
-
 ## Supported Checks
 
 Theme Check currently checks for the following:

data/data/shopify_liquid/tags.yml

@@ -0,0 +1,26 @@
+---
+- assign
+- break
+- capture
+- case
+- comment
+- continue
+- cycle
+- decrement
+- echo
+- for
+- form
+- if
+- ifchanged
+- increment
+- javascript
+- layout
+- paginate
+- raw
+- render
+- schema
+- section
+- style
+- stylesheet
+- tablerow
+- unless

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/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

data/lib/theme_check/language_server/completion_engine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class CompletionEngine
+      include PositionHelper
+
+      def initialize(storage)
+        @storage = storage
+        @providers = CompletionProvider.all.map(&:new)
+      end
+
+      def completions(name, line, col)
+        buffer = @storage.read(name)
+        cursor = from_line_column_to_index(buffer, line, col)
+        token = find_token(buffer, cursor)
+        return [] if token.nil?
+
+        @providers.flat_map do |p|
+          p.completions(
+            token.content,
+            cursor - token.start
+          )
+        end
+      end
+
+      def find_token(buffer, cursor)
+        Tokens.new(buffer).find do |token|
+          # Here we include the next character and exclude the first
+          # one becase when we want to autocomplete inside a token
+          # and at most 1 outside it since the cursor could be placed
+          # at the end of the token.
+          token.start < cursor && cursor <= token.end
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/completion_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    module CompletionHelper
+      WORD = /\w+/
+
+      def cursor_on_start_content?(content, cursor, regex)
+        content.slice(0, cursor).match?(/#{regex}(?:\s|\n)*$/m)
+      end
+
+      def cursor_on_first_word?(content, cursor)
+        word = content.match(WORD)
+        return false if word.nil?
+        word_start = word.begin(0)
+        word_end = word.end(0)
+        word_start <= cursor && cursor <= word_end
+      end
+
+      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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class CompletionProvider
+      include CompletionHelper
+
+      class << self
+        def all
+          @all ||= []
+        end
+
+        def inherited(subclass)
+          all << subclass
+        end
+      end
+
+      def completions(content, cursor)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/completion_providers/filter_completion_provider.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class FilterCompletionProvider < CompletionProvider
+      NAMED_FILTER = /#{Liquid::FilterSeparator}\s*(\w+)/o
+
+      def completions(content, cursor)
+        return [] unless can_complete?(content, cursor)
+        ShopifyLiquid::Filter.labels
+          .select { |w| w.starts_with?(partial(content, cursor)) }
+          .map { |filter| filter_to_completion(filter) }
+      end
+
+      def can_complete?(content, cursor)
+        content.match?(Liquid::FilterSeparator) && (
+          cursor_on_start_content?(content, cursor, Liquid::FilterSeparator) ||
+          cursor_on_filter?(content, cursor)
+        )
+      end
+
+      private
+
+      def cursor_on_filter?(content, cursor)
+        return false unless content.match?(NAMED_FILTER)
+        matches(content, NAMED_FILTER).any? do |match|
+          match.begin(1) <= cursor && cursor < match.end(1) + 1 # including next character
+        end
+      end
+
+      def partial(content, cursor)
+        return '' unless content.match?(NAMED_FILTER)
+        partial_match = matches(content, NAMED_FILTER).find do |match|
+          match.begin(1) <= cursor && cursor < match.end(1) + 1 # including next character
+        end
+        partial_match[1]
+      end
+
+      def filter_to_completion(filter)
+        {
+          label: filter,
+          kind: CompletionItemKinds::FUNCTION,
+        }
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/completion_providers/object_completion_provider.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class ObjectCompletionProvider < CompletionProvider
+      def completions(content, cursor)
+        return [] unless can_complete?(content, cursor)
+        partial = first_word(content) || ''
+        ShopifyLiquid::Object.labels
+          .select { |w| w.starts_with?(partial) }
+          .map { |object| object_to_completion(object) }
+      end
+
+      def can_complete?(content, cursor)
+        content.match?(Liquid::VariableStart) && (
+          cursor_on_first_word?(content, cursor) ||
+          cursor_on_start_content?(content, cursor, Liquid::VariableStart)
+        )
+      end
+
+      private
+
+      def object_to_completion(object)
+        {
+          label: object,
+          kind: CompletionItemKinds::VARIABLE,
+        }
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/completion_providers/tag_completion_provider.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class TagCompletionProvider < CompletionProvider
+      def completions(content, cursor)
+        return [] unless can_complete?(content, cursor)
+        partial = first_word(content) || ''
+        ShopifyLiquid::Tag.labels
+          .select { |w| w.starts_with?(partial) }
+          .map { |tag| tag_to_completion(tag) }
+      end
+
+      def can_complete?(content, cursor)
+        content.starts_with?(Liquid::TagStart) && (
+          cursor_on_first_word?(content, cursor) ||
+          cursor_on_start_content?(content, cursor, Liquid::TagStart)
+        )
+      end
+
+      private
+
+      def tag_to_completion(tag)
+        {
+          label: tag,
+          kind: CompletionItemKinds::KEYWORD,
+        }
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -4,9 +4,13 @@ module ThemeCheck
   module LanguageServer
     class Handler
       CAPABILITIES = {
+        completionProvider: {
+          triggerCharacters: ['.', '{{ ', '{% '],
+          context: true,
+        },
         textDocumentSync: {
           openClose: true,
-          change: false,
+          change: TextDocumentSyncKind::FULL,
           willSave: false,
           save: true,
         },
@@ -15,6 +19,8 @@ module ThemeCheck
       def initialize(server)
         @server = server
         @previously_reported_files = Set.new
+        @storage = InMemoryStorage.new
+        @completion_engine = CompletionEngine.new(@storage)
       end
 
       def on_initialize(id, params)
@@ -31,14 +37,52 @@ module ThemeCheck
       def on_exit(_id, _params)
         close!
       end
+      alias_method :on_shutdown, :on_exit
+
+      def on_text_document_did_change(_id, params)
+        uri = text_document_uri(params)
+        @storage.write(uri, content_changes_text(params))
+      end
+
+      def on_text_document_did_close(_id, params)
+        uri = text_document_uri(params)
+        @storage.write(uri, nil)
+      end
 
       def on_text_document_did_open(_id, params)
-        analyze_and_send_offenses(params.dig('textDocument', 'uri').sub('file://', ''))
+        uri = text_document_uri(params)
+        @storage.write(uri, text_document_text(params))
+        analyze_and_send_offenses(uri)
+      end
+
+      def on_text_document_did_save(_id, params)
+        analyze_and_send_offenses(text_document_uri(params))
+      end
+
+      def on_text_document_completion(id, params)
+        uri = text_document_uri(params)
+        line = params.dig('position', 'line')
+        col = params.dig('position', 'character')
+        send_response(
+          id: id,
+          result: completions(uri, line, col)
+        )
       end
-      alias_method :on_text_document_did_save, :on_text_document_did_open
 
       private
 
+      def text_document_uri(params)
+        params.dig('textDocument', 'uri').sub('file://', '')
+      end
+
+      def text_document_text(params)
+        params.dig('textDocument', 'text')
+      end
+
+      def content_changes_text(params)
+        params.dig('contentChanges', 0, 'text')
+      end
+
       def analyze_and_send_offenses(file_path)
         root = ThemeCheck::Config.find(file_path) || @root_path
         config = ThemeCheck::Config.from_path(root)
@@ -60,6 +104,10 @@ module ThemeCheck
         analyzer.offenses
       end
 
+      def completions(uri, line, col)
+        @completion_engine.completions(uri, line, col)
+      end
+
       def send_diagnostics(offenses)
         reported_files = Set.new
 

data/lib/theme_check/language_server/position_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# Note: Everything is 0-indexed here.
+
+module ThemeCheck
+  module LanguageServer
+    module PositionHelper
+      def from_line_column_to_index(content, row, col)
+        i = 0
+        result = 0
+        lines = content.lines
+        while i < row
+          result += lines[i].size
+          i += 1
+        end
+        result += col
+        result
+      end
+
+      def from_index_to_line_column(content, index)
+        lines = content[0..index].lines
+        row = lines.size - 1
+        col = lines.last.size - 1
+        [row, col]
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/protocol.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# Here we define the Language Server Protocol Constants we're using.
+# For complete docs, see the following:
+# https://microsoft.github.io/language-server-protocol/specifications/specification-current
+module ThemeCheck
+  module LanguageServer
+    module CompletionItemKinds
+      TEXT = 1
+      METHOD = 2
+      FUNCTION = 3
+      CONSTRUCTOR = 4
+      FIELD = 5
+      VARIABLE = 6
+      CLASS = 7
+      INTERFACE = 8
+      MODULE = 9
+      PROPERTY = 10
+      UNIT = 11
+      VALUE = 12
+      ENUM = 13
+      KEYWORD = 14
+      SNIPPET = 15
+      COLOR = 16
+      FILE = 17
+      REFERENCE = 18
+      FOLDER = 19
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+
+    module TextDocumentSyncKind
+      NONE = 0
+      FULL = 1
+      INCREMENTAL = 2
+    end
+  end
+end

data/lib/theme_check/language_server/tokens.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  Token = Struct.new(
+    :content,
+    :start, # inclusive
+    :end, # exclusive
+  )
+
+  TAG_START = Liquid::TagStart
+  TAG_END = Liquid::TagEnd
+  VARIABLE_START = Liquid::VariableStart
+  VARIABLE_END = Liquid::VariableEnd
+  SPLITTER = %r{
+    (?=(?:#{TAG_START}|#{VARIABLE_START}))| # positive lookahead on tag/variable start
+    (?<=(?:#{TAG_END}|#{VARIABLE_END}))     # positive lookbehind on tag/variable end
+  }xom
+
+  # Implemented as an Enumerable so we stop iterating on the find once
+  # we have what we want. Kind of a perf thing.
+  class Tokens
+    include Enumerable
+
+    def initialize(buffer)
+      @buffer = buffer
+    end
+
+    def each(&block)
+      return to_enum(:each) unless block_given?
+
+      chunks = @buffer.split(SPLITTER)
+      chunks.shift if chunks[0]&.empty?
+
+      prev = Token.new('', 0, 0)
+      curr = Token.new('', 0, 0)
+
+      while (content = chunks.shift)
+
+        curr.start = prev.end
+        curr.end = curr.start + content.size
+
+        block.call(Token.new(
+          content,
+          curr.start,
+          curr.end,
+        ))
+
+        # recycling structs
+        tmp = prev
+        prev = curr
+        curr = tmp
+      end
+    end
+  end
+end

data/lib/theme_check/offense.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module ThemeCheck
+  Position = Struct.new(:line, :column)
+
   class Offense
     MAX_SOURCE_EXCERPT_SIZE = 120
 
@@ -35,6 +37,9 @@ module ThemeCheck
       elsif @node
         @node.line_number
       end
+
+      @start_position = nil
+      @end_position = nil
     end
 
     def source_excerpt
@@ -50,29 +55,19 @@ module ThemeCheck
     end
 
     def start_line
-      return 0 unless line_number
-      line_number - 1
+      start_position.line
     end
 
-    def end_line
-      if markup&.ends_with?("\n")
-        start_line + markup.count("\n") - 1
-      elsif markup
-        start_line + markup.count("\n")
-      else
-        start_line
-      end
+    def start_column
+      start_position.column
     end
 
-    def start_column
-      return 0 unless line_number && markup
-      template.full_line(start_line + 1).index(markup.split("\n", 2).first)
+    def end_line
+      end_position.line
     end
 
     def end_column
-      return 0 unless line_number && markup
-      markup_end = markup.split("\n").last
-      template.full_line(end_line + 1).index(markup_end) + markup_end.size
+      end_position.column
     end
 
     def code_name
@@ -118,5 +113,45 @@ module ThemeCheck
         message
       end
     end
+
+    private
+
+    def full_line(line)
+      # Liquid::Template is 1-indexed.
+      template.full_line(line + 1)
+    end
+
+    def lines_of_content
+      @lines ||= markup.lines.map { |x| x.sub(/\n$/, '') }
+    end
+
+    # 0-indexed, inclusive
+    def start_position
+      return @start_position if @start_position
+      return @start_position = Position.new(0, 0) unless line_number && markup
+
+      position = Position.new
+      position.line = line_number - 1
+      position.column = full_line(position.line).index(lines_of_content.first) || 0
+
+      @start_position = position
+    end
+
+    # 0-indexed, exclusive. It's the line + col that are exclusive.
+    # This is why it doesn't make sense to calculate them separately.
+    def end_position
+      return @end_position if @end_position
+      return @end_position = Position.new(0, 0) unless line_number && markup
+
+      position = Position.new
+      position.line = start_line + lines_of_content.size - 1
+      position.column = if start_line == position.line
+        start_column + markup.size
+      else
+        lines_of_content.last.size
+      end
+
+      @end_position = position
+    end
   end
 end

data/lib/theme_check/shopify_liquid.rb

@@ -2,3 +2,4 @@
 require_relative 'shopify_liquid/deprecated_filter'
 require_relative 'shopify_liquid/filter'
 require_relative 'shopify_liquid/object'
+require_relative 'shopify_liquid/tag'

data/lib/theme_check/shopify_liquid/tag.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module ThemeCheck
+  module ShopifyLiquid
+    module Tag
+      extend self
+
+      def labels
+        @tags ||= begin
+          YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/tags.yml"))
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -80,6 +80,7 @@ files:
 - data/shopify_liquid/filters.yml
 - data/shopify_liquid/objects.yml
 - data/shopify_liquid/plus_objects.yml
+- data/shopify_liquid/tags.yml
 - dev.yml
 - docs/preview.png
 - exe/theme-check
@@ -123,8 +124,17 @@ files:
 - lib/theme_check/json_file.rb
 - lib/theme_check/json_helpers.rb
 - lib/theme_check/language_server.rb
+- lib/theme_check/language_server/completion_engine.rb
+- lib/theme_check/language_server/completion_helper.rb
+- lib/theme_check/language_server/completion_provider.rb
+- lib/theme_check/language_server/completion_providers/filter_completion_provider.rb
+- lib/theme_check/language_server/completion_providers/object_completion_provider.rb
+- lib/theme_check/language_server/completion_providers/tag_completion_provider.rb
 - lib/theme_check/language_server/handler.rb
+- lib/theme_check/language_server/position_helper.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/liquid_check.rb
 - lib/theme_check/locale_diff.rb
 - lib/theme_check/node.rb
@@ -136,6 +146,7 @@ files:
 - lib/theme_check/shopify_liquid/deprecated_filter.rb
 - lib/theme_check/shopify_liquid/filter.rb
 - lib/theme_check/shopify_liquid/object.rb
+- lib/theme_check/shopify_liquid/tag.rb
 - lib/theme_check/storage.rb
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb