theme-check 0.8.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b455dde358a80264581b4c6b62e70c071510d5e50ff8b253e98550ac64be3db
-  data.tar.gz: 5fc99066d47dd69ba0d56bea7bf60b20ccf4c67364b19999c2e5feba8cc4da12
+  metadata.gz: 56b6a91e5ac4b1e2045b1e4fb2748e5ecb9600206f9ba07df401c1410bf494fc
+  data.tar.gz: b6fb1b3957ae5aecd7b2efbaa76a2e3c07390ec442f94d416ea5b20ca2cbf966
 SHA512:
-  metadata.gz: 6ee8807bab14aa44d5d2f1722d846f2c07c58656c7aa23dcc1da7a2e0e4f8b76cf2ca862c2ad7a9c1fd88c470b7cc4517fc74684af55a31d36eba4e60b6990bd
-  data.tar.gz: fd0d6012b3f991df7de47f4f7de27348a35d9582908d8564140fd900e81da9e6203b4485c7fb13dec78ddd2201acf7829b893d0004dcd1436fea4b1ea6098767
+  metadata.gz: e2ca68b31968949dc52240c8ee5ca607e10e063b500cda0a7b06306589849f2bc0098f1b0742f962a91a0ca282aa504acb9f7c0de6b785afff0b577b84fa6eba
+  data.tar.gz: c7186299a1168c5ad1e3cd6544ee8c8248b96a492e1dc82481c26a69e75fb1f04172ceb58da61e310a393fd36c9b990464542e7528810c7bea556b5b8ce9b61d

data/.github/workflows/theme-check.yml

@@ -34,3 +34,6 @@ jobs:
       run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
     - name: Run tests
       run: bundle exec rake
+    - name: Test runtime
+      # Testing that runtime can execute, not testing the results themselves
+      run: bundle exec theme-check ./test/theme | grep -q "files inspected"

data/CHANGELOG.md

@@ -1,4 +1,49 @@
 
+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
+==================
+
+  * Introduce HtmlCheck, and convert ParserBlockingJavaScript & ImgWidthAndHeight to it
+  * Move `script-tag` validation from ParserBlockingJavaScript to ParserBlockingScriptTag
+  * Add ability to ignore individual checks using file patterns
+  * Introduce single file and whole theme checks to optimize LSP diagnostics
+  * Fix TemplateLength counter not being reseted on each document
+  * Add missing category to ValidHTMLTranslation
+  * Set Ruby default encodings to UTF-8 to fix encoding issues
+  * Add ContentForHeaderModification check to prevent relying on the content of ``content_for_header`
+  * Fix `Content-Length` in LSP responses
+  * Fix disabling checks that emit offences in `on_end`
+  * Fix completion bug in `filter_completion_provider`
+
+v0.8.3 / 2021-05-17
+==================
+
+  * Making sure VERSION is set before referencing it
+
+v0.8.2 / 2021-05-14
+===================
+
+  * Bump NestedSnippet max_nesting_level to 3
+  * Add a message to help debug errors, and timeout checks after 5 sec
+  * Object Completions Everywhere!
+  * Include operators to space inside braces check
+
 0.8.1 / 2021-04-22
 ==================
 

data/CONTRIBUTING.md

@@ -36,102 +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.
-  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/README.md

@@ -92,11 +92,14 @@ root: dist
 require:
   - ./path/to/my_custom_check.rb
 
-# Disable some checks
 TemplateLength:
+  # Disable some checks
   enabled: false
   # Or configure options
   max_length: 300
+  # Or ignore certain paths
+  ignore:
+    - snippets/icon-*
 
 # Enable a custom check
 MyCustomCheck

data/RELEASING.md

@@ -9,11 +9,13 @@
    rake prerelease[$VERSION]
    ```
 
-3. Commit your changes and make a PR.
+3. Run [`git changelog`](https://github.com/tj/git-extras) to update `CHANGELOG.md`.
 
-4. Merge your PR to master.
+4. Commit your changes and make a PR.
 
-5. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
+5. Merge your PR to master.
+
+6. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
 
 ## Homebrew Release Process
 

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/config/default.yml

@@ -7,92 +7,137 @@ ignore:
 
 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: []
 
 DefaultLocale:
   enabled: true
+  ignore: []
 
 TranslationKeyExists:
   enabled: true
+  ignore: []
 
 ValidHTMLTranslation:
   enabled: true
+  ignore: []
 
 ValidJson:
   enabled: true
+  ignore: []
 
 ValidSchema:
   enabled: true
+  ignore: []
 
 MissingRequiredTemplateFiles:
   enabled: true
+  ignore: []
 
 UndefinedObject:
   enabled: true
+  ignore: []
   exclude_snippets: true
 
 RequiredDirectories:
   enabled: true
+  ignore: []
 
 DeprecatedFilter:
   enabled: true
+  ignore: []
 
 MissingEnableComment:
   enabled: true
+  ignore: []
 
 ParserBlockingJavaScript:
   enabled: true
+  ignore: []
+
+ParserBlockingScriptTag:
+  enabled: true
 
 AssetSizeJavaScript:
   enabled: false
+  ignore: []
   threshold_in_bytes: 10_000
+  ignore: []
 
 AssetSizeCSS:
   enabled: false
+  ignore: []
   threshold_in_bytes: 100_000
+  ignore: []
 
 ImgWidthAndHeight:
   enabled: true
+  ignore: []
 
 RemoteAsset:
   enabled: true
+  ignore: []
+
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []
+
+ImgLazyLoading:
+  enabled: true
+  ignore: []

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