theme-check 0.7.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b516a7041c1025cd22bcbb4cab685b45893b38fa41ab55b539efad60cf67e100
-  data.tar.gz: 86d5d5054247c0c86b4a31b066a579fc60fbcf4f0d32940354c4fc9793667498
+  metadata.gz: fc820b814467926919858c11517a275e70dd07aea017285f315dc3309e4b49a3
+  data.tar.gz: 949c2934821bb7270aa466c3430d8fb640e8af938fb239aa1a2a346c82580a50
 SHA512:
-  metadata.gz: b76463ad9ecab829705519f163745fdd7cb6dea084558983c914dd3ddf923385050da1c535ad73f48a4442dd8a67bc797fd072e293aa85befb15a141870196db
-  data.tar.gz: 67571132dcf7fd556c81d4eb7f7e15c8db6c7ccee70384bb6654915090d5c8c213dbbee9b9b36acd74f0cac02390630defe7c1de1956f41f61c9d30294cdd4a0
+  metadata.gz: 699907617f0401cd5737c7f774b7063fae97f17465a8ac06ad1e404992b969923e4de6ff877c5f85fb951a8af1433ac017ab651465132b69d6143ff77baa5495
+  data.tar.gz: 93d69bd9b50561cc0f10940f4b5e7c5b19fcef43d105d0896b4ae484a3df13301cfc51f6470dff4b83b1e3410a3736f54d5097dca9a80763fa7c4790f1761018

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

@@ -15,6 +15,7 @@ jobs:
         version:
           - 3.0.0
           - 2.7.1
+          - 2.6.6
 
     name: Ruby ${{ matrix.version }}
 

data/.rubocop.yml

@@ -7,7 +7,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.6
   Exclude:
     - 'vendor/bundle/**/*'
     - 'packaging/builds/**/*'

data/CHANGELOG.md

@@ -1,4 +1,37 @@
 
