theme-check 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 037f9fd0dba35bf611162475709aef96e0e24c8e63b18eac3ad20b4d65d37255
-  data.tar.gz: b856c24c2135a805c91c230d1c3a2e0dc178d4f0249faa77bb9a2c263993dbd2
+  metadata.gz: a07597b217b1f596cd5e777726950e396934726f3572bc7660129bec2b3b30c8
+  data.tar.gz: 80e54966286e332f3308021b9347feb4cdb683497991b9bb451dcf58f138a2df
 SHA512:
-  metadata.gz: 1f4cafab1d1a3adf53771682f0faf00b1a327dc3a358a60157a92a3c7625636ce38eb266a271d01891cae0786c0f4c38c35a3ed03cd34d1b9deb7bb86197ba41
-  data.tar.gz: cc0b7f5d9878c74b19a500d93cb873e0e17610134cb99fee832d1c31e20d6e6d805b494c44897e4d590d7b4c9bec99bb95b10b511d3fa0a13d7e1813035071a1
+  metadata.gz: 4c7a1c159dd1b688618c95e1e5fb943a133b606878f57c91b12e5793b07022325c5cfb2e81c49cb45ea484cb3688c6f7c2b75af1b2a50f13da6db2ba0e8b0bb3
+  data.tar.gz: 83fe6a74375ecf2b58f14681c99bc672a710cd6bbc70cb5f58ff06332d4123171544f6cf73c6e7f5f750c1a870d17de0ce3bd3e1f9cbfca6e1bdc7fceb767b80

data/.gitignore

@@ -11,3 +11,4 @@
 Gemfile.lock
 
 .rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml
+packaging/builds

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

@@ -30,13 +30,32 @@ 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)).
 
+## Requirements
+
+- Ruby 2.7+
+
 ## Installation
 
+Theme Check is available through Homebrew _or_ RubyGems.
+
+**Homebrew**
+
+You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
+
+```sh
+brew tap shopify/shopify
+brew install theme-check
 ```
+
+**RubyGems**
+
+```sh
 gem install theme-check
 ```
 
@@ -61,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,46 @@ 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]
+
+namespace :package do
+  require 'theme_check/packager'
+
+  task all: [:homebrew]
+
+  desc("Builds a Homebrew package of the CLI")
+  task :homebrew do
+    ThemeCheck::Packager.new.build_homebrew
+  end
+end
+
+desc("Builds all distribution packages of the CLI")
+task(package: 'package:all')

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
@@ -61,3 +70,12 @@ UndefinedObject:
 
 RequiredDirectories:
   enabled: true
+
+DeprecatedFilter:
+  enabled: true
+
+MissingEnableComment:
+  enabled: true
+
+ParserBlockingJavaScript:
+  enabled: true

data/data/shopify_liquid/deprecated_filters.yml

@@ -0,0 +1,10 @@
+---
+Liquid::ColorFilter:
+  hex_to_rgba:
+    - color_to_rgb
+    - color_modify
+Liquid::UrlFilter:
+  collection_img_url:
+    - img_url
+  product_img_url:
+    - img_url

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,9 +18,13 @@ 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"
 require_relative "theme_check/visitor"
+require_relative "theme_check/corrector"
 
 Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }

data/lib/theme_check/analyzer.rb

@@ -3,9 +3,10 @@ module ThemeCheck
   class Analyzer
     attr_reader :offenses
 
-    def initialize(theme, checks = Check.all.map(&:new))
+    def initialize(theme, checks = Check.all.map(&:new), auto_correct = false)
       @theme = theme
       @offenses = []
+      @auto_correct = auto_correct
 
       @liquid_checks = Checks.new
       @json_checks = Checks.new
@@ -34,10 +35,19 @@ module ThemeCheck
       @offenses
     end
 
-    def analyze_file(path)
-      path = Pathname.new(path)
-      analyze_theme
-      @offenses.reject! { |offense| offense.template.path != path }
+    def uncorrectable_offenses
+      unless @auto_correct
+        return @offenses
+      end
+
+      @offenses.select { |offense| !offense.correctable? }
+    end
+
+    def correct_offenses
+      if @auto_correct
+        @offenses.each(&:correct)
+        @theme.liquid.each(&:write)
+      end
     end
   end
 end

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/deprecated_filter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class DeprecatedFilter < LiquidCheck
+    doc "https://shopify.dev/docs/themes/liquid/reference/filters/deprecated-filters"
+    category :liquid
+    severity :suggestion
+
+    def on_variable(node)
+      used_filters = node.value.filters.map { |name, *_rest| name }
+      used_filters.each do |filter|
+        alternatives = ShopifyLiquid::DeprecatedFilter.alternatives(filter)
+        next unless alternatives
+
+        alternatives = alternatives.map { |alt| "`#{alt}`" }
+        add_offense(
+          "Deprecated filter `#{filter}`, consider using an alternative: #{alternatives.join(', ')}",
+          node: node,
+        )
+      end
+    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/missing_required_template_files.rb

@@ -9,21 +9,21 @@ module ThemeCheck
     category :liquid
     doc "https://shopify.dev/docs/themes/theme-templates"
 
-    LAYOUT_FILENAME = "layout/theme"
-    REQUIRED_TEMPLATES_FILES = %w(index product collection cart blog article page list-collections search 404
-                                  gift_card customers/account customers/activate_account customers/addresses
-                                  customers/login customers/order customers/register customers/reset_password password)
+    REQUIRED_LIQUID_FILES = %w(layout/theme)
+    REQUIRED_TEMPLATE_FILES = %w(
+      index product collection cart blog article page list-collections search 404
+      gift_card customers/account customers/activate_account customers/addresses
+      customers/login customers/order customers/register customers/reset_password password
+    )
       .map { |file| "templates/#{file}" }
 
     def on_end
-      missing_files = (REQUIRED_TEMPLATES_FILES + [LAYOUT_FILENAME]) - theme.liquid.map(&:name)
-      missing_files.each { |file| add_missing_file_offense(file) }
-    end
-
-    private
-
-    def add_missing_file_offense(file)
-      add_offense("Theme is missing '#{file}.liquid' file")
+      (REQUIRED_LIQUID_FILES - theme.liquid.map(&:name)).each do |file|
+        add_offense("'#{file}.liquid' is missing")
+      end
+      (REQUIRED_TEMPLATE_FILES - (theme.liquid + theme.json).map(&:name)).each do |file|
+        add_offense("'#{file}.liquid' or '#{file}.json' is missing")
+      end
     end
   end
 end