theme-check 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b606fffc2525680e6d47cf1d45b3fbdd514c79cf426dfd28baaec20e1cc083f
-  data.tar.gz: f0b9e3b0da8f41ae48e11d91ff1ccd780e0ed6cc5b8ba80694c3cd70a33e04a0
+  metadata.gz: 56b6a91e5ac4b1e2045b1e4fb2748e5ecb9600206f9ba07df401c1410bf494fc
+  data.tar.gz: b6fb1b3957ae5aecd7b2efbaa76a2e3c07390ec442f94d416ea5b20ca2cbf966
 SHA512:
-  metadata.gz: 23ce6e8b332e57cf523db93cf14ca9c948e569703633d5b82f106e95e66dd613ab30fa448226cf4f624b24da2675179220e7fc9fe206bfa9521f722c74356ba2
-  data.tar.gz: 22e2469eba1fc8aca4e881cfc5d0ad5ea7c16a057cdba6327310906099497b72d18dbef2d4f69d328528d6801f0abb91fac78a692f68387f7378d2c8fd3986dd
+  metadata.gz: e2ca68b31968949dc52240c8ee5ca607e10e063b500cda0a7b06306589849f2bc0098f1b0742f962a91a0ca282aa504acb9f7c0de6b785afff0b577b84fa6eba
+  data.tar.gz: c7186299a1168c5ad1e3cd6544ee8c8248b96a492e1dc82481c26a69e75fb1f04172ceb58da61e310a393fd36c9b990464542e7528810c7bea556b5b8ce9b61d

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+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
 ==================
 

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/checks/my_new_check_test.rb"
+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/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

data/docs/checks/{CHECK_DOCS_TEMPLATE.md → TEMPLATE.md.erb}

@@ -1,4 +1,4 @@
-# Check Title (`CheckClassName`)
+# Check Title (`<%= class_name %>`)
 
 A brief paragraph explaining why the check exists.
 
@@ -21,7 +21,7 @@ This check is aimed at eliminating ...
 The default configuration for this check is the following:
 
 ```yaml
-CheckClassName:
+<%= class_name %>:
   enabled: true
   some_option: 10
 ```
@@ -36,12 +36,12 @@ If you don't want to ..., then it's safe to disable this rule.
 
 ## Version
 
-This check has been introduced in Theme Check X.X.X.
+This check has been introduced in Theme Check THEME_CHECK_VERSION.
 
 ## Resources
 
 - [Rule Source][codesource]
 - [Documentation Source][docsource]
 
-[codesource]: /lib/theme_check/checks/check_class_name.rb
-[docsource]: /docs/checks/check_class_name.md
+[codesource]: /<%= code_source %>
+[docsource]: /<%= doc_source %>

data/lib/theme_check/check.rb

@@ -18,7 +18,6 @@ module ThemeCheck
     CATEGORIES = [
       :liquid,
       :translation,
-      :performance,
       :html,
       :json,
       :performance,
@@ -124,6 +123,7 @@ module ThemeCheck
     def ==(other)
       other.is_a?(Check) && code_name == other.code_name
     end
+    alias_method :eql?, :==
 
     def to_s
       s = +"#{code_name}:\n"

data/lib/theme_check/checks/TEMPLATE.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # TODO: inherit from HtmlCheck or JsonCheck if working on a non-Liquid check
+  class <%= class_name %> < LiquidCheck
+    severity :suggestion
+    category :liquid
+    doc docs_url(__FILE__)
+
+    # TODO: def on_<NODE_TYPE>
+  end
+end

data/lib/theme_check/json_file.rb

@@ -46,6 +46,11 @@ module ThemeCheck
       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/diagnostics_tracker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "logger"
 
 module ThemeCheck
   module LanguageServer
@@ -16,6 +17,7 @@ module ThemeCheck
       def build_diagnostics(offenses, analyzed_files: nil)
         reported_files = Set.new
         new_single_file_offenses = {}
+        analyzed_files = analyzed_files.map { |path| Pathname.new(path) } if analyzed_files
 
         offenses.group_by(&:template).each do |template, template_offenses|
           next unless template

data/lib/theme_check/offense.rb

@@ -124,13 +124,13 @@ module ThemeCheck
 
     def ==(other)
       other.is_a?(Offense) &&
-        check == other.check &&
+        code_name == other.code_name &&
         message == other.message &&
-        template == other.template &&
-        node == other.node &&
-        markup == other.markup &&
-        line_number == other.line_number
+        location == other.location &&
+        start_index == other.start_index &&
+        end_index == other.end_index
     end
+    alias_method :eql?, :==
 
     def to_s
       if template

data/lib/theme_check/template.rb

@@ -91,6 +91,7 @@ module ThemeCheck
     def ==(other)
       other.is_a?(Template) && relative_path == other.relative_path
     end
+    alias_method :eql?, :==
 
     def self.parse(source)
       Liquid::Template.parse(

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -69,7 +69,11 @@ files:
 - data/shopify_liquid/tags.yml
 - data/shopify_translation_keys.yml
 - dev.yml
-- docs/checks/CHECK_DOCS_TEMPLATE.md
+- docs/api/check.md
+- docs/api/html_check.md
+- docs/api/json_check.md
+- docs/api/liquid_check.md
+- docs/checks/TEMPLATE.md.erb
 - docs/checks/asset_size_css.md
 - docs/checks/asset_size_javascript.md
 - docs/checks/asset_url_filters.md
@@ -111,6 +115,7 @@ files:
 - lib/theme_check/bug.rb
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
+- lib/theme_check/checks/TEMPLATE.rb.erb
 - lib/theme_check/checks/asset_size_css.rb
 - lib/theme_check/checks/asset_size_javascript.rb
 - lib/theme_check/checks/asset_url_filters.rb