theme-check 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5970832846bda5a0e7cb27c99ebef32382050c911350d1d208211849bef7d55
-  data.tar.gz: 89d3bb2d5a261c817dddfbf50ad9ac31a589f88fe4f2a2df23b8c5aaad51c4db
+  metadata.gz: 94b918e53777cfb70c65dacd9d9bfbdb6f4463597c8f9c81969e1baef89df7a1
+  data.tar.gz: 7e45af9a3dfeab1eafdff5533df68a9e0d67007d94661a2c974c0c2fece61095
 SHA512:
-  metadata.gz: 2ee4f610dc461c6e70e870723f801ddb0f1e5381eebfc6622030af68486c2c6650c11e530be38456cf0df8666ecc5e78b26d16cf60428142e04f0ebde45edf9f
-  data.tar.gz: 36053d9337a817da4334a5341be1877f04d86b3f4d88606a2acccb2028c0a3a07227086183de5aa06bd44e9beeebd0a4650d08b746fdfbced854e945469d61a3
+  metadata.gz: ea1b75ca11a66aefe5eef421f577d53716cb180799863185d36fad21a9033b5cf52579df3e593e41867513da410adc7d16de723f35b3a5435e50098b7af2a348
+  data.tar.gz: ceab091f6bf7317d899cb5459601b7dfb5294e6e4be962a421b33bad33c74fd730001dea90687f81f754d57e5cdedc5b39d0efb5d95d6c016ed965f7e4e86a9f

data/CHANGELOG.md

@@ -1,4 +1,41 @@
 
+v1.0.0 / 2021-06-28
+==================
+
+  * Convert `AssetSizeCSS` to `HtmlCheck`
+  * Add `DeprecateLazysizes` & `DeprecateBgsizes` checks
+  * Allow hardcoded CDN urls in `RemoteAsset`
+  * Bump `LiquidTag` `min_consecutive_statements` default to 5
+  * Exclude {% javascript %} and {% stylesheet %} from line counts in `TemplateLength`
+  * Bump `TemplateLength` `max_length` default to 500
+  * Fix `StringScanner#skip(String)` not being supported on some Rubies
+  * Fix `ParsingHelpers#outside_of_strings` handling of empty strings
+  * Update to support new `{% render %}` syntax
+  * Converted `AssetSizeJavaScript` to `HtmlCheck`
+
+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
+==================
+
+  * Fix LSP diagnostics not being merged properly when analyzing a single file.
+    Causing VSCode problems not being cleared after fixing.
+
+v0.10.0 / 2021-06-08
+==================
+
+  * Add ImgLazyLoading check for recommending loading="lazy" attribute
+
+v0.9.1 / 2021-06-04
+==================
+
+  * Convert `RemoteAsset` into an `HtmlCheck`
+  * Move Liquid logic from `RemoteAsset` to a new `AssetUrlFilters` check
+
 v0.9.0 / 2021-05-28
 ==================
 

data/CONTRIBUTING.md

@@ -36,103 +36,32 @@ bundle exec theme-check /path/to/your/theme
 
 ## Creating a new "Check"
 
-Under `lib/theme_check/checks`, create new Ruby file with a unique name describing what you want to check for.
+Run `bundle exec rake "new_check[MyNewCheckName]"` to generate all the files required to create a new check.
 
