theme-check 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b918e53777cfb70c65dacd9d9bfbdb6f4463597c8f9c81969e1baef89df7a1
-  data.tar.gz: 7e45af9a3dfeab1eafdff5533df68a9e0d67007d94661a2c974c0c2fece61095
+  metadata.gz: adc4aaf3260408a9b52d9afaa59662308f173a5d5dcd0f3663cbcc68da1d7f39
+  data.tar.gz: 50cd7e0d42fda99ad3816a846c25868c38b92ea521e0be759c515548dd82f70b
 SHA512:
-  metadata.gz: ea1b75ca11a66aefe5eef421f577d53716cb180799863185d36fad21a9033b5cf52579df3e593e41867513da410adc7d16de723f35b3a5435e50098b7af2a348
-  data.tar.gz: ceab091f6bf7317d899cb5459601b7dfb5294e6e4be962a421b33bad33c74fd730001dea90687f81f754d57e5cdedc5b39d0efb5d95d6c016ed965f7e4e86a9f
+  metadata.gz: 7ffad3310e441edd678143de233584a09167ffff1e09b96109cef417d360d797821dc9ef3491af4564608cd3b35aa59be41ebea6bb76030e1544d53bc9db8d02
+  data.tar.gz: 30b6d8f3b58b95c833a78bc30ceea6cfcfa35d563e3d184b6aee51817965be87b352c2dbad5ff67a74f2a64479fe1945c11db738c1bfb6e64f610ae15b862cb3

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+v1.1.0 / 2021-07-06
+==================
+
+  * Add `--fail-level` CLI flag to configure exit code
+  * Refactor all theme file classes to inherit from `ThemeFile`
+  * Fix `undefined method liquid?` error when scanning from LSP
+  * Adding asset document links
+  * Allow initializing theme app extension configuration files
+  * Allow disabling registering mock Liquid tags w/ `ThemeCheck::Tags.register_tags = false`
+  * Support Theme App Extensions
+  * Add checks for theme app extension block JS/CSS
+  * Disable Liquid::C when parsing Liquid templates
+
 v1.0.0 / 2021-06-28
 ==================
 

data/README.md

@@ -100,6 +100,8 @@ TemplateLength:
   # Or ignore certain paths
   ignore:
     - snippets/icon-*
+  # Or change the severity (error|suggestion|style)
+  severity: suggestion
 
 # Enable a custom check
 MyCustomCheck
