theme-check 1.9.1 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39a4bbf1f8a394045deecb8e3b4ccf5cb94f0cfac1e36de7761670a2bb817f7a
-  data.tar.gz: 66cd6e3ae2087b468019a8257e0dd8eded88ff2f2732fa2b1902328ef837ce10
+  metadata.gz: 131d90a928b4130827c6e41ea99ccd852e650417e88baceb66910ff083cf3aaa
+  data.tar.gz: a754d8b221da85eea053ce6f7547c9cad5a3a1e5f7a41562d61922a1278abe5d
 SHA512:
-  metadata.gz: 59144f60da497b0c067218c7408e217fc9af86dbc7b150d7c4aedd06fd07a16442a270e21f0dfba048cb3a85de423efcaea4db67eecc0b7ebc14a3293bcf23e2
-  data.tar.gz: f27e64b460ef9d30ef11b01a4638bb32184a5b1ade3f7279043e2bb6de1749c2778d25d4e056012f6a90f4628acd05d2e35d81c697cb01c3898de081022766e4
+  metadata.gz: 8e2bc230eee811d2d0d8b62a09d11b3b88f2e54939f0c1aeda843d3f8d8455e34d0379aa89a9f388401d4ebb593a00abdfbb57357717fb9167bf7a73fb89943d
+  data.tar.gz: f901b9cd064ee47fa39a6b661524e2d4eafc52b6cda54aceabd4ff371c1d562cfb43967c666642b1ef4d1c1b72cb793ab3cf202bfaee2a5f80aedb1840335155

data/CHANGELOG.md

@@ -1,4 +1,37 @@
 