+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
+==================
+
+  * Add consistent spacing around the pipe character (`|`) in variable expressions to the `SpaceInsideBrace` check ([#73](https://github.com/shopify/theme-check/issues/73))
+  * Add ReCaptcha system translation ([#265](https://github.com/shopify/theme-check/issues/265))
+  * Fix document links in `{% liquid %}` tags ([#263](https://github.com/shopify/theme-check/issues/263))
+  * Fix theme-check-disable for checks based on regular expressions ([#242](https://github.com/shopify/theme-check/issues/242))
+  * Fix VS Code crash on new window ([#264](https://github.com/shopify/theme-check/issues/264))
+  * Rescue errors thrown by remote_asset_file
+
+0.8.0 / 2021-04-13
+==================
+
+ * Set minimal Ruby version to 2.6
+
+0.7.3 / 2021-04-13
+==================
+
+  * Refactor CLI option parsing
+
 0.7.2 / 2021-04-12
 ==================
 

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

@@ -17,7 +17,7 @@ MissingTemplate:
 
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  max_nesting_level: 3
 
 RequiredLayoutThemeObject:
   enabled: true

data/data/shopify_liquid/tags.yml

@@ -8,6 +8,8 @@
 - cycle
 - decrement
 - echo
+- else
+- elsif
 - for
 - form
 - if
@@ -25,3 +27,4 @@
 - stylesheet
 - tablerow
 - unless
+- when

data/data/shopify_translation_keys.yml

@@ -848,3 +848,4 @@
 - shopify.store_availability.pick_up_time.two_to_four_hours
 - shopify.store_availability.pick_up_time.immediately
 - shopify.store_availability.pick_up_time.next_day
+- shopify.online_store.spam_detection.disclaimer_html

data/dev.yml

@@ -3,7 +3,7 @@ name: theme-check
 type: ruby
 
 up:
-  - ruby: 2.7.1
+  - ruby: 2.6.6
   - bundler
 
 commands:

data/docs/checks/nested_snippet.md

@@ -45,7 +45,7 @@ The default configuration for this check is the following:
 ```yaml
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  max_nesting_level: 3
 ```
 
 ### `max_nesting_level`

data/docs/checks/space_inside_braces.md

@@ -17,6 +17,14 @@ This check is aimed at eliminating ugly Liquid:
 <!-- After commas and semicolons -->
 {% form 'type',  object, key:value %}
 {% endform %}
+
+<!-- Arround filter pipelines -->
+{{ url  | asset_url | img_tag }}
+{% assign my_upcase_string = "Hello world"| upcase %}
+
+<!-- Arround symbol operators -->
+{%- if target  == product and product.price_varies -%}
+{%- if product.featured_media.width >=165 -%}
 ```
 
 :+1: Examples of **correct** code for this check:
@@ -33,6 +41,10 @@ This check is aimed at eliminating ugly Liquid:
   media_size: section.settings.product_recommendations_image_ratio,
   center_align_text: section.settings.center_align_text
 %}
+{{ url | asset_url | img_tag }}
+{% assign my_upcase_string = "Hello world" | upcase %}
+{%- if target == product and product.price_varies -%}
+{%- if product.featured_media.width >= 165 -%}
 ```
 
 ## Check Options
@@ -44,6 +56,22 @@ SpaceInsideBraces:
   enabled: true
 ```
 
+## Auto-correction
+
+This check can automatically trim or add spaces around `{{ ... }}`.
+
+```liquid
+{{ x}}
+{{x}}
+{{  x  }}
+```
+
+Can all be auto-corrected with the `--auto-correct` option to:
+
+```liquid
+{{ x }}
+```
+
 ## When Not To Use It
 
 If you don't care about the look of your code.

data/exe/theme-check

@@ -3,4 +3,4 @@
 
 require "theme_check"
 
-ThemeCheck::Cli.new.run!(ARGV)
+ThemeCheck::Cli.parse_and_run(ARGV)

data/lib/theme_check.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 require "liquid"
 
+require_relative "theme_check/bug"
+require_relative "theme_check/exceptions"
 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_check"
 require_relative "theme_check/disabled_checks"
 require_relative "theme_check/liquid_check"
 require_relative "theme_check/locale_diff"
@@ -14,6 +17,8 @@ require_relative "theme_check/regex_helpers"
 require_relative "theme_check/json_check"
 require_relative "theme_check/json_file"
 require_relative "theme_check/json_helpers"
+require_relative "theme_check/position_helper"
+require_relative "theme_check/position"
 require_relative "theme_check/language_server"
 require_relative "theme_check/checks"
 require_relative "theme_check/config"

data/lib/theme_check/analyzer.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Analyzer
-    attr_reader :offenses
-
     def initialize(theme, checks = Check.all.map(&:new), auto_correct = false)
       @theme = theme
-      @offenses = []
       @auto_correct = auto_correct
 
       @liquid_checks = Checks.new
@@ -13,7 +10,6 @@ module ThemeCheck
 
       checks.each do |check|
         check.theme = @theme
-        check.offenses = @offenses
 
         case check
         when LiquidCheck
@@ -26,26 +22,40 @@ module ThemeCheck
       @visitor = Visitor.new(@liquid_checks)
     end
 
+    def offenses
+      @liquid_checks.flat_map(&:offenses) + @json_checks.flat_map(&:offenses)
+    end
+
+    def offenses_clear!
+      @liquid_checks.each do |check|
+        check.offenses.clear
+      end
+
+      @json_checks.each do |check|
+        check.offenses.clear
+      end
+    end
+
     def analyze_theme
-      @offenses.clear
+      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
+      offenses
     end
 
     def uncorrectable_offenses
       unless @auto_correct
-        return @offenses
+        return offenses
       end
 
-      @offenses.select { |offense| !offense.correctable? }
+      offenses.select { |offense| !offense.correctable? }
     end
 
     def correct_offenses
       if @auto_correct
-        @offenses.each(&:correct)
+        offenses.each(&:correct)
         @theme.liquid.each(&:write)
       end
     end

data/lib/theme_check/bug.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'theme_check/version'
+
+module ThemeCheck
+  BUG_POSTAMBLE = <<~EOS
+    Theme Check Version: #{VERSION}
+    Ruby Version: #{RUBY_VERSION}
+    Platform: #{RUBY_PLATFORM}
+    Muffin mode: activated
+
+    ------------------------
+    Whoops! It looks like you found a bug in Theme Check.
+    Please report it at https://github.com/Shopify/theme-check/issues, and include the message above.
+    Or cross your fingers real hard, and try again.
+  EOS
+
+  def self.bug(message)
+    abort(message + BUG_POSTAMBLE)
+  end
+end

data/lib/theme_check/check.rb

@@ -6,8 +6,8 @@ module ThemeCheck
     include JsonHelpers
 
     attr_accessor :theme
-    attr_accessor :offenses
     attr_accessor :options
+    attr_writer :offenses
 
     SEVERITIES = [
       :error,
@@ -69,6 +69,10 @@ module ThemeCheck
       end
     end
 
+    def offenses
+      @offenses ||= []
+    end
+
     def severity
       self.class.severity
     end

data/lib/theme_check/checks.rb

@@ -1,22 +1,53 @@
 # frozen_string_literal: true
+require "pp"
+require "timeout"
+
 module ThemeCheck
   class Checks < Array
+    CHECK_METHOD_TIMEOUT = 5 # sec
+
     def call(method, *args)
       each do |check|
-        if check.respond_to?(method) && !check.ignored?
-          check.send(method, *args)
-        end
+        call_check_method(check, method, *args)
       end
     end
 
-    def always_enabled
-      self.class.new(reject(&:can_disable?))
+    def disableable
+      self.class.new(select(&:can_disable?))
     end
 
-    def except_for(disabled_checks)
-      still_enabled = reject { |check| disabled_checks.all.include?(check.code_name) }
+    private
+
+    def call_check_method(check, method, *args)
+      return unless check.respond_to?(method) && !check.ignored?
+
+      Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+        check.send(method, *args)
+      end
+    rescue Liquid::Error
+      # Pass-through Liquid errors
+      raise
+    rescue => e
+      node = args.first
+      template = node.respond_to?(:template) ? node.template.relative_path : "?"
+      markup = node.respond_to?(:markup) ? node.markup : ""
+      node_class = node.respond_to?(:value) ? node.value.class : "?"
+
+      ThemeCheck.bug(<<~EOS)
+        Exception while running `#{check.code_name}##{method}`:
+        ```
+        #{e.class}: #{e.message}
+          #{e.backtrace.join("\n  ")}
+        ```
 
-      self.class.new((always_enabled + still_enabled).uniq)
+        Template: `#{template}`
+        Node: `#{node_class}`
+        Markup:
+        ```
+        #{markup}
+        ```
+        Check options: `#{check.options.pretty_inspect}`
+      EOS
     end
   end
 end

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -17,13 +17,13 @@ module ThemeCheck
     end
 
     def after_document(node)
-      return if @disabled_checks.full_document_disabled?
-      return unless @disabled_checks.any?
+      checks_missing_end_index = @disabled_checks.checks_missing_end_index
+      return if checks_missing_end_index.empty?
 
-      message = if @disabled_checks.all_disabled?
+      message = if checks_missing_end_index.any? { |name| name == :all }
         "All checks were"
       else
-        @disabled_checks.all.join(', ') + " " + (@disabled_checks.all.size == 1 ? "was" : "were")
+        checks_missing_end_index.join(', ') + " " + (checks_missing_end_index.size == 1 ? "was" : "were")
       end
 
       add_offense("#{message} disabled but not re-enabled with theme-check-enable", node: node)

data/lib/theme_check/checks/nested_snippet.rb

@@ -20,7 +20,7 @@ module ThemeCheck
       end
     end
 
-    def initialize(max_nesting_level: 2)
+    def initialize(max_nesting_level: 3)
       @max_nesting_level = max_nesting_level
       @templates = {}
     end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -15,12 +15,18 @@ module ThemeCheck
       return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk|
-        chunk.scan(/([,:])  +/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
           add_offense("Too many spaces after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
         end
-        chunk.scan(/([,:])\S/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
           add_offense("Space missing after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
         end
+        chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+          add_offense("Too many spaces before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+        end
+        chunk.scan(/(\A|\S)(?<match>\||==|<>|<=|>=|<|\b>|!=)/) do |_match|
+          add_offense("Space missing before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+        end
       end
     end
 

data/lib/theme_check/cli.rb

@@ -1,85 +1,104 @@
 # frozen_string_literal: true
+require "optparse"
+
 module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
-    USAGE = <<~END
-      Usage: theme-check [options] /path/to/your/theme
-
-      Basic Options:
-        -C, --config <path>                  Use the config provided, overriding .theme-check.yml if present
-        -c, --category <category>            Only run this category of checks
-        -x, --exclude-category  <category>   Exclude this category of checks
-        -a, --auto-correct                   Automatically fix offenses
-
-      Miscellaneous:
-        --init                               Generate a .theme-check.yml file
-        --print-config                       Output active config to STDOUT
-        -h, --help                           Show this. Hi!
-        -l, --list                           List enabled checks
-        -v, --version                        Print Theme Check version
-
-      Description:
-        Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
-        Liquid & JSON inside your theme.
-
-        You can configure checks in the .theme-check.yml file of your theme root directory.
-    END
+    attr_accessor :path
 
-    def run(argv)
+    def initialize
       @path = "."
+      @command = :check
+      @only_categories = []
+      @exclude_categories = []
+      @auto_correct = false
+      @config_path = nil
+    end
 
-      command = :check
-      only_categories = []
-      exclude_categories = []
-      auto_correct = false
-      config_path = nil
-
-      args = argv.dup
-      while (arg = args.shift)
-        case arg
-        when "--help", "-h"
-          raise Abort, USAGE
-        when "--version", "-v"
-          command = :version
-        when "--config", "-C"
-          config_path = Pathname.new(args.shift)
-        when "--category", "-c"
-          only_categories << args.shift.to_sym
-        when "--exclude-category", "-x"
-          exclude_categories << args.shift.to_sym
-        when "--list", "-l"
-          command = :list
-        when "--auto-correct", "-a"
-          auto_correct = true
-        when "--init"
-          command = :init
-        when "--print"
-          command = :print
-        else
-          @path = arg
-        end
-      end
+    def option_parser(parser = OptionParser.new, help: true)
+      return @option_parser if defined?(@option_parser)
+      @option_parser = parser
+      @option_parser.banner = "Usage: theme-check [options] [/path/to/your/theme]"
+
+      @option_parser.separator("")
+      @option_parser.separator("Basic Options:")
+      @option_parser.on(
+        "-C", "--config PATH",
+        "Use the config provided, overriding .theme-check.yml if present"
+      ) { |path| @config_path = path }
+      @option_parser.on(
+        "-c", "--category CATEGORY",
+        "Only run this category of checks"
+      ) { |category| @only_categories << category.to_sym }
+      @option_parser.on(
+        "-x", "--exclude-category CATEGORY",
+        "Exclude this category of checks"
+      ) { |category| @exclude_categories << category.to_sym }
+      @option_parser.on(
+        "-a", "--auto-correct",
+        "Automatically fix offenses"
+      ) { @auto_correct = true }
+
+      @option_parser.separator("")
+      @option_parser.separator("Miscellaneous:")
+      @option_parser.on(
+        "--init",
+        "Generate a .theme-check.yml file"
+      ) { @command = :init }
+      @option_parser.on(
+        "--print",
+        "Output active config to STDOUT"
+      ) { @command = :print }
+      @option_parser.on(
+        "-h", "--help",
+        "Show this. Hi!"
+      ) { @command = :help } if help
+      @option_parser.on(
+        "-l", "--list",
+        "List enabled checks"
+      ) { @command = :list }
+      @option_parser.on(
+        "-v", "--version",
+        "Print Theme Check version"
+      ) { @command = :version }
+
+      @option_parser.separator("")
+      @option_parser.separator(<<~EOS)
+        Description:
+            Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
+            Liquid & JSON inside your theme.
+
+            You can configure checks in the .theme-check.yml file of your theme root directory.
+      EOS
+
+      @option_parser
+    end
+
+    def parse(argv)
+      @path = option_parser.parse(argv).first || "."
+    end
 
-      unless [:version, :init].include?(command)
-        @config = if config_path
+    def run!
+      unless [:version, :init, :help].include?(@command)
+        @config = if @config_path
           ThemeCheck::Config.new(
             root: @path,
-            configuration: ThemeCheck::Config.load_file(config_path)
+            configuration: ThemeCheck::Config.load_file(@config_path)
           )
         else
           ThemeCheck::Config.from_path(@path)
         end
-        @config.only_categories = only_categories
-        @config.exclude_categories = exclude_categories
-        @config.auto_correct = auto_correct
+        @config.only_categories = @only_categories
+        @config.exclude_categories = @exclude_categories
+        @config.auto_correct = @auto_correct
       end
 
-      send(command)
+      send(@command)
     end
 
-    def run!(argv)
-      run(argv)
+    def run
+      run!
     rescue Abort => e
       if e.message.empty?
         exit(1)
@@ -88,6 +107,18 @@ module ThemeCheck
       end
     end
 
+    def self.parse_and_run!(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run!
+    end
+
+    def self.parse_and_run(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run
+    end
+
     def list
       puts @config.enabled_checks
     end
@@ -111,12 +142,16 @@ module ThemeCheck
       puts YAML.dump(@config.to_h)
     end
 
+    def help
+      puts option_parser.to_s
+    end
+
     def check
       puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
-        raise Abort, "No templates found.\n#{USAGE}"
+        raise Abort, "No templates found."
       end
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme