theme-check 1.0.0 → 1.4.0

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

@@ -0,0 +1,52 @@
+# Prevent Large CSS bundles (`AssetSizeAppBlockCSS`)
+
+This rule exists to prevent large CSS bundles from being included via Theme App Extensions (for speed).
+
+## Check Details
+
+This rule disallows the use of too much CSS in themes, as configured by `threshold_in_bytes`.
+
+:-1: Examples of **incorrect** code for this check:
+```liquid
+<!-- Here, assets/app.css is **greater** than `threshold_in_bytes` compressed. -->
+{% schema %}
+{
+  ...
+  "stylesheet": "app.css"
+}
+{% endschema %}
+```
+
+## Check Options
+
+The default configuration is the following:
+
+```yaml
+AssetSizeAppBlockCSS:
+  enabled: true
+  threshold_in_bytes: 100_000
+```
+
+### `threshold_in_bytes`
+
+The `threshold_in_bytes` option (default: `100_000`) determines the maximum allowed compressed size in bytes that a single CSS file can take.
+
+This includes theme and remote stylesheets.
+
+## When Not To Use It
+
+This rule should not be disabled locally since the check will be enforced when
+promoting new versions of the extension.
+
+## Version
+
+This check has been introduced in 1.1.0
+
+## Resources
+
+- [The Performance Inequality Gap](https://infrequently.org/2021/03/the-performance-inequality-gap/)
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/asset_size_app_block_css.rb
+[docsource]: /docs/checks/asset_size_app_block_css.md

data/docs/checks/asset_size_app_block_javascript.md

@@ -0,0 +1,57 @@
+# Prevent Abuse on Server Rendered App Blocks (`AssetSizeAppBlockJavaScript`)
+
+For server rendered app blocks, it is an anti-pattern to execute large JavaScript bundles on every page load
+
+This doesn't mean they don't have a reason to exist. For instance, chat widgets are mini applications embedded inside web pages. Designing such an app with server rendered updates would be absurd. However, if only 10% of the users interact with the chat widget, the other 90% should not have to execute the entire bundle on every page load.
+
+The natural solution to this problem is to implement the chat widget using the [Import on Interaction Pattern][ioip].
+
+## Check Details
+
+This rule disallows the use of block JavaScript files and external scripts to have a compressed size greater than a configured `threshold_in_bytes`.
+
+:-1: Examples of **incorrect** code for this check:
+```liquid
+<!-- Here assets/chat-widget.js is more than 10KB gzipped. -->
+{% schema %}
+{
+  ...
+  "javascript": "chat-widget.js"
+}
+{% endschema %}
+```
+
+## Check Options
+
+The default configuration is the following:
+
+```yaml
+AssetSizeAppBlockJavaScript:
+  enabled: true
+  threshold_in_bytes: 10000
+```
+
+### `threshold_in_bytes`
+
+The `threshold_in_bytes` option (default: `10000`) determines the maximum allowed compressed size in bytes that a single JavaScript file can take.
+
+This includes theme and remote scripts.
+
+## When Not To Use It
+
+This rule should not be disabled locally since the check will be enforced when
+promoting new versions of the extension.
+
+## Version
+
+This check has been introduced in 1.1.0
+
+## Resources
+
+- [The Import On Interaction Pattern][ioip]
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[ioip]: https://addyosmani.com/blog/import-on-interaction/
+[codesource]: /lib/theme_check/checks/asset_size_app_block_javascript.rb
+[docsource]: /docs/checks/asset_size_app_block_javascript.md

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

@@ -34,9 +34,11 @@ module ThemeCheck
 
       liquid_visitor = Visitor.new(@liquid_checks, @disabled_checks)
       html_visitor = HtmlVisitor.new(@html_checks)
-      @theme.liquid.each do |template|
-        liquid_visitor.visit_template(template)
-        html_visitor.visit_template(template)
+      ThemeCheck.with_liquid_c_disabled do
+        @theme.liquid.each do |template|
+          liquid_visitor.visit_template(template)
+          html_visitor.visit_template(template)
+        end
       end
 
       @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
@@ -47,24 +49,26 @@ module ThemeCheck
     def analyze_files(files)
       reset
 
-      # Call all checks that run on the whole theme
-      liquid_visitor = Visitor.new(@liquid_checks.whole_theme, @disabled_checks)
-      html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
-      @theme.liquid.each do |template|
-        liquid_visitor.visit_template(template)
-        html_visitor.visit_template(template)
-      end
-      @theme.json.each { |json_file| @json_checks.whole_theme.call(:on_file, json_file) }
-
-      # Call checks that run on a single files, only on specified file
-      liquid_visitor = Visitor.new(@liquid_checks.single_file, @disabled_checks)
-      html_visitor = HtmlVisitor.new(@html_checks.single_file)
-      files.each do |file|
-        if file.liquid?
-          liquid_visitor.visit_template(file)
-          html_visitor.visit_template(file)
-        elsif file.json?
-          @json_checks.single_file.call(:on_file, file)
+      ThemeCheck.with_liquid_c_disabled do
+        # Call all checks that run on the whole theme
+        liquid_visitor = Visitor.new(@liquid_checks.whole_theme, @disabled_checks)
+        html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
+        @theme.liquid.each do |template|
+          liquid_visitor.visit_template(template)
+          html_visitor.visit_template(template)
+        end
+        @theme.json.each { |json_file| @json_checks.whole_theme.call(:on_file, json_file) }
+
+        # Call checks that run on a single files, only on specified file
+        liquid_visitor = Visitor.new(@liquid_checks.single_file, @disabled_checks)
+        html_visitor = HtmlVisitor.new(@html_checks.single_file)
+        files.each do |file|
+          if file.liquid?
+            liquid_visitor.visit_template(file)
+            html_visitor.visit_template(file)
+          elsif file.json?
+            @json_checks.single_file.call(:on_file, file)
+          end
         end
       end
 
@@ -83,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/asset_file.rb

@@ -1,27 +1,15 @@
 # frozen_string_literal: true
-require "pathname"
 require "zlib"
 
 module ThemeCheck
-  class AssetFile
+  class AssetFile < ThemeFile
     def initialize(relative_path, storage)
-      @relative_path = relative_path
-      @storage = storage
+      super
       @loaded = false
       @content = nil
     end
 
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def content
-      @content ||= @storage.read(@relative_path)
-    end
+    alias_method :content, :source
 
     def gzipped_size
       @gzipped_size ||= Zlib.gzip(content).bytesize

data/lib/theme_check/bug.rb

@@ -2,6 +2,8 @@
 require 'theme_check/version'
 
 module ThemeCheck
+  class ThemeCheckError < StandardError; end
+
   BUG_POSTAMBLE = <<~EOS
     Theme Check Version: #{VERSION}
     Ruby Version: #{RUBY_VERSION}
@@ -15,6 +17,6 @@ module ThemeCheck
   EOS
 
   def self.bug(message)
-    abort(message + BUG_POSTAMBLE)
+    raise ThemeCheckError, message + BUG_POSTAMBLE
   end
 end

data/lib/theme_check/check.rb

@@ -9,12 +9,19 @@ module ThemeCheck
     attr_accessor :options, :ignored_patterns
     attr_writer :offenses
 
+    # The order matters.
     SEVERITIES = [
       :error,
       :suggestion,
       :style,
     ]
 
+    # [severity: sym] => number
+    SEVERITY_VALUES = SEVERITIES
+      .map
+      .with_index { |sev, i| [sev, i] }
+      .to_h
+
     CATEGORIES = [
       :liquid,
       :translation,
@@ -38,6 +45,10 @@ module ThemeCheck
         @severity if defined?(@severity)
       end
 
+      def severity_value(severity)
+        SEVERITY_VALUES[severity]
+      end
+
       def categories(*categories)
         @categories ||= []
         if categories.any?
@@ -58,7 +69,7 @@ module ThemeCheck
       end
 
       def docs_url(path)
-        "https://github.com/Shopify/theme-check/blob/master/docs/checks/#{File.basename(path, '.rb')}.md"
+        "https://github.com/Shopify/theme-check/blob/main/docs/checks/#{File.basename(path, '.rb')}.md"
       end
 
       def can_disable(disableable = nil)
@@ -80,12 +91,23 @@ 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
-      self.class.severity
+      @severity ||= self.class.severity
+    end
+
+    def severity=(severity)
+      unless SEVERITIES.include?(severity)
+        raise ArgumentError, "unknown severity. Use: #{SEVERITIES.join(', ')}"
+      end
+      @severity = severity
+    end
+
+    def severity_value
+      SEVERITY_VALUES[severity]
     end
 
     def categories