theme-check 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d699b72927dc2112b7cf3560a303a3dff52dfd99120e3201cd9721372282e36
-  data.tar.gz: e850929c23554d200de3ca17e0759e8a760f98152cf293561a54aa5fbc24c5e5
+  metadata.gz: a07597b217b1f596cd5e777726950e396934726f3572bc7660129bec2b3b30c8
+  data.tar.gz: 80e54966286e332f3308021b9347feb4cdb683497991b9bb451dcf58f138a2df
 SHA512:
-  metadata.gz: f3e26f98b06a8c596442ac7562d72810ab92b4e20a3ddca2892860f94377fb1b5f4e9d6ba94eba5687170c364ac17a080fb971b95cc41b66d3a811b2637282ab
-  data.tar.gz: c2d95ee213323de5df634c2b47b21317a3fef5f9edae2aae056d87ecc41694a0ba9296eb9dd0c9cf70213ad920d2b8fa4849d197c77cb196c50111728156eca5
+  metadata.gz: 4c7a1c159dd1b688618c95e1e5fb943a133b606878f57c91b12e5793b07022325c5cfb2e81c49cb45ea484cb3688c6f7c2b75af1b2a50f13da6db2ba0e8b0bb3
+  data.tar.gz: 83fe6a74375ecf2b58f14681c99bc672a710cd6bbc70cb5f58ff06332d4123171544f6cf73c6e7f5f750c1a870d17de0ce3bd3e1f9cbfca6e1bdc7fceb767b80

data/CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 We love receiving pull requests!
 
+For your contribution to be accepted you will need to sign the [Shopify Contributor License Agreement (CLA)](https://cla.shopify.com/).
+
 ## Standards
 
 * Checks should do one thing, and do it well.

data/README.md

@@ -4,7 +4,7 @@ Think RuboCop, or eslint, but for Shopify themes.
 
 Theme Check is a command line tool that helps you follow Shopify Themes & Liquid best practices by analyzing the Liquid & JSON inside your theme.
 
-Code editor support coming soon!
+Theme Check is also available [inside some code editors](https://github.com/Shopify/theme-check/wiki).
 
 ![](docs/preview.png)
 
@@ -30,8 +30,9 @@ Theme Check currently checks for the following:
 ✅ Unmatching translation keys in locale files  
 ✅ Using unknown translation keys in `{{ 'missing_key' | t }}`  
 ✅ Using several `{% ... %}` instead of `{% liquid ... %}`  
-✅ Undefined [objects](https://shopify.dev/docs/themes/liquid/reference/objects)
+✅ Undefined [objects](https://shopify.dev/docs/themes/liquid/reference/objects)  
 ✅ Deprecated filters  
+✅ Missing `theme-check-enable` comment  
 
 And many more to come! Suggestions welcome ([create an issue](https://github.com/Shopify/theme-check/issues)).
 
@@ -79,11 +80,53 @@ Add a `.theme-check.yml` file at the root of your theme to configure:
 # be uploaded to Shopify.
 root: dist
 
+# It is possible to extend theme-check with custom checks
+require:
+  - ./path/to/my_custom_check.rb
+
 # Disable some checks
 TemplateLength:
   enabled: false
   # Or configure options
   max_length: 300
+  
+# Enable a custom check
+MyCustomCheck
+  enabled: true
 ```
 
 See [config/default.yml](config/default.yml) for available options & defaults.
+
+## Disable checks with comments
+
+Use Liquid comments to disable and re-enable all checks for a section of your template:
+
+```liquid
+{% comment %}theme-check-disable{% endcomment %}
+{% assign x = 1 %}
+{% comment %}theme-check-enable{% endcomment %}
+```
+
+Disable a specific check by including it in the comment:
+
+```liquid
+{% comment %}theme-check-disable UnusedAssign{% endcomment %}
+{% assign x = 1 %}
+{% comment %}theme-check-enable UnusedAssign{% endcomment %}
+```
+
+Disable multiple checks by including them as a comma-separated list:
+
+```liquid
+{% comment %}theme-check-disable UnusedAssign,SpaceInsideBraces{% endcomment %}
+{%assign x = 1%}
+{% comment %}theme-check-enable UnusedAssign,SpaceInsideBraces{% endcomment %}
+```
+
+Disable checks for the _entire document_ by placing the comment on the first line:
+
+```liquid
+{% comment %}theme-check-disable SpaceInsideBraces{% endcomment %}
+
+{%assign x = 1%}
+```

data/RELEASING.md

@@ -0,0 +1,41 @@
+## Releasing Theme Check
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+
+2. Create a PR to update the version in `lib/theme_check/version.rb`
+
+3. Merge your PR to master
+
+4. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
+
+## Homebrew Release Process
+
+1. Release `theme-check` on RubyGems by following the steps in the previous section.
+
+2. Generate the homebrew formula.
+
+   ```bash
+   rake package
+   ```
+
+3. Copy the formula over in the [`homebrew-shopify`](https://github.com/Shopify/homebrew-shopify) repository.
+
+   ```bash
+   VERSION=X.X.X
+   cp packaging/builds/$VERSION/theme-check ../homebrew-shopify
+   ```
+
+4. Create a branch + a commit on the [`homebrew-shopify`](https://github.com/Shopify/homebrew-shopify) repository.
+
+   ```bash
+   git checkout -b "bump/theme-check-$VERSION"
+   git add theme-check.rb
+   git commit -m "Bump theme-check version to $VERSION"
+   ```
+
+5. Create a pull-request for those changes on the [`homebrew-shopify`](https://github.com/Shopify/homebrew-shopify) repository.
+
+   ```bash
+   # shortcut if you have `hub` installed
+   hub compare "master:bump/theme-check-$VERSION"
+   ```

data/Rakefile

@@ -3,12 +3,32 @@ require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+namespace :tests do
+  task all: [:in_memory, :file_system]
+
+  Rake::TestTask.new(:suite) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"]
+  end
+
+  desc("Runs the tests with InMemoryStorage")
+  task :in_memory do
+    ENV["THEME_STORAGE"] = 'InMemoryStorage'
+    puts "Running tests with #{ENV['THEME_STORAGE']}"
+    Rake::Task['tests:suite'].execute
+  end
+
+  desc("Runs the tests with FileSystemStorage")
+  task :file_system do
+    ENV["THEME_STORAGE"] = 'FileSystemStorage'
+    puts "Running tests with #{ENV['THEME_STORAGE']}"
+    Rake::Task['tests:suite'].execute
+  end
 end
 
+task(test: 'tests:all')
+
 RuboCop::RakeTask.new
 
 task default: [:test, :rubocop]

data/config/default.yml

@@ -1,3 +1,10 @@
+root: .
+
+require: []
+
+ignore:
+  - node_modules/*
+
 ConvertIncludeToRender:
   enabled: true
 
@@ -22,6 +29,8 @@ SyntaxError:
 TemplateLength:
   enabled: true
   max_length: 200
+  # Exclude content of {% schema %} in line count
+  exclude_schema: true
 
 UnknownFilter:
   enabled: true
@@ -64,3 +73,9 @@ RequiredDirectories:
 
 DeprecatedFilter:
   enabled: true
+
+MissingEnableComment:
+  enabled: true
+
+ParserBlockingJavaScript:
+  enabled: true

data/data/shopify_liquid/plus_objects.yml

@@ -0,0 +1,15 @@
+---
+- alternative_payment_methods
+- breadcrumb
+- checkout_html_classes
+- checkout_scripts
+- checkout_stylesheets
+- content_for_footer
+- content_for_logo
+- content_for_order_summary
+- direction
+- locale
+- order_summary_toggle
+- page_title
+- skip_to_content_link
+- tracking_code

data/dev.yml

@@ -19,5 +19,7 @@ commands:
     run: bundle exec rake test
   style:
     run: bundle exec rake rubocop
+  autocorrect:
+    run: bundle exec rubocop --auto-correct
   language-server:
     run: bundle exec theme-check-language-server

data/lib/theme_check.rb

@@ -5,6 +5,7 @@ require_relative "theme_check/analyzer"
 require_relative "theme_check/check"
 require_relative "theme_check/checks_tracking"
 require_relative "theme_check/cli"
+require_relative "theme_check/disabled_checks"
 require_relative "theme_check/liquid_check"
 require_relative "theme_check/locale_diff"
 require_relative "theme_check/json_check"
@@ -17,6 +18,9 @@ require_relative "theme_check/node"
 require_relative "theme_check/offense"
 require_relative "theme_check/printer"
 require_relative "theme_check/shopify_liquid"
+require_relative "theme_check/storage"
+require_relative "theme_check/file_system_storage"
+require_relative "theme_check/in_memory_storage"
 require_relative "theme_check/tags"
 require_relative "theme_check/template"
 require_relative "theme_check/theme"

data/lib/theme_check/analyzer.rb

@@ -35,12 +35,6 @@ module ThemeCheck
       @offenses
     end
 
-    def analyze_file(path)
-      path = Pathname.new(path)
-      analyze_theme
-      @offenses.reject! { |offense| offense.template.path != path }
-    end
-
     def uncorrectable_offenses
       unless @auto_correct
         return @offenses

data/lib/theme_check/check.rb

@@ -50,6 +50,13 @@ module ThemeCheck
         @doc = doc if doc
         @doc if defined?(@doc)
       end
+
+      def can_disable(disableable = nil)
+        unless disableable.nil?
+          @can_disable = disableable
+        end
+        defined?(@can_disable) ? @can_disable : true
+      end
     end
 
     def severity
@@ -80,6 +87,10 @@ module ThemeCheck
       defined?(@ignored) && @ignored
     end
 
+    def can_disable?
+      self.class.can_disable
+    end
+
     def to_s
       s = +"#{code_name}:\n"
       properties = { severity: severity, category: category, doc: doc }.merge(options)

data/lib/theme_check/checks.rb

@@ -8,5 +8,15 @@ module ThemeCheck
         end
       end
     end
+
+    def always_enabled
+      self.class.new(reject(&:can_disable?))
+    end
+
+    def except_for(disabled_checks)
+      still_enabled = reject { |check| disabled_checks.all.include?(check.code_name) }
+
+      self.class.new((always_enabled + still_enabled).uniq)
+    end
   end
 end

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class MissingEnableComment < LiquidCheck
+    severity :error
+
+    # Don't allow this check to be disabled with a comment,
+    # as we need to be able to check for disabled checks.
+    can_disable false
+
+    def on_document(_node)
+      @disabled_checks = DisabledChecks.new
+    end
+
+    def on_comment(node)
+      @disabled_checks.update(node)
+    end
+
+    def after_document(node)
+      return if @disabled_checks.full_document_disabled?
+      return unless @disabled_checks.any?
+
+      message = if @disabled_checks.all_disabled?
+        "All checks were"
+      else
+        @disabled_checks.all.join(', ') + " " + (@disabled_checks.all.size == 1 ? "was" : "were")
+      end
+
+      add_offense("#{message} disabled but not re-enabled with theme-check-enable", node: node)
+    end
+  end
+end

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when trying to use parser-blocking script tags
+  class ParserBlockingJavaScript < LiquidCheck
+    severity :error
+    category :liquid
+
+    PARSER_BLOCKING_SCRIPT_TAG = %r{
+      <script                                    # Find the start of a script tag
+      (?=(?:[^>]|\n|\r)+?src=)+?                 # Make sure src= is in the script with a lookahead
+      (?:(?!defer|async|type=["']module['"]).)*? # Find tags that don't have defer|async|type="module"
+      >
+    }xim
+    SCRIPT_TAG_FILTER = /\{\{[^}]+script_tag\s+\}\}/
+
+    def on_document(node)
+      @source = node.template.source
+      @node = node
+      record_offenses
+    end
+
+    private
+
+    def record_offenses
+      record_offenses_from_regex(
+        message: "Missing async or defer attribute on script tag",
+        regex: PARSER_BLOCKING_SCRIPT_TAG,
+      )
+      record_offenses_from_regex(
+        message: "The script_tag filter is parser-blocking. Use a script tag with the async or defer attribute for better performance",
+        regex: SCRIPT_TAG_FILTER,
+      )
+    end
+
+    # The trickiness here is matching on scripts that are defined on
+    # multiple lines (or repeat matches). This makes the line_number
+    # calculation a bit weird. So instead, we traverse the string in
+    # a very imperative way.
+    def record_offenses_from_regex(regex: nil, message: nil)
+      i = 0
+      while (i = @source.index(regex, i))
+        script = @source.match(regex, i)[0]
+
+        add_offense(
+          message,
+          node: @node,
+          markup: script,
+          line_number: @source[0...i].count("\n") + 1
+        )
+
+        i += script.size
+      end
+    end
+  end
+end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -11,6 +11,7 @@ module ThemeCheck
 
     def on_node(node)
       return unless node.markup
+      return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk|
         chunk.scan(/([,:])  +/) do |_match|

data/lib/theme_check/checks/template_length.rb

@@ -4,12 +4,20 @@ module ThemeCheck
     severity :suggestion
     category :liquid
 
-    def initialize(max_length: 200)
+    def initialize(max_length: 200, exclude_schema: true)
       @max_length = max_length
+      @exclude_schema = exclude_schema
+      @excluded_lines = 0
     end
 
-    def on_document(node)
-      lines = node.template.source.count("\n")
+    def on_schema(node)
+      if @exclude_schema
+        @excluded_lines += node.value.nodelist.join.count("\n")
+      end
+    end
+
+    def after_document(node)
+      lines = node.template.source.count("\n") - @excluded_lines
       if lines > @max_length
         add_offense("Template has too many lines [#{lines}/#{@max_length}]", template: node.template)
       end

data/lib/theme_check/checks/undefined_object.rb

@@ -95,11 +95,19 @@ module ThemeCheck
       all_global_objects = ThemeCheck::ShopifyLiquid::Object.labels
       all_global_objects.freeze
 
+      shopify_plus_objects = ThemeCheck::ShopifyLiquid::Object.plus_labels
+      shopify_plus_objects.freeze
+
       each_template do |(name, info)|
         if 'templates/customers/reset_password' == name
           # NOTE: `email` is exceptionally exposed as a theme object in
           #       the customers' reset password template
           check_object(info, all_global_objects + ['email'])
+        elsif 'layout/checkout' == name
+          # NOTE: Shopify Plus has exceptionally exposed objects in
+          #       the checkout template
+          # https://shopify.dev/docs/themes/theme-templates/checkout-liquid#optional-objects
+          check_object(info, all_global_objects + shopify_plus_objects)
         else
           check_object(info, all_global_objects)
         end