-```ruby
-module ThemeCheck
-  # Does one thing, and does it well!
-  # NOTE: inherit from `JsonCheck` to implement a JSON-based check, and from `HtmlCheck`
-  # to implement an HTML-based one. See other checks in `lib/theme_check/checks` for examples.
-  class MyCheckName < LiquidCheck
-    severity :suggestion # :error or :style
-
-    def on_document(node)
-      # Called with the root node of all templates
-      node.value    # is the original Liquid object for this node. See Liquid source code for details.
-      node.template # is the template being analyzed, See lib/theme_check/template.rb.
-      node.parent   # is the parent node.
-      node.children # are the children nodes.
-      # See lib/theme_check/node.rb for more helper methods
-      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
-    end
-
-    def on_node(node)
-      # Called for every node
-    end
-
-    def on_tag(node)
-      # Called for each tag (if, include, for, assign, etc.)
-    end
-
-    def after_tag(node)
-      # Called after the tag children have been visited
-      
-      # If you find an issue, add an offense:
-      add_offense("Describe the problem...", node: node)
-      # Or, if the offense is related to the whole template:
-      add_offense("Describe the problem...", template: node.template)
-    end
-
-    def on_assign(node)
-      # Called only for {% assign ... %} tags
-    end
-
-    def on_string(node)
-      # Called for every `String` (including inside if conditions).
-      if node.parent.block?
-        # If parent is a block, `node.value` is a String written directly to the output when
-        # the template is rendered.
-      end
-    end
-
-    def on_error(exception)
-      # Called each time a Liquid exception is raised while parsing the template
-    end
-
-    def on_end
-      # A special callback after we're done visiting all the templates
-    end
-
-    # Each type of node has a corresponding `on_node_class_name` & `after_node_class_name`
-    # A few common examples:
-    # on_block_body(node)
-    # on_capture(node)
-    # on_case(node)
-    # on_comment(node)
-    # on_condition(node)
-    # on_document(node)
-    # on_else_condition(node)
-    # on_for(node)
-    # on_form(node)
-    # on_if(node)
-    # on_include(node)
-    # on_integer(node)
-    # on_layout(node)
-    # on_method_literal(node)
-    # on_paginate(node)
-    # on_range(node)
-    # on_render(node)
-    # on_schema(node)
-    # on_section(node)
-    # on_style(node)
-    # on_unless(node)
-    # on_variable(node)
-    # on_variable_lookup(node)
-  end
-end
-```
+Check the [Check API](/docs/api/check.md) for how to implement a check. Also take a look at other checks in [lib/theme_check/checks](/lib/theme_check/checks).
 
-Add the new check to `config/default.yml` to enable it. If the check is configurable, the `initialize` argument name and default values should also be duplicated inside `config/default.yml`.
+We done implementing your check, add it to `config/default.yml` to enable it:
 
 ```yaml
-MyCheckName:
+MyNewCheckName:
   enabled: true
+  ignore: []
 ```
 
-Add a corresponding test file under `test/checks`.
-
-Add a documentation file in `docs/checks/#{name_of_check}.md` based off of the [check documentation template][doctemplate].
+If the check is configurable, the `initialize` argument names and default values should also be duplicated inside `config/default.yml`. eg.:
 
-When done, run the tests with `dev test`.
+```ruby
+class MyCheckName < LiquidCheck
+  def initialize(muffin_mode: true)
+    @muffin_mode = muffin_mode
+  end
+  # ...
+end
+```
 
-[doctemplate]: /docs/checks/CHECK_DOCS_TEMPLATE.md
+```yaml
+MyNewCheckName:
+  enabled: true
+  ignore: []
+  muffin_mode: true
+```

data/Rakefile

@@ -52,3 +52,34 @@ task :prerelease, [:version] do |_t, args|
   require 'theme_check/releaser'
   ThemeCheck::Releaser.new.release(args.version)
 end
+
+desc "Create a new check"
+task :new_check, [:name] do |_t, args|
+  require "theme_check/string_helpers"
+  class_name = args.name
+  base_name = ThemeCheck::StringHelpers.underscore(class_name)
+  code_source = "lib/theme_check/checks/#{base_name}.rb"
+  doc_source = "docs/checks/#{base_name}.md"
+  test_source = "test/checks/#{base_name}_test.rb"
+  erb(
+    "lib/theme_check/checks/TEMPLATE.rb.erb", code_source,
+    class_name: class_name,
+  )
+  erb(
+    "test/checks/TEMPLATE.rb.erb", test_source,
+    class_name: class_name,
+  )
+  erb(
+    "docs/checks/TEMPLATE.md.erb", doc_source,
+    class_name: class_name,
+    code_source: code_source,
+    doc_source: doc_source,
+  )
+  sh "bundle exec ruby -Itest #{test_source}"
+end
+
+def erb(file, to, **args)
+  require "erb"
+  File.write(to, ERB.new(File.read(file)).result_with_hash(args))
+  puts "Generated #{to}"
+end