+v1.10.1 / 2022-02-24
+====================
+
+  * Revert "Prevent bad render tags from passing theme-check ([#551](https://github.com/shopify/theme-check/issues/551))"
+
+v1.10.0 / 2022-02-24
+====================
+
+## Features
+
+  * Performance Improvements ([#556](https://github.com/shopify/theme-check/issues/556))
+    - Boasts ~125x faster `checkOnChange` checks.
+
+  * New language server configuration: `"themeCheck.onlySingleFileChecks"` ([#556](https://github.com/shopify/theme-check/issues/556))
+    - When `true`, disables whole theme checks in the editor and makes it so only the open files are checked.
+    - When `false` (default), behaves as before.
+
+## Fixes
+
+  * Do not complain about variables passed to the default filter ([#532](https://github.com/shopify/theme-check/issues/532))
+  * `extend:` should accept absolute and relative paths ([#555](https://github.com/shopify/theme-check/issues/555))
+  * Gracefully handle initialized without config. ([#552](https://github.com/shopify/theme-check/issues/552))
+  * Add missing metafield filters ([#550](https://github.com/shopify/theme-check/issues/550))
+  * Handle media.sources edge case in RemoteAsset ([#549](https://github.com/shopify/theme-check/issues/549))
+  * Disable HTML checks inside Liquid comments ([#548](https://github.com/shopify/theme-check/issues/548))
+  * Prevent bad render tags from passing theme-check ([#551](https://github.com/shopify/theme-check/issues/551))
+  * Handle rogue carriage returns ([#547](https://github.com/shopify/theme-check/issues/547))
+
+v1.9.2 / 2021-12-13
+===================
+
+  * Improve HTML parsing errors
+
 v1.9.1 / 2021-12-09
 ===================
 
@@ -9,7 +42,7 @@ v1.9.0 / 2021-12-01
 
 ## Features
 
-  * Add Corrections as Code Actions in Language Server (quickfix + source.fixAll) (#471)
+  * Add Corrections as Code Actions in Language Server (quickfix + source.fixAll) ([#471](https://github.com/shopify/theme-check/issues/471))
   * Add SchemaJsonFormat check ([#512](https://github.com/shopify/theme-check/issues/512))
   * Add checkOn{Open,Change,Save} Language Server Configurations ([#511](https://github.com/shopify/theme-check/issues/511))
   * Add support for new filters `image_tag` + `image_url`

data/README.md

@@ -186,6 +186,7 @@ DeprecateLazysizes:
 - `themeCheck.checkOnOpen` (default: `true`) makes it so theme check runs on file open.
 - `themeCheck.checkOnChange` (default: `true`) makes it so theme check runs on file change.
 - `themeCheck.checkOnSave` (default: `true`) makes it so theme check runs on file save.
+- `themeCheck.onlySingleFileChecks` (default: `false`) makes it so we only check the opened files and disable "whole theme" checks (e.g. UnusedSnippet, TranslationKeyExists)
 
 ⚠️ **Note:** Quickfixes only work on a freshly checked file. If any of those configurations are turned off, you will need to rerun theme-check in order to apply quickfixes.
 

data/RELEASING.md

@@ -73,11 +73,11 @@
 
 1. Release `theme-check` on RubyGems by following the steps in the previous section.
 
-2. Update the `theme-check` version in [`shopify-cli`](https://github.com/shopify/shopify-cli)'s `Gemfile.lock` and `shopify-cli.gemspec` files.
+2. Update the `theme-check` version in [`shopify-cli`](https://github.com/shopify/shopify-cli)'s `shopify-cli.gemspec` file.
 
-   Such as in [this PR.](https://github.com/Shopify/shopify-cli/pull/1357/files)
+3. Run `bundle update theme-check` and get an updated `Gemfile.lock`
 
-3. Create a branch + a commit on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
+4. Create a branch + a commit on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
 
    ```bash
    VERSION=X.X.X
@@ -87,7 +87,7 @@
    git commit -m "Bump theme-check version to $VERSION"
    ```
 
-4. Create a pull-request for those changes on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
+5. Create a pull-request for those changes on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
 
    ```bash
    # shortcut if you have `hub` installed

data/data/shopify_liquid/filters.yml

@@ -1,80 +1,91 @@
 ---
 Liquid::StandardFilters:
-- url_encode
-- where
+- times
+- h
 - uniq
+- compact
+- url_encode
 - escape
+- escape_once
+- url_decode
+- base64_encode
+- base64_decode
+- base64_url_safe_encode
+- base64_url_safe_decode
+- truncatewords
+- strip_html
+- strip_newlines
 - replace
 - remove
-- h
+- sort_natural
+- replace_first
+- remove_first
+- newline_to_br
 - upcase
 - downcase
 - capitalize
-- date
+- divided_by
+- minus
+- at_most
+- at_least
+- size
 - last
 - split
-- size
 - append
 - reverse
-- join
 - concat
 - prepend
-- escape_once
-- url_decode
-- truncatewords
-- strip_html
+- join
 - strip
 - lstrip
 - rstrip
-- strip_newlines
-- plus
-- sort_natural
-- compact
-- replace_first
-- remove_first
-- newline_to_br
-- minus
-- divided_by
-- at_least
-- at_most
 - sort
+- where
+- map
 - default
-- modulo
+- first
 - slice
+- modulo
 - abs
-- map
-- floor
+- date
 - ceil
 - round
 - truncate
-- first
-- times
+- plus
+- floor
 FormFilter:
-- payment_button
 - payment_terms
 - installments_pricing
 - default_errors
+- payment_button
 DateFilter:
 - date
 I18nFilter:
 - translate
+- time_tag
+- sentence
 - t
 - date
-- sentence
-- time_tag
+- app_block_path_for
+- dev_shop?
+- app_extension_path_for
+- global_block_type?
+- app_block_path?
+- app_extension_path?
+- app_snippet_path?
+- registration_uuid_from
+- handle_from
 UrlFilter:
 - stylesheet_tag
 - script_tag
 - img_tag
-- image_tag
-- image_url
+- link_to
 - shopify_asset_url
 - payment_type_img_url
 - payment_type_svg_tag
 - placeholder_svg_tag
-- link_to
-- asset_url
 - img_url
+- asset_url
 - asset_img_url
 - global_asset_url
 - file_url
@@ -82,10 +93,12 @@ UrlFilter:
 - product_img_url
 - collection_img_url
 - article_img_url
+- image_url
 - preload_tag
 JsonFilter:
 - json
 ColorFilter:
+- color_mix
 - color_contrast
 - color_difference
 - brightness_difference
@@ -100,40 +113,39 @@ ColorFilter:
 - color_darken
 - color_saturate
 - color_desaturate
-- color_mix
 MoneyFilter:
-- money_without_currency
-- money_without_trailing_zeros
 - money
 - money_with_currency
+- money_without_currency
+- money_without_trailing_zeros
 StringFilter:
+- md5
+- camelcase
+- format_code
+- handle
+- camelize
 - handleize
 - url_param_escape
 - url_escape
-- camelcase
-- camelize
 - encode_url_component
-- format_code
-- md5
-- handle
 CollectionFilter:
+- sort_by
 - within
 - link_to_vendor
-- url_for_vendor
 - link_to_type
 - url_for_type
-- sort_by
+- url_for_vendor
 TagFilter:
-- link_to_add_tag
-- link_to_remove_tag
 - link_to_tag
 - highlight_active_tag
+- link_to_add_tag
+- link_to_remove_tag
 CryptoFilter:
 - hmac_sha1
-- sha256
 - hmac_sha256
 - md5
 - sha1
+- sha256
 CustomerAccountFilter:
 - customer_login_link
 - customer_logout_link
@@ -147,16 +159,16 @@ CurrencyFormFilter:
 PaginationFilter:
 - default_pagination
 WeightFilter:
+- unit
 - weight
 - weight_with_unit
-- unit
 TextFilter:
-- pad_spaces
-- paragraphize
+- pluralize
 - highlight
 - format_address
+- paragraphize
 - excerpt
-- pluralize
+- pad_spaces
 FontFilter:
 - font_face
 - font_url
@@ -164,13 +176,18 @@ FontFilter:
 DistanceFilter:
 - distance_from
 MediaFilter:
-- external_video_url
 - external_video_tag
 - video_tag
 - model_viewer_tag
 - media_tag
+- image_tag
+- external_video_url
 ThemeFilter:
 - theme_url
 - link_to_theme
+- _online_store_editor_live_setting
+MetafieldFilter:
+- metafield_tag
+- metafield_text
 DebugFilter:
 - debug

data/lib/theme_check/analyzer.rb

@@ -63,30 +63,36 @@ module ThemeCheck
       finish
     end
 
-    def analyze_files(files)
+    def analyze_files(files, only_single_file: false)
       reset
 
       ThemeCheck.with_liquid_c_disabled do
-        # Call all checks that run on the whole theme
-        liquid_visitor = LiquidVisitor.new(@liquid_checks.whole_theme, @disabled_checks)
-        html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
-        total = total_file_count + files.size
-        @theme.liquid.each_with_index do |liquid_file, i|
-          yield(liquid_file.relative_path.to_s, i, total) if block_given?
-          liquid_visitor.visit_liquid_file(liquid_file)
-          html_visitor.visit_liquid_file(liquid_file)
-        end
+        total = files.size
+        offset = 0
+
+        unless only_single_file
+          # Call all checks that run on the whole theme
+          liquid_visitor = LiquidVisitor.new(@liquid_checks.whole_theme, @disabled_checks)
+          html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
+          total += total_file_count
+          offset = total_file_count
+          @theme.liquid.each_with_index do |liquid_file, i|
+            yield(liquid_file.relative_path.to_s, i, total) if block_given?
+            liquid_visitor.visit_liquid_file(liquid_file)
+            html_visitor.visit_liquid_file(liquid_file)
+          end
 
-        @theme.json.each_with_index do |json_file, i|
-          yield(json_file.relative_path.to_s, liquid_file_count + i, total) if block_given?
-          @json_checks.whole_theme.call(:on_file, json_file)
+          @theme.json.each_with_index do |json_file, i|
+            yield(json_file.relative_path.to_s, liquid_file_count + i, total) if block_given?
+            @json_checks.whole_theme.call(:on_file, json_file)
+          end
         end
 
         # Call checks that run on a single files, only on specified file
         liquid_visitor = LiquidVisitor.new(@liquid_checks.single_file, @disabled_checks)
         html_visitor = HtmlVisitor.new(@html_checks.single_file)
         files.each_with_index do |theme_file, i|
-          yield(theme_file.relative_path.to_s, total_file_count + i, total) if block_given?
+          yield(theme_file.relative_path.to_s, offset + i, total) if block_given?
           if theme_file.liquid?
             liquid_visitor.visit_liquid_file(theme_file)
             html_visitor.visit_liquid_file(theme_file)
@@ -96,7 +102,7 @@ module ThemeCheck
         end
       end
 
-      finish
+      finish(only_single_file)
     end
 
     def uncorrectable_offenses
@@ -138,10 +144,16 @@ module ThemeCheck
       end
     end
 
-    def finish
-      @liquid_checks.call(:on_end)
-      @html_checks.call(:on_end)
-      @json_checks.call(:on_end)
+    def finish(only_single_file = false)
+      if only_single_file
+        @liquid_checks.single_file.call(:on_end)
+        @html_checks.single_file.call(:on_end)
+        @json_checks.single_file.call(:on_end)
+      else
+        @liquid_checks.call(:on_end)
+        @html_checks.call(:on_end)
+        @json_checks.call(:on_end)
+      end
 
       @disabled_checks.remove_disabled_offenses(@liquid_checks)
       @disabled_checks.remove_disabled_offenses(@json_checks)

data/lib/theme_check/checks/asset_size_css_stylesheet_tag.rb

@@ -11,7 +11,7 @@ module ThemeCheck
     end
 
     def on_variable(node)
-      used_filters = node.value.filters.map { |name, *_rest| name }
+      used_filters = node.filters.map { |name, *_rest| name }
       return unless used_filters.include?("stylesheet_tag")
       file_size = stylesheet_tag_pipeline_to_file_size(node.markup)
       return if file_size.nil?

data/lib/theme_check/checks/asset_url_filters.rb

@@ -36,12 +36,12 @@ module ThemeCheck
     end
 
     def html_resource_drop?(variable_node)
-      variable_node.value.filters
+      variable_node.filters
         .any? { |(filter_name, *_filter_args)| HTML_FILTERS.include?(filter_name) }
     end
 
     def variable_hosted_by_shopify?(variable_node)
-      variable_node.value.filters
+      variable_node.filters
         .any? { |(filter_name, *_filter_args)| ASSET_URL_FILTERS.include?(filter_name) }
     end
   end

data/lib/theme_check/checks/content_for_header_modification.rb

@@ -14,7 +14,7 @@ module ThemeCheck
       return unless node.value.name.is_a?(Liquid::VariableLookup)
       return unless node.value.name.name == "content_for_header"
 
-      if @in_assign || @in_capture || node.value.filters.any?
+      if @in_assign || @in_capture || node.filters.any?
         add_offense(
           "Do not rely on the content of `content_for_header`",
           node: node,

data/lib/theme_check/checks/deprecated_filter.rb

@@ -10,7 +10,7 @@ module ThemeCheck
     MAX_SIZE = 5760
 
     def on_variable(node)
-      used_filters = node.value.filters.map { |name, *_rest| name }
+      used_filters = node.filters.map { |name, *_rest| name }
       used_filters.each do |filter|
         alternatives = ShopifyLiquid::DeprecatedFilter.alternatives(filter)
         next unless alternatives
@@ -33,7 +33,7 @@ module ThemeCheck
     end
 
     def add_img_url_offense(node)
-      img_url_filter = node.value.filters.find { |filter| filter[0] == "img_url" }
+      img_url_filter = node.filters.find { |filter| filter[0] == "img_url" }
       _name, img_url_filter_size, img_url_filter_props = img_url_filter
       size_spec = img_url_filter_size&.dig(0)
       scale = img_url_filter_props&.delete("scale")

data/lib/theme_check/checks/parser_blocking_script_tag.rb

@@ -7,7 +7,7 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_variable(node)
-      used_filters = node.value.filters.map { |name, *_rest| name }
+      used_filters = node.filters.map { |name, *_rest| name }
       if used_filters.include?("script_tag")
         add_offense(
           "The script_tag filter is parser-blocking. Use a script tag with the async or defer " \

data/lib/theme_check/checks/remote_asset.rb

@@ -22,7 +22,6 @@ module ThemeCheck
       return if resource_url =~ ABSOLUTE_PATH
       return if resource_url =~ RELATIVE_PATH
       return if url_hosted_by_shopify?(resource_url)
-      return if url_is_setting_variable?(resource_url)
 
       # Ignore non-stylesheet link tags
       rel = node.attributes["rel"]
@@ -37,12 +36,36 @@ module ThemeCheck
     private
 
     def url_hosted_by_shopify?(url)
-      url.start_with?(Liquid::VariableStart) &&
-        AssetUrlFilters::ASSET_URL_FILTERS.any? { |filter| url.include?(filter) }
+      asset_url?(url) || looks_like_hosted_by_shopify?(url) || url_is_setting_variable?(url)
+    end
+
+    # There are some cases where it's kind of hard to tell if it's
+    # hosted by Shopify or not.
+    #
+    # e.g. {{ image }} is hosted on primary domain (not CDN)
+    #
+    # e.g. media.sources are on the CDN
+    # {% for source in media.sources %}
+    #   {{ source.url }}
+    # {% endfor %}
+    #
+    # So I'll go 80/20 here and assume that people name their variable
+    # source in `for source in media.sources`.
+    def looks_like_hosted_by_shopify?(url)
+      liquid_variable?(url) && url =~ /source\.url/
     end
 
     def url_is_setting_variable?(url)
-      url.start_with?(Liquid::VariableStart) && url =~ /settings\./
+      liquid_variable?(url) && url =~ /settings\./
+    end
+
+    def asset_url?(url)
+      liquid_variable?(url) &&
+        AssetUrlFilters::ASSET_URL_FILTERS.any? { |filter| url.include?(filter) }
+    end
+
+    def liquid_variable?(url)
+      url.start_with?(Liquid::VariableStart)
     end
   end
 end

data/lib/theme_check/checks/translation_key_exists.rb

@@ -16,7 +16,7 @@ module ThemeCheck
 
     def on_variable(node)
       return unless @theme.default_locale_json&.content&.is_a?(Hash)
-      return unless node.value.filters.any? { |name, _| name == "t" || name == "translate" }
+      return unless node.filters.any? { |name, _| name == "t" || name == "translate" }
 
       @nodes[node.theme_file.name] << node
     end

data/lib/theme_check/checks/undefined_object.rb

@@ -167,6 +167,8 @@ module ThemeCheck
         node = node.parent
         node = node.parent if %i(condition variable_lookup).include?(node.type_name)
 
+        next if node.variable? && node.filters.any? { |(filter_name)| filter_name == "default" }
+
         if render_node
           add_offense("Missing argument `#{name}`", node: render_node)
         else

data/lib/theme_check/checks/unknown_filter.rb

@@ -15,7 +15,7 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_variable(node)
-      used_filters = node.value.filters.map { |name, *_rest| name }
+      used_filters = node.filters.map { |name, *_rest| name }
       undefined_filters = used_filters - ShopifyLiquid::Filter.labels
 
       undefined_filters.each do |undefined_filter|

data/lib/theme_check/checks.rb

@@ -42,8 +42,7 @@ module ThemeCheck
           check.send(method, *args)
         end
       end
-    rescue Liquid::Error
-      # Pass-through Liquid errors
+    rescue Liquid::Error, ThemeCheckError
       raise
     rescue => e
       node = args.first

data/lib/theme_check/cli.rb

@@ -160,12 +160,11 @@ module ThemeCheck
     def init
       dotfile_path = ThemeCheck::Config.find(@path)
       if dotfile_path.nil?
-        config_name = if @config_path && @config_path[0] == ":"
-          "#{@config_path[1..]}.yml"
-        else
-          "default.yml"
-        end
-        File.write(File.join(@path, ThemeCheck::Config::DOTFILE), File.read(ThemeCheck::Config.bundled_config_path(config_name)))
+        config_name = @config_path || "default"
+        File.write(
+          File.join(@path, ThemeCheck::Config::DOTFILE),
+          File.read(ThemeCheck::Config.bundled_config_path(config_name))
+        )
 
         puts "Writing new #{ThemeCheck::Config::DOTFILE} to #{@path}"
       else

data/lib/theme_check/config.rb

@@ -3,7 +3,7 @@
 module ThemeCheck
   class Config
     DOTFILE = '.theme-check.yml'
-    BUNDLED_CONFIGS_DIR = "#{__dir__}/../../config"
+    BUNDLED_CONFIGS_DIR = Pathname.new("#{__dir__}/../../config").realpath
     BOOLEAN = [true, false]
 
     attr_reader :root
@@ -14,7 +14,7 @@ module ThemeCheck
 
       def from_path(path)
         if (filename = find(path))
-          new(root: filename.dirname, configuration: load_file(filename))
+          new(root: filename.dirname, configuration: load_config(filename))
         else
           # No configuration file
           new(root: path)
@@ -39,49 +39,57 @@ module ThemeCheck
 
       def load_file(absolute_path)
         @last_loaded_config = absolute_path
-        YAML.load_file(absolute_path)
+        # An empty file returns false, so we || {}.
+        YAML.load_file(absolute_path) || {}
       end
 
       def bundled_config_path(name)
-        "#{BUNDLED_CONFIGS_DIR}/#{name}"
+        "#{BUNDLED_CONFIGS_DIR}/#{name.to_s.sub(/^:/, '')}.yml"
+      end
+
+      def bundled_config?(name)
+        name.is_a?(Symbol) || (name.is_a?(String) && name[0] == ":")
       end
 
       def load_bundled_config(name)
         load_file(bundled_config_path(name))
       end
 
-      def load_config(path)
-        if path[0] == ":"
-          load_bundled_config("#{path[1..]}.yml")
-        elsif path.is_a?(Symbol)
-          load_bundled_config("#{path}.yml")
-        else
-          load_file(path)
+      def load_config(name, pwd = Pathname.pwd)
+        return load_bundled_config(name) if bundled_config?(name)
+        path = name.is_a?(Pathname) ? name : Pathname.new(name)
+        path = pwd.join(path) if path.relative?
+        return {} unless path.exist?
+        config = load_file(path)
+        extends = config["extends"] || :default
+        merge_configurations!(load_config(extends, path.realpath.dirname), config)
+      end
+
+      def merge_configurations!(config, other)
+        config.merge(other) do |_key, old_value, new_value|
+          case old_value
+          when Hash
+            merge_configurations!(old_value, new_value)
+          else
+            new_value
+          end
         end
       end
 
       def default
-        @default ||= load_config(":default")
+        load_config(":default")
       end
     end
 
     def initialize(root: nil, configuration: nil, should_resolve_requires: true)
       @configuration = if configuration
-        # TODO: Do we need to handle extends here? What base configuration
-        # should we validate against once Theme App Extensions has its own
-        # checks? :all?
         validate_configuration(configuration)
       else
-        {}
+        self.class.default
       end
 
-      # Follow extends
-      extends = @configuration["extends"] || ":default"
-      while extends
-        extended_configuration = self.class.load_config(extends)
-        extends = extended_configuration["extends"]
-        @configuration = merge_configurations!(@configuration, extended_configuration)
-      end
+      extends = @configuration["extends"] || :default
+      @configuration = self.class.merge_configurations!(self.class.load_config(extends), @configuration)
 
       @root = if root && @configuration.key?("root")
         Pathname.new(root).join(@configuration["root"])
@@ -177,6 +185,12 @@ module ThemeCheck
           else
             warn("bad configuration type for #{name}: expected a Hash, got #{value.inspect}")
           end
+        elsif key == "extends"
+          if value.is_a?(Symbol) || value.is_a?(String)
+            valid_configuration[key] = value
+          else
+            warn("bad configuration type for extends: expected a Symbol or a String, got #{value.inspect}")
+          end
         elsif key == "severity"
           valid_configuration[key] = value
         elsif default.nil?
@@ -193,20 +207,6 @@ module ThemeCheck
       valid_configuration
     end
 
-    def merge_configurations!(configuration, extended_configuration)
-      extended_configuration.each do |key, default|
-        value = configuration[key]
-
-        case value
-        when Hash
-          merge_configurations!(value, default)
-        when nil
-          configuration[key] = default
-        end
-      end
-      configuration
-    end
-
     def resolve_requires
       self["require"]&.each do |path|
         require(File.join(@root, path))

data/lib/theme_check/disabled_checks.rb

@@ -30,6 +30,12 @@ module ThemeCheck
           next unless disabled
           disabled.end_index = node.end_index
         end
+      else
+        # We want to disable checks inside comments
+        # (e.g. html checks inside {% comment %})
+        disabled = @disabled_checks[[node.theme_file, :all]]
+        disabled.start_index = node.inner_markup_start_index
+        disabled.end_index = node.inner_markup_end_index
       end
     end
 

data/lib/theme_check/html_node.rb

@@ -140,9 +140,39 @@ module ThemeCheck
     end
 
     def parseable_markup
+      return @parseable_source if @value.name == "#document-fragment"
+      return @value.to_str if @value.comment?
+      return @value.content if literal?
+
       start_index = from_row_column_to_index(@parseable_source, line_number - 1, 0)
       @parseable_source
-        .match(/<\s*#{@value.name}[^>]*>/im, start_index)[0]
+        .match(/<\s*#{name}[^>]*>/im, start_index)[0]
+    rescue NoMethodError
+      # Don't know what's up with the following issue. Don't think
+      # null check is correct approach. This should give us more info.
+      # https://github.com/Shopify/theme-check/issues/528
+      ThemeCheck.bug(<<~MSG)
+        Can't find a parseable tag of name #{name} inside the parseable HTML.
+
+        Tag name:
+          #{@value.name.inspect}
+
+        File:
+          #{@theme_file.relative_path}
+
+        Line number:
+          #{line_number}
+
+        Excerpt:
+          ```
+          #{@theme_file.source.lines[line_number - 1...line_number + 5].join("")}
+          ```
+
+        Parseable Excerpt:
+          ```
+          #{@parseable_source.lines[line_number - 1...line_number + 5].join("")}
+          ```
+      MSG
     end
 
     def content

data/lib/theme_check/language_server/configuration.rb

@@ -6,6 +6,7 @@ module ThemeCheck
       CHECK_ON_OPEN = :"themeCheck.checkOnOpen"
       CHECK_ON_SAVE = :"themeCheck.checkOnSave"
       CHECK_ON_CHANGE = :"themeCheck.checkOnChange"
+      ONLY_SINGLE_FILE = :"themeCheck.onlySingleFileChecks"
 
       def initialize(bridge, capabilities)
         @bridge = bridge
@@ -13,9 +14,10 @@ module ThemeCheck
         @mutex = Mutex.new
         @initialized = false
         @config = {
-          CHECK_ON_OPEN => @capabilities.initialization_option(CHECK_ON_OPEN) || true,
-          CHECK_ON_SAVE => @capabilities.initialization_option(CHECK_ON_SAVE) || true,
-          CHECK_ON_CHANGE => @capabilities.initialization_option(CHECK_ON_CHANGE) || true,
+          CHECK_ON_OPEN => null_coalesce(@capabilities.initialization_option(CHECK_ON_OPEN), true),
+          CHECK_ON_SAVE => null_coalesce(@capabilities.initialization_option(CHECK_ON_SAVE), true),
+          CHECK_ON_CHANGE => null_coalesce(@capabilities.initialization_option(CHECK_ON_CHANGE), true),
+          ONLY_SINGLE_FILE => null_coalesce(@capabilities.initialization_option(ONLY_SINGLE_FILE), false),
         }
       end
 
@@ -23,17 +25,25 @@ module ThemeCheck
         @mutex.synchronize do
           return unless @capabilities.supports_workspace_configuration?
           return if initialized? && !force
-          check_on_open, check_on_save, check_on_change = @bridge.send_request(
+
+          keys = [
+            CHECK_ON_OPEN,
+            CHECK_ON_SAVE,
+            CHECK_ON_CHANGE,
+            ONLY_SINGLE_FILE,
+          ]
+
+          configs = @bridge.send_request(
             "workspace/configuration",
-            items: [
-              { section: CHECK_ON_OPEN },
-              { section: CHECK_ON_SAVE },
-              { section: CHECK_ON_CHANGE },
-            ],
+            items: keys.map do |key|
+              { section: key }
+            end
           )
-          @config[CHECK_ON_OPEN] = check_on_open unless check_on_open.nil?
-          @config[CHECK_ON_CHANGE] = check_on_change unless check_on_change.nil?
-          @config[CHECK_ON_SAVE] = check_on_save unless check_on_save.nil?
+
+          keys.each.with_index do |key, i|
+            @config[key] = configs[i] unless configs[i].nil?
+          end
+
           @initialized = true
         end
       end
@@ -64,6 +74,15 @@ module ThemeCheck
         fetch # making sure we have for an initialized value
         @config[CHECK_ON_CHANGE]
       end
+
+      def only_single_file?
+        fetch # making sure we have for an initialized value
+        @config[ONLY_SINGLE_FILE]
+      end
+
+      def null_coalesce(value, default)
+        value.nil? ? default : value
+      end
     end
   end
 end

data/lib/theme_check/language_server/diagnostic.rb

@@ -43,6 +43,10 @@ module ThemeCheck
         offense.single_file?
       end
 
+      def whole_theme?
+        offense.whole_theme?
+      end
+
       def correctable?
         offense.correctable?
       end

data/lib/theme_check/language_server/diagnostics_engine.rb

@@ -19,14 +19,14 @@ module ThemeCheck
         @diagnostics_manager.first_run?
       end
 
-      def analyze_and_send_offenses(absolute_path, config, force: false)
+      def analyze_and_send_offenses(absolute_path, config, force: false, only_single_file: false)
         return unless @diagnostics_lock.try_lock
         @token += 1
         @bridge.send_create_work_done_progress_request(@token)
         theme = ThemeCheck::Theme.new(storage)
         analyzer = ThemeCheck::Analyzer.new(theme, config.enabled_checks)
 
-        if @diagnostics_manager.first_run? || force
+        if (!only_single_file && @diagnostics_manager.first_run?) || force
           @bridge.send_work_done_progress_begin(@token, "Full theme check")
           @bridge.log("Checking #{storage.root}")
           offenses = nil
@@ -37,6 +37,7 @@ module ThemeCheck
           end
           end_message = "Found #{offenses.size} offenses in #{format("%0.2f", time.real)}s"
           @bridge.send_work_done_progress_end(@token, end_message)
+          @bridge.log(end_message)
           send_diagnostics(offenses)
         else
           # Analyze selected files
@@ -47,14 +48,14 @@ module ThemeCheck
             @bridge.send_work_done_progress_begin(@token, "Partial theme check")
             offenses = nil
             time = Benchmark.measure do
-              offenses = analyzer.analyze_files([file]) do |path, i, total|
+              offenses = analyzer.analyze_files([file], only_single_file: only_single_file) do |path, i, total|
                 @bridge.send_work_done_progress_report(@token, "#{i}/#{total} #{path}", (i.to_f / total * 100.0).to_i)
               end
             end
             end_message = "Found #{offenses.size} new offenses in #{format("%0.2f", time.real)}s"
             @bridge.send_work_done_progress_end(@token, end_message)
             @bridge.log(end_message)
-            send_diagnostics(offenses, [relative_path])
+            send_diagnostics(offenses, [relative_path], only_single_file: only_single_file)
           end
         end
         @diagnostics_lock.unlock
@@ -62,8 +63,12 @@ module ThemeCheck
 
       private
 
-      def send_diagnostics(offenses, analyzed_files = nil)
-        @diagnostics_manager.build_diagnostics(offenses, analyzed_files: analyzed_files).each do |relative_path, diagnostics|
+      def send_diagnostics(offenses, analyzed_files = nil, only_single_file: false)
+        @diagnostics_manager.build_diagnostics(
+          offenses,
+          analyzed_files: analyzed_files,
+          only_single_file: only_single_file
+        ).each do |relative_path, diagnostics|
           send_diagnostic(relative_path, diagnostics)
         end
       end

data/lib/theme_check/language_server/diagnostics_manager.rb

@@ -27,7 +27,7 @@ module ThemeCheck
         @mutex.synchronize { @latest_diagnostics[relative_path] || [] }
       end
 
-      def build_diagnostics(offenses, analyzed_files: nil)
+      def build_diagnostics(offenses, analyzed_files: nil, only_single_file: false)
         @mutex.synchronize do
           full_check = analyzed_files.nil?
           analyzed_paths = analyzed_files.map { |path| Pathname.new(path) } unless full_check
@@ -46,10 +46,23 @@ module ThemeCheck
           current_paths = paths(current_diagnostics)
 
           diagnostics_update = (current_paths + previous_paths).map do |path|
+            # When doing single file checks, we keep the whole theme old
+            # ones and accept the new single ones
+            if only_single_file && analyzed_paths.include?(path)
+              single_file_diagnostics = current_diagnostics[path] || []
+              whole_theme_diagnostics = whole_theme_diagnostics(path) || []
+              [path, single_file_diagnostics + whole_theme_diagnostics]
+
+            # If doing single file checks that are not in the
+            # analyzed_paths array then we just keep the old
+            # diagnostics
+            elsif only_single_file
+              [path, previous_diagnostics(path) || []]
+
             # When doing a full_check, we either send the current
             # diagnostics or an empty array to clear the diagnostics
             # for that file.
-            if full_check
+            elsif full_check
               [path, current_diagnostics[path] || []]
 
             # When doing a partial check, the single file diagnostics
@@ -63,9 +76,14 @@ module ThemeCheck
             end
           end.to_h
 
-          @latest_diagnostics = diagnostics_update.reject { |_, v| v.empty? }
+          @latest_diagnostics = diagnostics_update
+            .reject { |_, v| v.empty? }
+
           @first_run = false
+
+          # Only send updates for the current file when running with only_single_file
           diagnostics_update
+            .reject { |p, _| only_single_file && !analyzed_paths.include?(p) }
         end
       end
 
@@ -131,6 +149,14 @@ module ThemeCheck
       def single_file_diagnostics(relative_path)
         @latest_diagnostics[relative_path]&.select(&:single_file?) || []
       end
+
+      def whole_theme_diagnostics(relative_path)
+        @latest_diagnostics[relative_path]&.select(&:whole_theme?) || []
+      end
+
+      def previous_diagnostics(relative_path)
+        @latest_diagnostics[relative_path]
+      end
     end
   end
 end

data/lib/theme_check/language_server/execute_command_providers/run_checks_execute_command_provider.rb

@@ -14,7 +14,12 @@ module ThemeCheck
       end
 
       def execute(_args)
-        @diagnostics_engine.analyze_and_send_offenses(@root_path, @root_config, force: true)
+        @diagnostics_engine.analyze_and_send_offenses(
+          @root_path,
+          @root_config,
+          only_single_file: false,
+          force: true
+        )
         nil
       end
     end

data/lib/theme_check/language_server/handler.rb

@@ -64,6 +64,7 @@ module ThemeCheck
       end
 
       def on_initialized(_id, _params)
+        return unless @configuration
         @configuration.fetch
         @configuration.register_did_change_capability
       end
@@ -85,7 +86,7 @@ module ThemeCheck
       def on_text_document_did_change(_id, params)
         relative_path = relative_path_from_text_document_uri(params)
         @storage.write(relative_path, content_changes_text(params), text_document_version(params))
-        analyze_and_send_offenses(text_document_uri(params)) if @configuration.check_on_change?
+        analyze_and_send_offenses(text_document_uri(params), only_single_file: true) if @configuration.check_on_change?
       end
 
       def on_text_document_did_close(_id, params)
@@ -189,10 +190,11 @@ module ThemeCheck
         ThemeCheck::Config.from_path(root)
       end
 
-      def analyze_and_send_offenses(absolute_path)
+      def analyze_and_send_offenses(absolute_path, only_single_file: nil)
         @diagnostics_engine.analyze_and_send_offenses(
           absolute_path,
-          config_for_path(absolute_path)
+          config_for_path(absolute_path),
+          only_single_file: only_single_file.nil? ? @configuration.only_single_file? : only_single_file
         )
       end
 

data/lib/theme_check/liquid_node.rb

@@ -184,6 +184,11 @@ module ThemeCheck
       @type_name ||= StringHelpers.underscore(StringHelpers.demodulize(@value.class.name)).to_sym
     end
 
+    def filters
+      raise TypeError, "Attempting to lookup filters of #{type_name}. Only variables have filters." unless variable?
+      @value.filters
+    end
+
     def source
       theme_file&.source
     end

data/lib/theme_check/position.rb

@@ -4,6 +4,8 @@ module ThemeCheck
   class Position
     include PositionHelper
 
+    attr_reader :contents
+
     def initialize(
       needle_arg,
       contents_arg,
@@ -12,7 +14,13 @@ module ThemeCheck
       node_markup_offset: 0 # the index of markup inside the node_markup
     )
       @needle = needle_arg
-      @contents = contents_arg
+
+      @contents = if contents_arg&.is_a?(String) && !contents_arg.empty?
+        contents_arg
+      else
+        ''
+      end
+
       @line_number_1_indexed = line_number_1_indexed
       @node_markup_offset = node_markup_offset
       @node_markup = node_markup
@@ -77,18 +85,13 @@ module ThemeCheck
       node_markup_start + @node_markup_offset
     end
 
-    def contents
-      return '' unless @contents.is_a?(String) && !@contents.empty?
-      @contents
-    end
-
     def line_number
       return 0 if @line_number_1_indexed.nil?
       bounded(0, @line_number_1_indexed - 1, content_line_count)
     end
 
     def needle
-      if has_content_and_line_number_but_no_needle?
+      @cached_needle ||= if has_content_and_line_number_but_no_needle?
         entire_line_needle
       elsif contents.empty? || @needle.nil?
         ''

data/lib/theme_check/position_helper.rb

@@ -3,6 +3,11 @@
 
 module ThemeCheck
   module PositionHelper
+    # Apparently this old implementation is 2x slower (with benchmark/ips),
+    # so dropping with the following one... It's ugly af but
+    # this shit runs 100K+ times in one theme-check so it gotta go
+    # fast!
+    #
     def from_row_column_to_index(content, row, col)
       return 0 unless content.is_a?(String) && !content.empty?
       return 0 unless row.is_a?(Integer) && col.is_a?(Integer)
@@ -15,6 +20,19 @@ module ThemeCheck
       bounded(result, result + col, scanner.pre_match.size)
     end
 
+    # def from_row_column_to_index(content, row, col)
+    #   return 0 unless content.is_a?(String) && !content.empty?
+    #   return 0 unless row.is_a?(Integer) && col.is_a?(Integer)
+    #   i = 0
+    #   safe_row = bounded(0, row, content.count("\n"))
+    #   charpos = -1
+    #   charpos = content.index("\n", charpos + 1) while i < safe_row && (i += 1) && charpos
+    #   result = charpos ? charpos + 1 : 0
+    #   next_line = content.index("\n", result)
+    #   upper_bound = next_line ? next_line : content.size - 1
+    #   bounded(result, result + col, upper_bound)
+    # end
+
     def from_index_to_row_column(content, index)
       return [0, 0] unless content.is_a?(String) && !content.empty?
       return [0, 0] unless index.is_a?(Integer)

data/lib/theme_check/theme_file.rb

@@ -45,7 +45,9 @@ module ThemeCheck
         @source = @storage.read(@relative_path)
       end
       @eol = @source.include?("\r\n") ? "\r\n" : "\n"
-      @source = @source.gsub("\r\n", "\n")
+      @source = @source
+        .gsub(/\r(?!\n)/, "\r\n") # fix rogue \r without followup \n with \r\n
+        .gsub("\r\n", "\n")
     end
 
     def json?

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.1
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid