theme-check 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e51f58be8347c6d602ef2f5f6385117f1c8ad5d07a66c111c8c8bf623008f3b1
-  data.tar.gz: 88eb1fbc392ff70251255f5aa681e6e7bf37fbc1c0a65bc1651e291c13baf5d9
+  metadata.gz: 31af33605da4e88e134907242224b4266afc76fede068c70a1ba6b8d84eb98cd
+  data.tar.gz: 80c7427113fd20c02c02d87d8f598d49182d460a8691e06dbaa954872c4f83c2
 SHA512:
-  metadata.gz: 0c7865cb5cb44da5811b78429d34c3309264ba21f55954a83b97784e15375798794461c0d19edfe620e8cbed45b6b8a80d63755b258505acb4c2b61bbae77e4a
-  data.tar.gz: 625963de20e85bc5b27989fba14a9a8243aafffc21aba5f4ea54b8e937fba05f73df99549a6b6b575dd29b7df48319c054aa2089e98c31e1e8212b1521c73c04
+  metadata.gz: 486f6280ef9521a7d35a8c4dce9e146b652514cb16def7b70845e2b93993710f2b61bd22dd448954ab1e44adc62b10c84b8e93ac3895dd92c4c1c42911341c83
+  data.tar.gz: '0171786d1c8bea48ba90a755cda22aea62da383b740b2cccc402dba210cc6d361a86704fe43617be2e489747bbb67a6614e4ab975d5fe2128e2f89da724a8ca3'

data/.gitignore

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

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   TargetRubyVersion: 2.7
   Exclude:
     - 'vendor/bundle/**/*'
+    - 'packaging/builds/**/*'
 
 Metrics/MethodLength:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+
+v0.3.2 / 2021-02-17
+==================
+
+  * Ignore snippets in UndefinedObject check
+
+v0.3.1 / 2021-02-16
+===================
+
+  * Fixup version flag
+
+v0.3.0 / 2021-02-16
+===================
+
+  * Add ParserBlockingJavaScript Check ([#78](https://github.com/Shopify/theme-check/issues/78), [#146](https://github.com/Shopify/theme-check/issues/146))
+  * Internal refactor to enable running theme-check in servers ([#145](https://github.com/Shopify/theme-check/issues/145), [#148](https://github.com/Shopify/theme-check/issues/148))
+  * Add -v, --version flag ([#126](https://github.com/Shopify/theme-check/issues/126))
+  * Exclude content of {% schema %} in line count for TemplateLength ([#140](https://github.com/Shopify/theme-check/issues/140))
+  * Fix Language Server removed files bug ([#136](https://github.com/Shopify/theme-check/issues/136))
+  * Add ignore config ([#147](https://github.com/Shopify/theme-check/issues/147))
+  * Add ability to disable checks with comments ([#79](https://github.com/Shopify/theme-check/issues/79))
+  * Adding checks for shopify plus objects in checkout ([#121](https://github.com/Shopify/theme-check/issues/121))
+
+v0.2.2 / 2021-01-22
+===================
+
+  * [Language Server] Send empty dianogstics to flush errors

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.rb ../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
@@ -57,7 +66,17 @@ MissingRequiredTemplateFiles:
   enabled: true
 
 UndefinedObject:
-  enabled: false
+  enabled: true
+  exclude_snippets: true
 
 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,14 @@ 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"
+require_relative "theme_check/version"
 
 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