data/config/default.yml

@@ -12,7 +12,7 @@ ConvertIncludeToRender:
 LiquidTag:
   enabled: true
   ignore: []
-  min_consecutive_statements: 4
+  min_consecutive_statements: 5
 
 MissingTemplate:
   enabled: true
@@ -38,9 +38,13 @@ SyntaxError:
 TemplateLength:
   enabled: true
   ignore: []
-  max_length: 200
+  max_length: 500
   # Exclude content of {% schema %} in line count
   exclude_schema: true
+  # Exclude content of {% stylesheet %} in line count
+  exclude_stylesheet: true
+  # Exclude content of {% javascript %} in line count
+  exclude_javascript: true
 
 UnknownFilter:
   enabled: true
@@ -99,6 +103,14 @@ DeprecatedFilter:
   enabled: true
   ignore: []
 
+DeprecateLazysizes:
+  enabled: true
+  ignore: []
+
+DeprecateBgsizes:
+  enabled: true
+  ignore: []
+
 MissingEnableComment:
   enabled: true
   ignore: []
@@ -109,16 +121,20 @@ ParserBlockingJavaScript:
 
 ParserBlockingScriptTag:
   enabled: true
+  ignore: []
 
 AssetSizeJavaScript:
   enabled: false
-  ignore: []
   threshold_in_bytes: 10_000
   ignore: []
 
 AssetSizeCSS:
   enabled: false
+  threshold_in_bytes: 100_000
   ignore: []
+
+AssetSizeCSSStylesheetTag:
+  enabled: false
   threshold_in_bytes: 100_000
   ignore: []
 
@@ -130,6 +146,18 @@ RemoteAsset:
   enabled: true
   ignore: []
 
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
 ContentForHeaderModification:
   enabled: true
   ignore: []
+
+ImgLazyLoading:
+  enabled: true
+  ignore: []
+
+HtmlParsingError:
+  enabled: true
+  ignore: []

data/data/shopify_liquid/objects.yml

@@ -40,6 +40,7 @@
 - linklist
 - linklists
 - location
+- localization
 - metafield
 - model
 - model_source
@@ -55,6 +56,7 @@
 - powered_by_link
 - product
 - product_option
+- product_variant
 - recommendations
 - request
 - routes

data/docs/api/check.md

@@ -0,0 +1,15 @@
+# Check API
+
+Theme Check uses static analysis. It parses theme files into an AST, and then calls the appropriate checks to analyze it.
+
+An [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) is a tree of node, representing the theme file.
+
+Checks are Ruby classes with callback methods:
+- `on_TYPE` that runs before a node of the specific TYPE is visited.
+- `after_TYPE` that runs after a node of the specific TYPE is visited.
+
+There are three types of checks currently supported:
+
+- [`LiquidCheck`](/docs/api/liquid_check.md)
+- [`HtmlCheck`](/docs/api/html_check.md)
+- [`JsonCheck`](/docs/api/html_check.md)

data/docs/api/html_check.md

@@ -0,0 +1,46 @@
+# HTML check API
+
+For checking HTML elements in `.liquid` files.
+
+If you need to check an HTML tag or its attributes, use an `HtmlCheck`.
+
+The HTML in Liquid files is parsed using the Nokogiri, by consequence you will get [`Nokogiri::XML::Node`][nokogiri].
+
+
+```ruby
+module ThemeCheck
+  class MyCheckName < HtmlCheck
+    category :html,
+    # A check can belong to multiple categories. Valid ones:
+    categories :translation, :performance
+    severity :suggestion # :error or :style
+
+    def on_document(node)
+      # Called with the root node of all templates
+      node.value    # is an instance of Nokogiri::XML::Node
+      node.template # is the template being analyzed, See lib/theme_check/template.rb.
+      node.parent   # is the parent node.
+      node.children # are the children nodes.
+      # See lib/theme_check/html_node.rb for more helper methods
+      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
+    end
+
+    def on_img(node)
+      # Called for every <img> element in the file.
+      node.attrbutes["class"] # Get the class attribute of the img element.
+    end
+
+    def on_a(node)
+      # Called for every <a> element in the file.
+    end
+  end
+end
+```
+
+## Resources
+
+- [Nokogiri::XML::Node API doc][nokogiri]
+
+[nokogiri]: https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node
+
+

