theme-check 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bec2f54c12487d444bebd3bb0abad48ec133c4e9504be29857a58c87d82f589
-  data.tar.gz: 2cacd6af05aa3c2af8d40167a04532ed998d24049df7b277f70baf50f0a4e401
+  metadata.gz: e154c11ed7f84b968edac05c97afb2611e816933d790347cdbdca63071d46e88
+  data.tar.gz: dd8fc72c420412ab3adfad64f3d11197f562904bd0171289debe8e440ca34c86
 SHA512:
-  metadata.gz: 95a61ee91b1a575dead56345172c5472cdb1c314b94aef37814f311ab54d39263a70d51192ea5d276188d06e8ddc32715f9693f7089157e3376bd7c885b1d30a
-  data.tar.gz: 6fe39a2b8944ceb34e48b5a4a84cbb1f544d870b9c38f36dff33ff2e226f76feabb612d9f9e98ce31c2c68209014b46d76adcd0a4dd37224aee3c2ee266e50d0
+  metadata.gz: 0315a3eb75f5cda96fe2be02d7533e07aa364fc7b3e08bdb2682edf50f30d13bc2c03099d015c73db2e1c6e7d06c90707068d596db044176ddcdaea4bfe3a65c
+  data.tar.gz: a7050df945829d05a0440464d0ac309d3cc55d9fdd9909259b95f2405beae746e799aad8beeb564508b0a543568dcd718edb9638c1307bb345051784818ea165

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+v1.4.0 / 2021-08-30
+==================
+
+  * Add new object drop: `predictive_search`
+  * Bump `TemplateLength` `max_length` default
+  * Fix `RemoteAsset` incorrectly firing on structured data elements [#393](https://github.com/Shopify/theme-check/issues/393)
+  * Fix document links not working on open
+  * Fix `asset_url` document links
+  * Use better heuristics for `DeprecateLazysizes`
+  * Add support for `section` document links
+  * Add support for `include` document links
+  * Automatically creates the default translation file (`locales/en.default.json`) if it doesn't already exist.
+
 v1.3.0 / 2021-08-26
 ==================
 

data/config/default.yml

@@ -45,7 +45,7 @@ SyntaxError:
 TemplateLength:
   enabled: true
   ignore: []
-  max_length: 500
+  max_length: 600
   # Exclude content of {% schema %} in line count
   exclude_schema: true
   # Exclude content of {% stylesheet %} in line count

data/data/shopify_liquid/objects.yml

@@ -54,6 +54,7 @@
 - part
 - policy
 - powered_by_link
+- predictive_search 
 - product
 - product_option
 - product_variant

data/docs/checks/deprecate_lazysizes.md

@@ -10,9 +10,6 @@ This check is aimed at discouraging the use of the lazysizes JavaScript library
 
 ```liquid
 
-<!-- Reports use of "lazyload" class -->
-<img src="a.jpg" class="lazyload">
-
 <!-- Reports use of "data-srcset" and "data-sizes" attribute. Reports data-sizes="auto" -->
 <img
   alt="House by the lake"

data/docs/checks/template_length.md

@@ -21,7 +21,7 @@ The default configuration for this check is the following:
 ```yaml
 TemplateLength:
   enabled: true
-  max_length: 500
+  max_length: 600
   exclude_schema: true
   exclude_stylesheet: true
   exclude_javascript: true

data/lib/theme_check/analyzer.rb

@@ -87,6 +87,7 @@ module ThemeCheck
       if @auto_correct
         offenses.each(&:correct)
         @theme.liquid.each(&:write)
+        @theme.json.each(&:write)
       end
     end
 

data/lib/theme_check/checks/default_locale.rb

@@ -7,7 +7,9 @@ module ThemeCheck
 
     def on_end
       return if @theme.default_locale_json
-      add_offense("Default translation file not found (for example locales/en.default.json)")
+      add_offense("Default translation file not found (for example locales/en.default.json)") do |corrector|
+        corrector.create_default_locale_json(@theme)
+      end
     end
   end
 end

data/lib/theme_check/checks/deprecate_lazysizes.rb

@@ -7,10 +7,13 @@ module ThemeCheck
 
     def on_img(node)
       class_list = node.attributes["class"]&.split(" ")
+      has_loading_lazy = node.attributes["loading"] == "lazy"
+      has_native_source = node.attributes["src"] || node.attributes["srcset"]
+      return if has_native_source && has_loading_lazy
+      has_lazysize_source = node.attributes["data-srcset"] || node.attributes["data-src"]
+      has_lazysize_class = class_list&.include?("lazyload")
+      return unless has_lazysize_class && has_lazysize_source
       add_offense("Use the native loading=\"lazy\" attribute instead of lazysizes", node: node) if class_list&.include?("lazyload")
-      add_offense("Use the native srcset attribute instead of data-srcset", node: node) if node.attributes["data-srcset"]
-      add_offense("Use the native sizes attribute instead of data-sizes", node: node) if node.attributes["data-sizes"]
-      add_offense("Do not set the data-sizes attribute to auto", node: node) if node.attributes["data-sizes"] == "auto"
     end
   end
 end

data/lib/theme_check/checks/remote_asset.rb

@@ -23,9 +23,9 @@ module ThemeCheck
       return if resource_url =~ RELATIVE_PATH
       return if url_hosted_by_shopify?(resource_url)
 
-      # Ignore non-stylesheet rel tags
+      # Ignore non-stylesheet link tags
       rel = node.attributes["rel"]
-      return if rel && rel != "stylesheet"
+      return if node.name == "link" && rel != "stylesheet"
 
       add_offense(
         "Asset should be served by the Shopify CDN for better performance.",

data/lib/theme_check/checks/template_length.rb

@@ -5,7 +5,7 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(max_length: 500, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
+    def initialize(max_length: 600, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
       @exclude_stylesheet = exclude_stylesheet

data/lib/theme_check/corrector.rb

@@ -31,5 +31,10 @@ module ThemeCheck
     def create(theme, relative_path, content)
       theme.storage.write(relative_path, content)
     end
+
+    def create_default_locale_json(theme)
+      theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
+      theme.default_locale_json.update_contents('{}')
+    end
   end
 end

data/lib/theme_check/json_file.rb

@@ -20,6 +20,17 @@ module ThemeCheck
       @parser_error
     end
 
+    def update_contents(new_content = '{}')
+      @content = new_content
+    end
+
+    def write
+      if source != @content
+        @storage.write(@relative_path, content)
+        @source = content
+      end
+    end
+
     def json?
       true
     end

data/lib/theme_check/language_server/constants.rb

@@ -2,21 +2,28 @@
 
 module ThemeCheck
   module LanguageServer
-    PARTIAL_RENDER = %r{
-      \{\%-?\s*render\s+'(?<partial>[^']*)'|
-      \{\%-?\s*render\s+"(?<partial>[^"]*)"|
+    def self.partial_tag(tag)
+      %r{
+        \{\%-?\s*#{tag}\s+'(?<partial>[^']*)'|
+        \{\%-?\s*#{tag}\s+"(?<partial>[^"]*)"|
+
+        # in liquid tags the whole line is white space until the tag
+        ^\s*#{tag}\s+'(?<partial>[^']*)'|
+        ^\s*#{tag}\s+"(?<partial>[^"]*)"
+      }mix
+    end
+
+    PARTIAL_RENDER = partial_tag('render')
+    PARTIAL_INCLUDE = partial_tag('include')
+    PARTIAL_SECTION = partial_tag('section')
 
-      # in liquid tags the whole line is white space until render
-      ^\s*render\s+'(?<partial>[^']*)'|
-      ^\s*render\s+"(?<partial>[^"]*)"
-    }mix
     ASSET_INCLUDE = %r{
-      \{\%-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
-      \{\%-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
+      \{\{-?\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
+      ^\s*(?:echo|assign[^=]*\=)\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      ^\s*(?:echo|assign[^=]*\=)\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
     }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -3,81 +3,17 @@
 module ThemeCheck
   module LanguageServer
     class DocumentLinkEngine
-      include PositionHelper
-      include RegexHelpers
-
       def initialize(storage)
         @storage = storage
+        @providers = DocumentLinkProvider.all.map { |x| x.new(storage) }
       end
 
       def document_links(relative_path)
         buffer = @storage.read(relative_path)
         return [] unless buffer
-        snippet_matches = matches(buffer, PARTIAL_RENDER).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: snippet_link(match[:partial]),
-            range: {
-              start: {
-                line: start_line,
-                character: start_character,
-              },
-              end: {
-                line: end_line,
-                character: end_character,
-              },
-            },
-          }
+        @providers.flat_map do |p|
+          p.document_links(buffer)
         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 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/document_link_provider.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class DocumentLinkProvider
+      include RegexHelpers
+      include PositionHelper
+
+      class << self
+        attr_accessor :partial_regexp, :destination_directory, :destination_postfix
+
+        def all
+          @all ||= []
+        end
+
+        def inherited(subclass)
+          all << subclass
+        end
+      end
+
+      def initialize(storage = InMemoryStorage.new)
+        @storage = storage
+      end
+
+      def partial_regexp
+        self.class.partial_regexp
+      end
+
+      def destination_directory
+        self.class.destination_directory
+      end
+
+      def destination_postfix
+        self.class.destination_postfix
+      end
+
+      def document_links(buffer)
+        matches(buffer, partial_regexp).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: file_link(match[:partial]),
+            range: {
+              start: {
+                line: start_line,
+                character: start_character,
+              },
+              end: {
+                line: end_line,
+                character: end_character,
+              },
+            },
+          }
+        end
+      end
+
+      def file_link(partial)
+        "file://#{@storage.path(destination_directory + '/' + partial + destination_postfix)}"
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class AssetDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = ASSET_INCLUDE
+      @destination_directory = "assets"
+      @destination_postfix = ""
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class IncludeDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_INCLUDE
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class RenderDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_RENDER
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class SectionDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_SECTION
+      @destination_directory = "sections"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -55,10 +55,9 @@ module ThemeCheck
       end
 
       def on_text_document_did_open(_id, params)
-        return unless @diagnostics_tracker.first_run?
         relative_path = relative_path_from_text_document_uri(params)
         @storage.write(relative_path, text_document_text(params))
-        analyze_and_send_offenses(text_document_uri(params))
+        analyze_and_send_offenses(text_document_uri(params)) if @diagnostics_tracker.first_run?
       end
 
       def on_text_document_did_save(_id, params)

data/lib/theme_check/language_server.rb

@@ -8,6 +8,7 @@ require_relative "language_server/variable_lookup_finder"
 require_relative "language_server/completion_helper"
 require_relative "language_server/completion_provider"
 require_relative "language_server/completion_engine"
+require_relative "language_server/document_link_provider"
 require_relative "language_server/document_link_engine"
 require_relative "language_server/diagnostics_tracker"
 
@@ -15,6 +16,10 @@ Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file
 end
 
+Dir[__dir__ + "/language_server/document_link_providers/*.rb"].each do |file|
+  require file
+end
+
 module ThemeCheck
   module LanguageServer
     def self.start

data/lib/theme_check/theme.rb

@@ -7,7 +7,8 @@ module ThemeCheck
     LIQUID_REGEX = /\.liquid$/i
     JSON_REGEX = /\.json$/i
 
-    attr_accessor :storage
+    attr_reader :storage
+    attr_writer :default_locale_json
 
     def initialize(storage)
       @storage = storage

data/lib/theme_check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
@@ -194,6 +194,11 @@ 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