theme-check 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc820b814467926919858c11517a275e70dd07aea017285f315dc3309e4b49a3
-  data.tar.gz: 949c2934821bb7270aa466c3430d8fb640e8af938fb239aa1a2a346c82580a50
+  metadata.gz: e5970832846bda5a0e7cb27c99ebef32382050c911350d1d208211849bef7d55
+  data.tar.gz: 89d3bb2d5a261c817dddfbf50ad9ac31a589f88fe4f2a2df23b8c5aaad51c4db
 SHA512:
-  metadata.gz: 699907617f0401cd5737c7f774b7063fae97f17465a8ac06ad1e404992b969923e4de6ff877c5f85fb951a8af1433ac017ab651465132b69d6143ff77baa5495
-  data.tar.gz: 93d69bd9b50561cc0f10940f4b5e7c5b19fcef43d105d0896b4ae484a3df13301cfc51f6470dff4b83b1e3410a3736f54d5097dca9a80763fa7c4790f1761018
+  metadata.gz: 2ee4f610dc461c6e70e870723f801ddb0f1e5381eebfc6622030af68486c2c6650c11e530be38456cf0df8666ecc5e78b26d16cf60428142e04f0ebde45edf9f
+  data.tar.gz: 36053d9337a817da4334a5341be1877f04d86b3f4d88606a2acccb2028c0a3a07227086183de5aa06bd44e9beeebd0a4650d08b746fdfbced854e945469d61a3

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,19 @@
 
+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
 ==================
 

data/CONTRIBUTING.md

@@ -41,7 +41,8 @@ Under `lib/theme_check/checks`, create new Ruby file with a unique name describi
 ```ruby
 module ThemeCheck
   # Does one thing, and does it well!
-  # NOTE: inherit from JsonCheck to implement a JSON based check.
+  # 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
 

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

@@ -7,92 +7,129 @@ 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: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []

data/docs/checks/content_for_header_modification.md

@@ -0,0 +1,42 @@
+# Do not depend on the content of `content_for_header` (`ContentForHeaderModification`)
+
+Do not rely on the content of `content_for_header` as it might change in the future, which could cause your Liquid code behavior to change.
+
+## Check Details
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign parts = content_for_header | split: ',' %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+The only acceptable usage of `content_for_header` is:
+
+```liquid
+{{ content_for_header }}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ContentForHeaderModification:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+- [`theme.liquid` template considerations][considerations]
+
+[codesource]: /lib/theme_check/checks/check_class_name.rb
+[docsource]: /docs/checks/check_class_name.md
+[considerations]: https://shopify.dev/docs/themes/theme-templates/theme-liquid#template-considerations

data/docs/checks/parser_blocking_script_tag.md

@@ -0,0 +1,53 @@
+# Discourage use of parser-blocking `script_tag` filter (`ParserBlockingScriptTag`)
+
+The `script_tag` filter emits a parser-blocking script tag.
+
+See the [ParserBlockingJavaScript check documentation][parser_blocking_javascript] for why this is generally discouraged.
+
+## Check Details
+
+This check is aimed at eliminating parser-blocking JavaScript on themes.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- The script_tag filter outputs a parser-blocking script -->
+{{ 'app-code.js' | asset_url | script_tag }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<!-- Good. Using the asset_url filter + defer -->
+<script src="{{ 'theme.js' | asset_url }}" defer></script>
+
+<!-- Also good. Using the asset_url filter + async -->
+<script src="{{ 'theme.js' | asset_url }}" async></script>
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ParserBlockingScriptTag:
+  enabled: true
+```
+
+## When Not To Use It
+
+This should only be turned off with the `theme-check-disable` comment when there's no better way to accomplish what you're doing than with a parser-blocking script.
+
+It is discouraged to turn this rule off.
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [ParserBlockingJavaScript check][parser_blocking_javascript]
+- [Documentation Source][docsource]
+
+[parser_blocking_javascript]: /docs/checks/parser_blocking_javascript.md
+[docsource]: /docs/checks/parser_blocking_script_tag.md

data/exe/theme-check-language-server

@@ -6,7 +6,6 @@ require 'theme_check'
 if ENV["THEME_CHECK_DEBUG"] == "true"
   $DEBUG = true
 end
-# Force encoding to UTF-8 to fix VSCode
-Encoding.default_external = Encoding::UTF_8
+
 status_code = ThemeCheck::LanguageServer.start
 exit! status_code

data/lib/theme_check.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "liquid"
 
+require_relative "theme_check/version"
 require_relative "theme_check/bug"
 require_relative "theme_check/exceptions"
 require_relative "theme_check/analyzer"
@@ -35,6 +36,12 @@ require_relative "theme_check/template"
 require_relative "theme_check/theme"
 require_relative "theme_check/visitor"
 require_relative "theme_check/corrector"
-require_relative "theme_check/version"
+require_relative "theme_check/html_node"
+require_relative "theme_check/html_visitor"
+require_relative "theme_check/html_check"
 
 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

data/lib/theme_check/analyzer.rb

@@ -7,6 +7,7 @@ module ThemeCheck
 
       @liquid_checks = Checks.new
       @json_checks = Checks.new
+      @html_checks = Checks.new
 
       checks.each do |check|
         check.theme = @theme
@@ -16,33 +17,58 @@ module ThemeCheck
           @liquid_checks << check
         when JsonCheck
           @json_checks << check
+        when HtmlCheck
+          @html_checks << check
         end
       end
-
-      @visitor = Visitor.new(@liquid_checks)
     end
 
     def offenses
-      @liquid_checks.flat_map(&:offenses) + @json_checks.flat_map(&:offenses)
+      @liquid_checks.flat_map(&:offenses) +
+        @json_checks.flat_map(&:offenses) +
+        @html_checks.flat_map(&:offenses)
     end
 
-    def offenses_clear!
-      @liquid_checks.each do |check|
-        check.offenses.clear
-      end
+    def analyze_theme
+      reset
 
-      @json_checks.each do |check|
-        check.offenses.clear
+      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)
       end
-    end
 
-    def analyze_theme
-      offenses_clear!
-      @theme.liquid.each { |template| @visitor.visit_template(template) }
       @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
-      @liquid_checks.call(:on_end)
-      @json_checks.call(:on_end)
-      offenses
+
+      finish
+    end
+
+    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)
+        end
+      end
+
+      finish
     end
 
     def uncorrectable_offenses
@@ -59,5 +85,35 @@ module ThemeCheck
         @theme.liquid.each(&:write)
       end
     end
+
+    private
+
+    def reset
+      @disabled_checks = DisabledChecks.new
+
+      @liquid_checks.each do |check|
+        check.offenses.clear
+      end
+
+      @html_checks.each do |check|
+        check.offenses.clear
+      end
+
+      @json_checks.each do |check|
+        check.offenses.clear
+      end
+    end
+
+    def finish
+      @liquid_checks.call(:on_end)
+      @html_checks.call(:on_end)
+      @json_checks.call(:on_end)
+
+      @disabled_checks.remove_disabled_offenses(@liquid_checks)
+      @disabled_checks.remove_disabled_offenses(@json_checks)
+      @disabled_checks.remove_disabled_offenses(@html_checks)
+
+      offenses
+    end
   end
 end