data/docs/api/json_check.md

@@ -0,0 +1,19 @@
+# JSON check API
+
+For checking the content of `.json` files.
+
+```ruby
+module ThemeCheck
+  class MyCheckName < JsonCheck
+    category :json,
+    # A check can belong to multiple categories. Valid ones:
+    categories :translation, :performance
+    severity :suggestion # :error or :style
+
+    def on_file(file)
+      file # an instance of `ThemeCheck::JsonFile`
+      file.content # the parsed JSON, as a Ruby object, usually a Hash
+    end
+  end
+end
+```

data/docs/api/liquid_check.md

@@ -0,0 +1,99 @@
+# Liquid check API
+
+For checking the Liquid code in `.liquid` files.
+
+All code inside `{% ... %}` or `{{ ... }}` is Liquid code.
+
+Liquid files are parsed using the Liquid parser, by consequence you will get Liquid nodes (tags, blocks) in your callback methods. Check the Liquid source for details on those nodes: [Liquid source][liquidsource].
+
+
+```ruby
+module ThemeCheck
+  class MyCheckName < LiquidCheck
+    category :liquid,
+    # A check can belong to multiple categories. Valid ones:
+    categories :translation, :performance
+    severity :suggestion # :error or :style
+
+    def on_document(node)
+      # Called with the root node of all templates
+      node.value    # is the original Liquid object for this node. See Liquid source code for details.
+      node.template # is the template being analyzed, See lib/theme_check/template.rb.
+      node.parent   # is the parent node.
+      node.children # are the children nodes.
+      # See lib/theme_check/node.rb for more helper methods
+      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
+    end
+
+    def on_node(node)
+      # Called for every node
+    end
+
+    def on_tag(node)
+      # Called for each tag (if, include, for, assign, etc.)
+    end
+
+    def after_tag(node)
+      # Called after the tag children have been visited
+      
+      # If you find an issue, add an offense:
+      add_offense("Describe the problem...", node: node)
+      # Or, if the offense is related to the whole template:
+      add_offense("Describe the problem...", template: node.template)
+    end
+
+    def on_assign(node)
+      # Called only for {% assign ... %} tags
+    end
+
+    def on_string(node)
+      # Called for every `String` (including inside if conditions).
+      if node.parent.block?
+        # If parent is a block, `node.value` is a String written directly to the output when
+        # the template is rendered.
+      end
+    end
+
+    def on_variable(node)
+      # Called for each {{ ... }}
+    end
+
+    def on_error(exception)
+      # Called each time a Liquid exception is raised while parsing the template
+    end
+
+    def on_end
+      # A special callback after we're done visiting all the files of the theme
+    end
+
+    # Each type of node has a corresponding `on_node_class_name` & `after_node_class_name`
+    # A few common examples:
+    # on_capture(node)
+    # on_case(node)
+    # on_comment(node)
+    # on_if(node)
+    # on_condition(node)
+    # on_else_condition(node)
+    # on_for(node)
+    # on_form(node)
+    # on_include(node)
+    # on_integer(node)
+    # on_layout(node)
+    # on_method_literal(node)
+    # on_paginate(node)
+    # on_range(node)
+    # on_render(node)
+    # on_schema(node)
+    # on_section(node)
+    # on_style(node)
+    # on_unless(node)
+    # on_variable_lookup(node)
+  end
+end
+```
+
+## Resources
+
+- [Liquid source][liquidsource]
+
+[liquidsource]: https://github.com/Shopify/liquid/tree/master/lib/liquid