@@ -141,3 +143,40 @@ Disable checks for the _entire document_ by placing the comment on the first lin
 
 {%assign x = 1%}
 ```
+
+## Exit Code and `--fail-level`
+
+Use the `--fail-level` (default: `error`) flag to configure the exit code of theme-check. Useful in CI scenarios.
+
+Example:
+
+```
+# Make CI fail on styles warnings, suggestions, and errors
+theme-check --fail-level style path_to_theme
+
+# Make CI fail on suggestions, and errors
+theme-check --fail-level suggestion path_to_theme
+
+# Make CI fail on errors
+theme-check path_to_theme
+```
+
+There are three fail levels:
+
+- `error`
+- `suggestion`
+- `style`
+
+Exit code meanings:
+
+- 0: Success!
+- 1: Your code doesn't pass the checks
+- 2: There's a bug in theme-check
+
+If you would like to change the severity of a check, you can do so with the `severity` attribute. Example:
+
+```yaml
+DeprecateLazysizes:
+  enabled: true
+  severity: error
+```

data/config/default.yml

@@ -1,7 +1,13 @@
 root: .
 
+extends: :nothing
+
 require: []
 
+include_categories: []
+
+exclude_categories: []
+
 ignore:
   - node_modules/*
 
@@ -161,3 +167,13 @@ ImgLazyLoading:
 HtmlParsingError:
   enabled: true
   ignore: []
+
+AssetSizeAppBlockJavaScript:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeAppBlockCSS:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 100_000

data/config/nothing.yml

@@ -0,0 +1,11 @@
+root: .
+
+require: []
+
+include_categories: []
+
+exclude_categories: []
+
+ignore:
+  - node_modules/*
+

data/config/theme_app_extension.yml

@@ -0,0 +1,153 @@
+root: .
+
+extends: :nothing
+
+require: []
+
+include_categories: []
+
+exclude_categories: []
+
+ignore:
+  - node_modules/*
+
+ConvertIncludeToRender:
+  enabled: true
+  ignore: []
+
+LiquidTag:
+  enabled: true
+  ignore: []
+  min_consecutive_statements: 4
+
+MissingTemplate:
+  enabled: true
+  ignore: []
+
+NestedSnippet:
+  enabled: true
+  ignore: []
+  max_nesting_level: 3
+
+RequiredLayoutThemeObject:
+  enabled: true
+  ignore: []
+
+SpaceInsideBraces:
+  enabled: true
+  ignore: []
+
+SyntaxError:
+  enabled: true
+  ignore: []
+
+TemplateLength:
+  enabled: true
+  ignore: []
+  max_length: 200
+  # Exclude content of {% schema %} in line count
+  exclude_schema: true
+
+UnknownFilter:
+  enabled: true
+  ignore: []
+
+UnusedAssign:
+  enabled: true
+  ignore: []
+
+UnusedSnippet:
+  enabled: true
+  ignore: []
+
+MatchingSchemaTranslations:
+  enabled: true
+  ignore: []
+
+MatchingTranslations:
+  enabled: true
+  ignore: []
+
+TranslationKeyExists:
+  enabled: true
+  ignore: []
+
+ValidHTMLTranslation:
+  enabled: true
+  ignore: []
+
+ValidJson:
+  enabled: true
+  ignore: []
+
+ValidSchema:
+  enabled: true
+  ignore: []
+
+UndefinedObject:
+  enabled: true
+  ignore: []
+  exclude_snippets: true
+
+RequiredDirectories:
+  enabled: false
+  ignore: []
+
+DeprecatedFilter:
+  enabled: true
+  ignore: []
+
+MissingEnableComment:
+  enabled: true
+  ignore: []
+
+ParserBlockingJavaScript:
+  enabled: true
+  ignore: []
+
+ParserBlockingScriptTag:
+  enabled: true
+
+AssetSizeJavaScript:
+  enabled: true
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeCSS:
+  enabled: true
+  ignore: []
+  threshold_in_bytes: 100_000
+
+ImgWidthAndHeight:
+  enabled: true
+  ignore: []
+
+RemoteAsset:
+  enabled: true
+  ignore: []
+
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []
+
+ImgLazyLoading:
+  enabled: true
+  ignore: []
+
+HtmlParsingError:
+  enabled: true
+  ignore: []
+
+AssetSizeAppBlockJavaScript:
+  enabled: true
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeAppBlockCSS:
+  enabled: true
+  ignore: []
+  threshold_in_bytes: 100_000

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: false
+  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/lib/theme_check.rb

@@ -4,6 +4,7 @@ require "liquid"
 require_relative "theme_check/version"
 require_relative "theme_check/bug"
 require_relative "theme_check/exceptions"
+require_relative "theme_check/theme_file"
 require_relative "theme_check/analyzer"
 require_relative "theme_check/check"
 require_relative "theme_check/checks_tracking"
@@ -45,3 +46,17 @@ Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }
 # UTF-8 is the default internal and external encoding, like in Rails & Shopify.
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
+
+module ThemeCheck
+  def self.with_liquid_c_disabled
+    if defined?(Liquid::C)
+      was_enabled = Liquid::C.enabled
+      Liquid::C.enabled = false if was_enabled
+    end
+    yield
+  ensure
+    if defined?(Liquid::C) && was_enabled
+      Liquid::C.enabled = true
+    end
+  end
+end

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
 

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?
@@ -85,7 +96,18 @@ module ThemeCheck
     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

data/lib/theme_check/checks/asset_size_app_block_css.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much CSS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockCSS < LiquidCheck
+    severity :error
+    category :performance
+    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
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 100_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (stylesheet = schema["stylesheet"])
+        size = asset_size(stylesheet)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "CSS in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_app_block_javascript.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much JS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockJavaScript < LiquidCheck
+    severity :error
+    category :performance
+    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
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 10_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (javascript = schema["javascript"])
+        size = asset_size(javascript)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "JavaScript in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/cli.rb

@@ -10,10 +10,11 @@ module ThemeCheck
     def initialize
       @path = "."
       @command = :check
-      @only_categories = []
+      @include_categories = []
       @exclude_categories = []
       @auto_correct = false
       @config_path = nil
+      @fail_level = :error
     end
 
     def option_parser(parser = OptionParser.new, help: true)
@@ -25,20 +26,27 @@ module ThemeCheck
       @option_parser.separator("Basic Options:")
       @option_parser.on(
         "-C", "--config PATH",
-        "Use the config provided, overriding .theme-check.yml if present"
+        "Use the config provided, overriding .theme-check.yml if present",
+        "Use :theme_app_extension to use default checks for theme app extensions"
       ) { |path| @config_path = path }
       @option_parser.on(
-        "-c", "--category CATEGORY",
-        "Only run this category of checks"
-      ) { |category| @only_categories << category.to_sym }
+        "-c", "--category CATEGORY", Check::CATEGORIES, "Only run this category of checks",
+        "Runs checks matching all categories when specified more than once"
+      ) { |category| @include_categories << category.to_sym }
       @option_parser.on(
-        "-x", "--exclude-category CATEGORY",
-        "Exclude this category of checks"
+        "-x", "--exclude-category CATEGORY", Check::CATEGORIES, "Exclude this category of checks",
+        "Excludes checks matching any category when specified more than once"
       ) { |category| @exclude_categories << category.to_sym }
       @option_parser.on(
         "-a", "--auto-correct",
         "Automatically fix offenses"
       ) { @auto_correct = true }
+      @option_parser.on(
+        "--fail-level SEVERITY", Check::SEVERITIES,
+        "Minimum severity (error|suggestion|style) for exit with error code"
+      ) do |severity|
+        @fail_level = severity.to_sym
+      end
 
       @option_parser.separator("")
       @option_parser.separator("Miscellaneous:")
@@ -77,6 +85,8 @@ module ThemeCheck
 
     def parse(argv)
       @path = option_parser.parse(argv).first || "."
+    rescue OptionParser::InvalidArgument => e
+      abort(e.message)
     end
 
     def run!
@@ -84,13 +94,13 @@ module ThemeCheck
         @config = if @config_path
           ThemeCheck::Config.new(
             root: @path,
-            configuration: ThemeCheck::Config.load_file(@config_path)
+            configuration: ThemeCheck::Config.load_config(@config_path)
           )
         else
           ThemeCheck::Config.from_path(@path)
         end
-        @config.only_categories = @only_categories
-        @config.exclude_categories = @exclude_categories
+        @config.include_categories = @include_categories unless @include_categories.empty?
+        @config.exclude_categories = @exclude_categories unless @exclude_categories.empty?
         @config.auto_correct = @auto_correct
       end
 
@@ -99,12 +109,16 @@ module ThemeCheck
 
     def run
       run!
+      exit(0)
     rescue Abort => e
       if e.message.empty?
         exit(1)
       else
         abort(e.message)
       end
+    rescue ThemeCheckError => e
+      STDERR.puts(e.message)
+      exit(2)
     end
 
     def self.parse_and_run!(argv)
@@ -130,11 +144,16 @@ module ThemeCheck
     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))
+        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)))
 
         puts "Writing new #{ThemeCheck::Config::DOTFILE} to #{@path}"
       else
-        raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}."
+        raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}"
       end
     end
 
@@ -157,7 +176,9 @@ module ThemeCheck
       analyzer.analyze_theme
       analyzer.correct_offenses
       ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
-      raise Abort, "" if analyzer.uncorrectable_offenses.any?
+      raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
+        offense.check.severity_value <= Check.severity_value(@fail_level)
+      end
     end
   end
 end

data/lib/theme_check/config.rb

@@ -3,11 +3,11 @@
 module ThemeCheck
   class Config
     DOTFILE = '.theme-check.yml'
-    DEFAULT_CONFIG = "#{__dir__}/../../config/default.yml"
+    BUNDLED_CONFIGS_DIR = "#{__dir__}/../../config"
     BOOLEAN = [true, false]
 
     attr_reader :root
-    attr_accessor :only_categories, :exclude_categories, :auto_correct
+    attr_accessor :auto_correct
 
     class << self
       attr_reader :last_loaded_config
@@ -42,18 +42,46 @@ module ThemeCheck
         YAML.load_file(absolute_path)
       end
 
+      def bundled_config_path(name)
+        "#{BUNDLED_CONFIGS_DIR}/#{name}"
+      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)
+        end
+      end
+
       def default
-        @default ||= load_file(DEFAULT_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
         {}
       end
-      merge_with_default_configuration!(@configuration)
+
+      # 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
 
       @root = if root && @configuration.key?("root")
         Pathname.new(root).join(@configuration["root"])
@@ -61,8 +89,6 @@ module ThemeCheck
         Pathname.new(root)
       end
 
-      @only_categories = []
-      @exclude_categories = []
       @auto_correct = false
 
       resolve_requires if @root && should_resolve_requires
@@ -87,16 +113,18 @@ module ThemeCheck
         check_class = ThemeCheck.const_get(check_name)
 
         next if check_class.categories.any? { |category| exclude_categories.include?(category) }
-        next if only_categories.any? && check_class.categories.none? { |category| only_categories.include?(category) }
+        next if include_categories.any? && !include_categories.all? { |category| check_class.categories.include?(category) }
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
+        severity = options_for_check.delete(:severity)
         ignored_patterns = options_for_check.delete(:ignore) || []
         check = if options_for_check.empty?
           check_class.new
         else
           check_class.new(**options_for_check)
         end
+        check.severity = severity.to_sym if severity
         check.ignored_patterns = ignored_patterns
         check.options = options_for_check
         check
@@ -107,6 +135,22 @@ module ThemeCheck
       self["ignore"] || []
     end
 
+    def include_categories
+      self["include_categories"] || []
+    end
+
+    def include_categories=(categories)
+      @configuration["include_categories"] = categories
+    end
+
+    def exclude_categories
+      self["exclude_categories"] || []
+    end
+
+    def exclude_categories=(categories)
+      @configuration["exclude_categories"] = categories
+    end
+
     private
 
     def check_name?(name)
@@ -133,6 +177,8 @@ module ThemeCheck
           else
             warn("bad configuration type for #{name}: expected a Hash, got #{value.inspect}")
           end
+        elsif key == "severity"
+          valid_configuration[key] = value
         elsif default.nil?
           warn("unknown configuration: #{name}")
         elsif BOOLEAN.include?(default) && !BOOLEAN.include?(value)
@@ -147,13 +193,13 @@ module ThemeCheck
       valid_configuration
     end
 
-    def merge_with_default_configuration!(configuration, default_configuration = self.class.default)
-      default_configuration.each do |key, default|
+    def merge_configurations!(configuration, extended_configuration)
+      extended_configuration.each do |key, default|
         value = configuration[key]
 
         case value
         when Hash
-          merge_with_default_configuration!(value, default)
+          merge_configurations!(value, default)
         when nil
           configuration[key] = default
         end

data/lib/theme_check/exceptions.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 require "net/http"
 
-TIMEOUT_EXCEPTIONS = [
-  Net::ReadTimeout,
-  Net::OpenTimeout,
-  Net::WriteTimeout,
-  Errno::ETIMEDOUT,
-  Timeout::Error,
-]
+module ThemeCheck
+  TIMEOUT_EXCEPTIONS = [
+    Net::ReadTimeout,
+    Net::OpenTimeout,
+    Net::WriteTimeout,
+    Errno::ETIMEDOUT,
+    Timeout::Error,
+  ]
 
-CONNECTION_EXCEPTIONS = [
-  IOError,
-  EOFError,
-  SocketError,
-  Errno::EINVAL,
-  Errno::ECONNRESET,
-  Errno::ECONNABORTED,
-  Errno::EPIPE,
-  Errno::ECONNREFUSED,
-  Errno::EAGAIN,
-  Errno::EHOSTUNREACH,
-  Errno::ENETUNREACH,
-]
+  CONNECTION_EXCEPTIONS = [
+    IOError,
+    EOFError,
+    SocketError,
+    Errno::EINVAL,
+    Errno::ECONNRESET,
+    Errno::ECONNABORTED,
+    Errno::EPIPE,
+    Errno::ECONNREFUSED,
+    Errno::EAGAIN,
+    Errno::EHOSTUNREACH,
+    Errno::ENETUNREACH,
+  ]
 
-NET_HTTP_EXCEPTIONS = [
-  Net::HTTPBadResponse,
-  Net::HTTPHeaderSyntaxError,
-  Net::ProtocolError,
-  *TIMEOUT_EXCEPTIONS,
-  *CONNECTION_EXCEPTIONS,
-]
+  NET_HTTP_EXCEPTIONS = [
+    Net::HTTPBadResponse,
+    Net::HTTPHeaderSyntaxError,
+    Net::ProtocolError,
+    *TIMEOUT_EXCEPTIONS,
+    *CONNECTION_EXCEPTIONS,
+  ]
+end

data/lib/theme_check/json_file.rb

@@ -1,29 +1,15 @@
 # frozen_string_literal: true
 require "json"
-require "pathname"
 
 module ThemeCheck
-  class JsonFile
+  class JsonFile < ThemeFile
     def initialize(relative_path, storage)
-      @relative_path = relative_path
-      @storage = storage
+      super
       @loaded = false
       @content = nil
       @parser_error = nil
     end
 
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def source
-      @source ||= @storage.read(@relative_path)
-    end
-
     def content
       load!
       @content
@@ -34,23 +20,10 @@ module ThemeCheck
       @parser_error
     end
 
-    def name
-      relative_path.sub_ext('').to_s
-    end
-
     def json?
       true
     end
 
-    def liquid?
-      false
-    end
-
-    def ==(other)
-      other.is_a?(JsonFile) && relative_path == other.relative_path
-    end
-    alias_method :eql?, :==
-
     private
 
     def load!

data/lib/theme_check/language_server/constants.rb

@@ -10,5 +10,13 @@ module ThemeCheck
       ^\s*render\s+'(?<partial>[^']*)'|
       ^\s*render\s+"(?<partial>[^"]*)"
     }mix
+    ASSET_INCLUDE = %r{
+      \{\%-?\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
+    }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -13,7 +13,7 @@ module ThemeCheck
       def document_links(relative_path)
         buffer = @storage.read(relative_path)
         return [] unless buffer
-        matches(buffer, PARTIAL_RENDER).map do |match|
+        snippet_matches = matches(buffer, PARTIAL_RENDER).map do |match|
           start_line, start_character = from_index_to_row_column(
             buffer,
             match.begin(:partial),
@@ -25,7 +25,7 @@ module ThemeCheck
           )
 
           {
-            target: link(match[:partial]),
+            target: snippet_link(match[:partial]),
             range: {
               start: {
                 line: start_line,
@@ -38,10 +38,46 @@ module ThemeCheck
             },
           }
         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 link(partial)
-        "file://#{@storage.path('snippets/' + partial + '.liquid')}"
+      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/tags.rb

@@ -169,14 +169,31 @@ module ThemeCheck
 
     class Stylesheet < Liquid::Raw; end
 
-    Liquid::Template.register_tag('form', Form)
-    Liquid::Template.register_tag('layout', Layout)
-    Liquid::Template.register_tag('render', Render)
-    Liquid::Template.register_tag('paginate', Paginate)
-    Liquid::Template.register_tag('section', Section)
-    Liquid::Template.register_tag('style', Style)
-    Liquid::Template.register_tag('schema', Schema)
-    Liquid::Template.register_tag('javascript', Javascript)
-    Liquid::Template.register_tag('stylesheet', Stylesheet)
+    class << self
+      attr_writer :register_tags
+
+      def register_tags?
+        @register_tags
+      end
+
+      def register_tag(name, klass)
+        Liquid::Template.register_tag(name, klass)
+      end
+
+      def register_tags!
+        return if !register_tags? || (defined?(@registered_tags) && @registered_tags)
+        @registered_tags = true
+        register_tag('form', Form)
+        register_tag('layout', Layout)
+        register_tag('render', Render)
+        register_tag('paginate', Paginate)
+        register_tag('section', Section)
+        register_tag('style', Style)
+        register_tag('schema', Schema)
+        register_tag('javascript', Javascript)
+        register_tag('stylesheet', Stylesheet)
+      end
+    end
+    self.register_tags = true
   end
 end

data/lib/theme_check/template.rb

@@ -1,25 +1,7 @@
 # frozen_string_literal: true
-require "pathname"
 
 module ThemeCheck
-  class Template
-    def initialize(relative_path, storage)
-      @storage = storage
-      @relative_path = relative_path
-    end
-
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def source
-      @source ||= @storage.read(@relative_path)
-    end
-
+  class Template < ThemeFile
     def write
       content = updated_content
       if source != content
@@ -28,14 +10,6 @@ module ThemeCheck
       end
     end
 
-    def name
-      relative_path.sub_ext('').to_s
-    end
-
-    def json?
-      false
-    end
-
     def liquid?
       true
     end
@@ -88,16 +62,13 @@ module ThemeCheck
       parse.root
     end
 
-    def ==(other)
-      other.is_a?(Template) && relative_path == other.relative_path
-    end
-    alias_method :eql?, :==
-
     def self.parse(source)
+      Tags.register_tags!
       Liquid::Template.parse(
         source,
         line_numbers: true,
         error_mode: :warn,
+        disable_liquid_c_nodes: true,
       )
     end
   end

data/lib/theme_check/theme_file.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require "pathname"
+
+module ThemeCheck
+  class ThemeFile
+    def initialize(relative_path, storage)
+      @relative_path = relative_path
+      @storage = storage
+    end
+
+    def path
+      @storage.path(@relative_path)
+    end
+
+    def relative_path
+      @relative_pathname ||= Pathname.new(@relative_path)
+    end
+
+    def name
+      relative_path.sub_ext('').to_s
+    end
+
+    def source
+      @source ||= @storage.read(@relative_path)
+    end
+
+    def json?
+      false
+    end
+
+    def liquid?
+      false
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && relative_path == other.relative_path
+    end
+    alias_method :eql?, :==
+  end
+end

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -62,6 +62,8 @@ files:
 - Rakefile
 - bin/liquid-server
 - config/default.yml
+- config/nothing.yml
+- config/theme_app_extension.yml
 - data/shopify_liquid/deprecated_filters.yml
 - data/shopify_liquid/filters.yml
 - data/shopify_liquid/objects.yml
@@ -74,6 +76,8 @@ files:
 - docs/api/json_check.md
 - docs/api/liquid_check.md
 - docs/checks/TEMPLATE.md.erb
+- docs/checks/asset_size_app_block_css.md
+- docs/checks/asset_size_app_block_javascript.md
 - docs/checks/asset_size_css.md
 - docs/checks/asset_size_css_stylesheet_tag.md
 - docs/checks/asset_size_javascript.md
@@ -120,6 +124,8 @@ files:
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/TEMPLATE.rb.erb
+- lib/theme_check/checks/asset_size_app_block_css.rb
+- lib/theme_check/checks/asset_size_app_block_javascript.rb
 - lib/theme_check/checks/asset_size_css.rb
 - lib/theme_check/checks/asset_size_css_stylesheet_tag.rb
 - lib/theme_check/checks/asset_size_javascript.rb
@@ -209,6 +215,7 @@ files:
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb
 - lib/theme_check/theme.rb
+- lib/theme_check/theme_file.rb
 - lib/theme_check/version.rb
 - lib/theme_check/visitor.rb
 - packaging/homebrew/theme_check.base.rb