theme-check 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28cb25e47867151bea85360a9f07667f46ea30ad90285f16cc74e85370ad39d9
-  data.tar.gz: 2023811dad002a72f00e2c26562ff3e6b5f2f49c748d44968fd94d1f9e72300f
+  metadata.gz: 8bec2f54c12487d444bebd3bb0abad48ec133c4e9504be29857a58c87d82f589
+  data.tar.gz: 2cacd6af05aa3c2af8d40167a04532ed998d24049df7b277f70baf50f0a4e401
 SHA512:
-  metadata.gz: f3a5339873aea7a325cbc3f3715e9166b1f7734226e3d9ac7b400f048629a514f3eec5d559c77eaf70febacda35416b8332d8d1a6ebefa1d9a34f29474a4e41d
-  data.tar.gz: 19eec11d1eb86188fe170bce61f884072340d848e800b2bb2b344cddf3561d60594e4f066199b7f9157b54da81ce8afebc5e6db0f3dbfbc5fac208c95d2b5ed8
+  metadata.gz: 95a61ee91b1a575dead56345172c5472cdb1c314b94aef37814f311ab54d39263a70d51192ea5d276188d06e8ddc32715f9693f7089157e3376bd7c885b1d30a
+  data.tar.gz: 6fe39a2b8944ceb34e48b5a4a84cbb1f544d870b9c38f36dff33ff2e226f76feabb612d9f9e98ce31c2c68209014b46d76adcd0a4dd37224aee3c2ee266e50d0

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+v1.3.0 / 2021-08-26
+==================
+
+  * Add `--output json` option for the CLI ([#392](https://github.com/shopify/theme-check/issues/392))
+  * Add PaginationSize check ([#359](https://github.com/shopify/theme-check/issues/359))
+  * Add ConvertIncludeToRender auto corrector ([#341](https://github.com/shopify/theme-check/issues/341))
+  * Add MissingTemplate auto corrector ([#388](https://github.com/shopify/theme-check/issues/388))
+  * Add `MissingTemplate` `ignore_missing` option ([#394](https://github.com/shopify/theme-check/issues/394))
+  * Fix Windows duplicate .bat file problem ([#400](https://github.com/shopify/theme-check/issues/400))
+  * Fix substring highlighting inside nodes ([#386](https://github.com/shopify/theme-check/issues/386))
+  * Add check for forbidden tags in theme app extension blocks ([#383](https://github.com/shopify/theme-check/issues/383))
+  * Improve HTML parsing of liquid attributes ([#381](https://github.com/shopify/theme-check/issues/381))
+  * Handle escaped file URIs in language server ([#360](https://github.com/shopify/theme-check/issues/360)) ([#382](https://github.com/shopify/theme-check/issues/382))
+  * Change asset size errors into suggestions ([#378](https://github.com/shopify/theme-check/issues/378))
+  * Switch to nokogiri 1.12, since it includes html5 support directly now ([#391](https://github.com/shopify/theme-check/issues/391))
+
 v1.2.0 / 2021-07-15
 ==================
 

data/CONTRIBUTING.md

@@ -31,7 +31,7 @@ bundle exec rake
 ## Checking a theme
 
 ```
-bundle exec theme-check /path/to/your/theme
+bin/theme-check /path/to/your/theme
 ```
 
 ## Creating a new "Check"

data/bin/theme-check

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'theme-check' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("theme-check", "theme-check")

data/bin/theme-check-language-server

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'theme-check-language-server' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("theme-check", "theme-check-language-server")

data/config/default.yml

@@ -23,6 +23,7 @@ LiquidTag:
 MissingTemplate:
   enabled: true
   ignore: []
+  ignore_missing: []
 
 NestedSnippet:
   enabled: true
@@ -177,3 +178,13 @@ AssetSizeAppBlockCSS:
   enabled: false
   ignore: []
   threshold_in_bytes: 100_000
+
+AppBlockValidTags:
+  enabled: false
+  ignore: []
+
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50

data/config/theme_app_extension.yml

@@ -23,6 +23,7 @@ LiquidTag:
 MissingTemplate:
   enabled: true
   ignore: []
+  ignore_missing: []
 
 NestedSnippet:
   enabled: true
@@ -110,11 +111,13 @@ ParserBlockingScriptTag:
 
 AssetSizeJavaScript:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 10_000
 
 AssetSizeCSS:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 100_000
 
@@ -144,10 +147,22 @@ HtmlParsingError:
 
 AssetSizeAppBlockJavaScript:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 10_000
 
 AssetSizeAppBlockCSS:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 100_000
+
+AppBlockValidTags:
+  enabled: true
+  ignore: []
+
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50

data/docs/checks/app_block_valid_tags.md

@@ -0,0 +1,40 @@
+# Reject Forbidden Tags from Theme App Extension Blocks (`AppBlockValidTags`)
+
+This rule exists to prevent theme app extension blocks from containing forbidden tags in their liquid code.
+
+## Check Details
+
+This rule verifies none of the below tags are used in theme app extension blocks.
+
+- `{% javascript %}`
+- `{% stylesheet %}`
+- `{% include 'foo' %}`
+- `{% layout 'foo' %}`
+- `{% section 'foo' %}`
+
+:-1: **Incorrect** code for this check occurs with the use of any of the above tags in the liquid code of theme app extension blocks.
+
+## Check Options
+
+The default configuration for theme app extensions is the following:
+
+```yaml
+AppBlockValidTags:
+  enabled: true
+```
+
+## When Not To Use It
+
+This rule should not be disabled locally.
+
+## Version
+
+This check has been introduced in 1.3.0
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/app_block_valid_tags.rb
+[docsource]: /docs/checks/app_block_valid_tags.md

data/docs/checks/asset_size_app_block_css.md

@@ -23,7 +23,7 @@ The default configuration is the following:
 
 ```yaml
 AssetSizeAppBlockCSS:
-  enabled: false
+  enabled: true
   threshold_in_bytes: 100_000
 ```
 

data/docs/checks/missing_template.md

@@ -25,8 +25,33 @@ The default configuration for this check is the following:
 ```yaml
 MissingTemplate:
   enabled: true
+  ignore_missing: []
 ```
 
+### `ignore_missing`
+
+Specify a list of patterns of missing template files to ignore.
+
+While the `ignore` option will ignore all occurrences of `MissingTemplate` according to the file in which they appear, `ignore_missing` allows ignoring all occurrences of `MissingTemplate` based on the target template, the template being rendered.
+
+For example:
+
+```yaml
+MissingTemplate:
+  ignore_missing:
+  - snippets/icon-*
+```
+
+Would ignore offenses on `{% render 'icon-missing' %}` across all theme files.
+
+```yaml
+MissingTemplate:
+  ignore:
+  - templates/index.liquid
+```
+
+Would ignore all `MissingTemplate` in `templates/index.liquid`, no mater the file being rendered.
+
 ## Version
 
 This check has been introduced in Theme Check 0.1.0.

data/docs/checks/pagination_size.md

@@ -0,0 +1,44 @@
+# Ensure `paginate` tags are used with performant sizes
+
+## Check Details
+
+This check is aimed at keeping response times low.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- Using too large of page size -->
+{% paginate collection.products by 999 %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% paginate collection.products by 12 %}
+```
+
+Use sizes that are integers below the `max_size`, and above the `min_size`.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50
+```
+
+## When Not To Use It
+
+N/A
+
+## Version
+
+This check has been introduced in Theme Check 1.3.0.
+
+## Resources
+
+[paginate]: https://shopify.dev/api/liquid/objects/paginate

data/docs/checks/undefined_object.md

@@ -33,8 +33,13 @@ The default configuration for this check is the following:
 ```yaml
 UndefinedObject:
   enabled: true
+  exclude_snippets: true
 ```
 
+### `exclude_snippets`
+
+The `exclude_snippets` (Default: `true`) option determines whether to check for undefined objects in snippets file (as objects _may_ be defined as arguments)
+
 ## When Not To Use It
 
 It is discouraged to disable this rule.

data/lib/theme_check/check.rb

@@ -91,8 +91,8 @@ module ThemeCheck
       @offenses ||= []
     end
 
-    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, &block)
-      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, correction: block)
+    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, node_markup_offset: 0, &block)
+      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, node_markup_offset: node_markup_offset, correction: block)
     end
 
     def severity

data/lib/theme_check/checks/app_block_valid_tags.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when invalid tags are used in a Theme App
+  # Extension block
+  class AppBlockValidTags < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    OFFENSE_MSG = "Theme app extension blocks cannot contain %s tags"
+
+    def on_javascript(node)
+      add_offense(OFFENSE_MSG % 'javascript', node: node)
+    end
+
+    def on_stylesheet(node)
+      add_offense(OFFENSE_MSG % 'stylesheet', node: node)
+    end
+
+    def on_include(node)
+      add_offense(OFFENSE_MSG % 'include', node: node)
+    end
+
+    def on_layout(node)
+      add_offense(OFFENSE_MSG % 'layout', node: node)
+    end
+
+    def on_section(node)
+      add_offense(OFFENSE_MSG % 'section', node: node)
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_css.rb

@@ -13,12 +13,12 @@ module ThemeCheck
     end
 
     def on_link(node)
-      return if node.attributes['rel']&.value != "stylesheet"
-      file_size = href_to_file_size(node.attributes['href']&.value)
+      return if node.attributes['rel'] != "stylesheet"
+      file_size = href_to_file_size(node.attributes['href'])
       return if file_size.nil?
       return if file_size <= threshold_in_bytes
       add_offense(
-        "CSS on every page load exceeding compressed size threshold (#{threshold_in_bytes} Bytes).",
+        "CSS on every page load exceeding compressed size threshold (#{threshold_in_bytes} Bytes)",
         node: node
       )
     end

data/lib/theme_check/checks/asset_size_javascript.rb

@@ -16,7 +16,7 @@ module ThemeCheck
     end
 
     def on_script(node)
-      file_size = src_to_file_size(node.attributes['src']&.value)
+      file_size = src_to_file_size(node.attributes['src'])
       return if file_size.nil?
       return if file_size <= threshold_in_bytes
       add_offense(
@@ -28,7 +28,7 @@ module ThemeCheck
     def src_to_file_size(src)
       # We're kind of intentionally only looking at {{ 'asset' | asset_url }} or full urls in here.
       # More complicated liquid statements are not in scope.
-      if src =~ /^#{VARIABLE}$/o && src =~ /asset_url/ && src =~ Liquid::QuotedString
+      if src =~ /^#{LIQUID_VARIABLE}$/o && src =~ /asset_url/ && src =~ Liquid::QuotedString
         asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
         asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
         return if asset.nil?

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -7,7 +7,9 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_include(node)
-      add_offense("`include` is deprecated - convert it to `render`", node: node)
+      add_offense("`include` is deprecated - convert it to `render`", node: node) do |corrector|
+        corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
+      end
     end
   end
 end

data/lib/theme_check/checks/deprecate_bgsizes.rb

@@ -6,7 +6,7 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_div(node)
-      class_list = node.attributes["class"]&.value&.split(" ")
+      class_list = node.attributes["class"]&.split(" ")
       add_offense("Use the native loading=\"lazy\" attribute instead of lazysizes", node: node) if class_list&.include?("lazyload")
       add_offense("Use the CSS imageset attribute instead of data-bgset", node: node) if node.attributes["data-bgset"]
     end

data/lib/theme_check/checks/deprecate_lazysizes.rb

@@ -6,11 +6,11 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_img(node)
-      class_list = node.attributes["class"]&.value&.split(" ")
+      class_list = node.attributes["class"]&.split(" ")
       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"]&.value == "auto"
+      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/img_lazy_loading.rb

@@ -8,7 +8,7 @@ module ThemeCheck
     ACCEPTED_LOADING_VALUES = %w[lazy eager]
 
     def on_img(node)
-      loading = node.attributes["loading"]&.value&.downcase
+      loading = node.attributes["loading"]&.downcase
       return if ACCEPTED_LOADING_VALUES.include?(loading)
       if loading == "auto"
         add_offense("Prefer loading=\"lazy\" to defer loading of images", node: node)