theme-check 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c75935127b3ec2257d0e857c46b501a0c5189da619776202a2180234606c84ca
-  data.tar.gz: 3a54ffed715331b78f6ae3949b76466068539cd9fea4275e64f9f7a413ffd22b
+  metadata.gz: b841f4d2f809e07dec57140fd76f373e216f721903baa7ac1dce747b5ce77c82
+  data.tar.gz: b513333c296966cedb4d00345cb7ab1a3d4dcbb305b92b3eb96edc598867bba5
 SHA512:
-  metadata.gz: 2720180bf217fd64061f6ed4edc5ba01616fbb6ec6b30254638c992924719d179af0f2d72c4a1a1330c7b1e6a0ef9856aec4567aca73161a0cd2b59033fffcf4
-  data.tar.gz: c1d79dad05a55c374d4a2e008484d3c527f4483174e66ffb3c30ce96f65e8a2f03c6295de33130295b70bc63f3d3aed4dce2c7eac14de0347aa73fca599b062e
+  metadata.gz: 1d75dc49ae97db15d4622d6a59b7a12a0eab0de6a6bcf19e6e8bca3b7f6eb6f94c40c11cfcdb3ac911bbc4d93e6d08cfbb83e85de763d00cb60b6fab10bfc7bb
+  data.tar.gz: eb7c5fdb74551461de7fd643071734dc8b2442db4a5a80492b982bc392c67a100614e4a9fa3b4580e28c5f1b8321564adc8f9580618f3bcdbc36dfd4e4ab13e3

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,35 @@
 
+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
+==================
+
+  * Fixup bug in RemoteAsset causing Language Server to break
+
+0.7.1 / 2021-04-12
+==================
+
+  * Fix High CPU Bug in RemoteAsset check
+  * Fix document link for render tags that trim whitespace.
+
 0.7.0 / 2021-04-08
 ==================
 

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/space_inside_braces.md

@@ -17,6 +17,10 @@ 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 %}
 ```
 
 :+1: Examples of **correct** code for this check:
@@ -33,6 +37,8 @@ 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 %}
 ```
 
 ## Check Options

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,12 @@
 # frozen_string_literal: true
 require "liquid"
 
+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 +16,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/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

@@ -9,14 +9,8 @@ module ThemeCheck
       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)
+    def disableable
+      self.class.new(select(&:can_disable?))
     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/remote_asset.rb

@@ -24,7 +24,7 @@ module ThemeCheck
       'shopify_asset_url',
     ]
 
-    RESOURCE_TAG = /<(?<tag_name>img|script|link|source)#{HTML_ATTRIBUTES}>/oim
+    RESOURCE_TAG = %r{<(?<tag_name>img|script|link|source)#{HTML_ATTRIBUTES}/?>}oim
     RESOURCE_URL = /\s(?:src|href)=(?<resource_url>#{QUOTED_LIQUID_ATTRIBUTE})/oim
     ASSET_URL_FILTER = /[\|\s]*(#{ASSET_URL_FILTERS.join('|')})/omi
     PROTOCOL = %r{(https?:)?//}
@@ -76,6 +76,7 @@ module ThemeCheck
         next if url_hosted_by_shopify?(resource_url)
         next if resource_url =~ ABSOLUTE_PATH
         next if resource_url =~ RELATIVE_PATH
+        next if resource_url.empty?
 
         start = match.begin(0) + resource_match.begin(:resource_url)
         add_offense(

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(/([,:|])\S/) 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(?<pipe>\|)|\S(?<pipe>\|)/) do |_match|
+          add_offense("Space missing before '#{Regexp.last_match(:pipe)}'", node: node, markup: Regexp.last_match(:pipe))
+        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