theme-check 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b6a91e5ac4b1e2045b1e4fb2748e5ecb9600206f9ba07df401c1410bf494fc
-  data.tar.gz: b6fb1b3957ae5aecd7b2efbaa76a2e3c07390ec442f94d416ea5b20ca2cbf966
+  metadata.gz: dc5f5b1f71dce3de919836a4b8cd55e2ae3994e12c8118a69050840fac21b0e6
+  data.tar.gz: bc190dcdae4c5ec62b8d3e9a6d0a3d1c9ea6fc9b052e843455faf1ed1fc0d92d
 SHA512:
-  metadata.gz: e2ca68b31968949dc52240c8ee5ca607e10e063b500cda0a7b06306589849f2bc0098f1b0742f962a91a0ca282aa504acb9f7c0de6b785afff0b577b84fa6eba
-  data.tar.gz: c7186299a1168c5ad1e3cd6544ee8c8248b96a492e1dc82481c26a69e75fb1f04172ceb58da61e310a393fd36c9b990464542e7528810c7bea556b5b8ce9b61d
+  metadata.gz: 24724968d6b6f792e522289b3a62e200d5a2dc568286f8b5044a4b72253bfeb54aafae140dff38d2bfa9e5cb871d1f65c5c575661bb5b5132f73c36919e1b4f1
+  data.tar.gz: aaf053c7dbe25615daadaef936f58435e84180664b03b9f77edf7eee247581ef6b3ddadcf04816922e738db047693e1ca75a6e5bcfec139d42d2d3c0595fe49c

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+v0.10.2 / 2021-06-18
+==================
+
+  * Fix error when parsing a template with lots of HTML attributes.
+  * Add `HtmlParsingError` check for reporting errors during HTML parsing.
+
 v0.10.1 / 2021-06-11
 ==================
 

data/Rakefile

@@ -75,7 +75,7 @@ task :new_check, [:name] do |_t, args|
     code_source: code_source,
     doc_source: doc_source,
   )
-  sh "bundle exec ruby -Itest test/checks/my_new_check_test.rb"
+  sh "bundle exec ruby -Itest #{test_source}"
 end
 
 def erb(file, to, **args)

data/config/default.yml

@@ -141,3 +141,7 @@ ContentForHeaderModification:
 ImgLazyLoading:
   enabled: true
   ignore: []
+
+HtmlParsingError:
+  enabled: true
+  ignore: []

data/docs/checks/html_parsing_error.md

@@ -0,0 +1,50 @@
+# Report HTML parsing errors (`HtmlParsingError`)
+
+Report errors preventing the HTML from being parsed and analyzed by Theme Check.
+
+## Check Details
+
+This check is aimed at reporting HTML errors that prevent a file from being analyzed.
+
+The HTML parser limits the number of attributes per element to 400, and the maximum depth of the DOM tree to 400 levels. If any one of those limits is reached, parsing stops, and all HTML offenses on this file are ignored.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<img src="muffin.jpeg"
+     data-attrbute-1=""
+     data-attrbute-2=""
+     ... up to
+     data-attrbute-400="">
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<img src="muffin.jpeg">
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+HtmlParsingError:
+  enabled: true
+```
+
+## When Not To Use It
+
+If you don't care about HTML offenses.
+
+## Version
+
+This check has been introduced in Theme Check 0.10.2.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/html_parsing_error.rb
+[docsource]: /docs/checks/html_parsing_error.md

data/lib/theme_check/checks/html_parsing_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class HtmlParsingError < HtmlCheck
+    severity :error
+    category :html
+    doc docs_url(__FILE__)
+
+    def on_parse_error(exception, template)
+      add_offense("HTML in this template can not be parsed: #{exception.message}", template: template)
+    end
+  end
+end

data/lib/theme_check/html_visitor.rb

@@ -13,12 +13,14 @@ module ThemeCheck
     def visit_template(template)
       doc = parse(template)
       visit(HtmlNode.new(doc, template))
+    rescue ArgumentError => e
+      call_checks(:on_parse_error, e, template)
     end
 
     private
 
     def parse(template)
-      Nokogiri::HTML5.fragment(template.source)
+      Nokogiri::HTML5.fragment(template.source, max_tree_depth: 400, max_attributes: 400)
     end
 
     def visit(node)

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -81,6 +81,7 @@ files:
 - docs/checks/convert_include_to_render.md
 - docs/checks/default_locale.md
 - docs/checks/deprecated_filter.md
+- docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
 - docs/checks/liquid_tag.md
@@ -123,6 +124,7 @@ files:
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
 - lib/theme_check/checks/deprecated_filter.rb
+- lib/theme_check/checks/html_parsing_error.rb
 - lib/theme_check/checks/img_lazy_loading.rb
 - lib/theme_check/checks/img_width_and_height.rb
 - lib/theme_check/checks/liquid_tag.rb