theme-check 1.2.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28cb25e47867151bea85360a9f07667f46ea30ad90285f16cc74e85370ad39d9
-  data.tar.gz: 2023811dad002a72f00e2c26562ff3e6b5f2f49c748d44968fd94d1f9e72300f
+  metadata.gz: 60f0635001a9f808d12b55e0328536911bde9ea36160bcf34a63f10114401d18
+  data.tar.gz: 78365fe98014904e058191934663b75d24701db8a2a2585edac2557192cec5d5
 SHA512:
-  metadata.gz: f3a5339873aea7a325cbc3f3715e9166b1f7734226e3d9ac7b400f048629a514f3eec5d559c77eaf70febacda35416b8332d8d1a6ebefa1d9a34f29474a4e41d
-  data.tar.gz: 19eec11d1eb86188fe170bce61f884072340d848e800b2bb2b344cddf3561d60594e4f066199b7f9157b54da81ce8afebc5e6db0f3dbfbc5fac208c95d2b5ed8
+  metadata.gz: 0520e083dac843ed6273ba17e0cb44ee0e9e2c412f85a81b176da8b0912a583ab262c0c25b0b580df9c53cabefca305dce468559efa6df786ff37b7583e7ecc4
+  data.tar.gz: 58b7483ad5935de781eddf850a73c88f04aadbae394416f901fa38e173b44b4af3717947fc72cc009c899866ce1d27cc3f6597d5de7dd7ea1ef6984393d71ff4

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

@@ -4,16 +4,16 @@ on: [push]
 
 jobs:
   test:
-    runs-on: macos-latest
+    runs-on: ${{ matrix.platform }}
 
     strategy:
       matrix:
+        platform: [ubuntu-latest, windows-latest]
         version:
           - 3.0.0
-          - 2.7.1
           - 2.6.6
 
-    name: Ruby ${{ matrix.version }}
+    name: Ruby ${{ matrix.platform }} ${{ matrix.version }}
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

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

data/CHANGELOG.md

@@ -1,4 +1,51 @@
 
+v1.5.1 / 2021-09-08
+===================
+
+  * Fix PaginationSize issue ([#429](https://github.com/shopify/theme-check/issues/429), [#428](https://github.com/shopify/theme-check/issues/428))
+
+v1.5.0 / 2021-09-07
+==================
+
+### Features
+
+  * Add [DeprecatedGlobalAppBlockType](docs/checks/deprecated_global_app_block_type.md) ([#402](https://github.com/shopify/theme-check/issues/402))
+
+### Fixes
+
+  * Add Windows CI
+  * Fix multiple Windows bugs ([#413](https://github.com/shopify/theme-check/issues/413), [#415](https://github.com/shopify/theme-check/issues/415))
+  * Fix pagination size as string bug in PaginationSize ([#417](https://github.com/shopify/theme-check/issues/417),  [#421](https://github.com/shopify/theme-check/issues/421))
+
+v1.4.0 / 2021-08-30
+==================
+
+  * Add new object drop: `predictive_search`
+  * Bump `TemplateLength` `max_length` default
+  * Fix `RemoteAsset` incorrectly firing on structured data elements [#393](https://github.com/Shopify/theme-check/issues/393)
+  * Fix document links not working on open
+  * Fix `asset_url` document links
+  * Use better heuristics for `DeprecateLazysizes`
+  * Add support for `section` document links
+  * Add support for `include` document links
+  * Automatically creates the default translation file (`locales/en.default.json`) if it doesn't already exist.
+
+v1.3.0 / 2021-08-26
+==================
+
+  * Add `--output json` option for the CLI ([#392](https://github.com/shopify/theme-check/issues/392))
+  * Add PaginationSize check ([#359](https://github.com/shopify/theme-check/issues/359))
+  * Add ConvertIncludeToRender auto corrector ([#341](https://github.com/shopify/theme-check/issues/341))
+  * Add MissingTemplate auto corrector ([#388](https://github.com/shopify/theme-check/issues/388))
+  * Add `MissingTemplate` `ignore_missing` option ([#394](https://github.com/shopify/theme-check/issues/394))
+  * Fix Windows duplicate .bat file problem ([#400](https://github.com/shopify/theme-check/issues/400))
+  * Fix substring highlighting inside nodes ([#386](https://github.com/shopify/theme-check/issues/386))
+  * Add check for forbidden tags in theme app extension blocks ([#383](https://github.com/shopify/theme-check/issues/383))
+  * Improve HTML parsing of liquid attributes ([#381](https://github.com/shopify/theme-check/issues/381))
+  * Handle escaped file URIs in language server ([#360](https://github.com/shopify/theme-check/issues/360)) ([#382](https://github.com/shopify/theme-check/issues/382))
+  * Change asset size errors into suggestions ([#378](https://github.com/shopify/theme-check/issues/378))
+  * Switch to nokogiri 1.12, since it includes html5 support directly now ([#391](https://github.com/shopify/theme-check/issues/391))
+
 v1.2.0 / 2021-07-15
 ==================
 

data/CONTRIBUTING.md

@@ -31,7 +31,7 @@ bundle exec rake
 ## Checking a theme
 
 ```
-bundle exec theme-check /path/to/your/theme
+bin/theme-check /path/to/your/theme
 ```
 
 ## Creating a new "Check"
@@ -65,3 +65,61 @@ MyNewCheckName:
   ignore: []
   muffin_mode: true
 ```
+
+## Debugging
+
+A couple of things are turned on when the `THEME_CHECK_DEBUG` environment variable is set.
+
+1. The check timeout is turned off. This means you can add `binding.pry` in tests and properly debug with `bundle exec rake tests:in_memory`
+2. The `--profile` flag appears. You can now create Flamegraphs to inspect performance.
+
+```
+export THEME_CHECK_DEBUG=true
+
+# The following will behave slightly differently
+bin/theme-check ../dawn
+bundle exec rake tests:in_memory
+
+# The following becomes available
+bin/theme-check --profile ../dawn
+
+# The LanguageServer will log the JSONRPC calls to STDERR
+bin/theme-check-language-server
+```
+
+### Profiling
+
+`ruby-prof` and `ruby-prof-flamegraph` are both included as development dependencies.
+
+#### Flamegraph
+
+With the `--profile` flag, you can run theme-check on a theme and the `ruby-prof-flamegraph` printer will output profiling information in a format [Flamegraph](/brendangregg/FlameGraph) understands.
+
+
+**Setup:** 
+
+```bash
+# clone the FlameGraph repo somewhere
+git clone https://github.com/brendangregg/FlameGraph.git
+
+# the flamegraph.pl perl script is in that repo
+alias flamegraph=/path/to/FlameGraph/flamegraph.pl
+```
+
+**Profiling:**
+
+```
+# run theme-check with --profile
+# pass the output to flamegraph
+# dump the output into an svg file
+bin/theme-check --profile ../dawn \
+  | flamegraph --countname=ms --width=1750 \
+  > /tmp/fg.svg
+
+# open the svg file in Chrome to look at the flamegraph
+chrome /tmp/fg.svg
+```
+
+What you'll see is an interactive version of the following image:
+
+![flamegraph](docs/flamegraph.svg)

data/Gemfile

@@ -19,6 +19,9 @@ end
 group :development do
   gem 'guard'
   gem 'guard-minitest'
+  gem 'ruby-prof'
+  gem 'ruby-prof-flamegraph'
+  gem 'solargraph'
 end
 
 gem 'rubocop', '~> 1.12.0', require: false

data/bin/theme-check

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'theme-check' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("theme-check", "theme-check")

data/bin/theme-check-language-server

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'theme-check-language-server' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("theme-check", "theme-check-language-server")

data/config/default.yml

@@ -23,6 +23,7 @@ LiquidTag:
 MissingTemplate:
   enabled: true
   ignore: []
+  ignore_missing: []
 
 NestedSnippet:
   enabled: true
@@ -44,7 +45,7 @@ SyntaxError:
 TemplateLength:
   enabled: true
   ignore: []
-  max_length: 500
+  max_length: 600
   # Exclude content of {% schema %} in line count
   exclude_schema: true
   # Exclude content of {% stylesheet %} in line count
@@ -177,3 +178,16 @@ AssetSizeAppBlockCSS:
   enabled: false
   ignore: []
   threshold_in_bytes: 100_000
+
+AppBlockValidTags:
+  enabled: false
+  ignore: []
+
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50
+
+DeprecatedGlobalAppBlockType:
+  enabled: true

data/config/theme_app_extension.yml

@@ -23,6 +23,7 @@ LiquidTag:
 MissingTemplate:
   enabled: true
   ignore: []
+  ignore_missing: []
 
 NestedSnippet:
   enabled: true
@@ -110,11 +111,13 @@ ParserBlockingScriptTag:
 
 AssetSizeJavaScript:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 10_000
 
 AssetSizeCSS:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 100_000
 
@@ -144,10 +147,22 @@ HtmlParsingError:
 
 AssetSizeAppBlockJavaScript:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 10_000
 
 AssetSizeAppBlockCSS:
   enabled: true
+  severity: suggestion
   ignore: []
   threshold_in_bytes: 100_000
+
+AppBlockValidTags:
+  enabled: true
+  ignore: []
+
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50

data/data/shopify_liquid/objects.yml

@@ -54,6 +54,7 @@
 - part
 - policy
 - powered_by_link
+- predictive_search 
 - product
 - product_option
 - product_variant

data/docs/checks/app_block_valid_tags.md

@@ -0,0 +1,40 @@
+# Reject Forbidden Tags from Theme App Extension Blocks (`AppBlockValidTags`)
+
+This rule exists to prevent theme app extension blocks from containing forbidden tags in their liquid code.
+
+## Check Details
+
+This rule verifies none of the below tags are used in theme app extension blocks.
+
+- `{% javascript %}`
+- `{% stylesheet %}`
+- `{% include 'foo' %}`
+- `{% layout 'foo' %}`
+- `{% section 'foo' %}`
+
+:-1: **Incorrect** code for this check occurs with the use of any of the above tags in the liquid code of theme app extension blocks.
+
+## Check Options
+
+The default configuration for theme app extensions is the following:
+
+```yaml
+AppBlockValidTags:
+  enabled: true
+```
+
+## When Not To Use It
+
+This rule should not be disabled locally.
+
+## Version
+
+This check has been introduced in 1.3.0
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/app_block_valid_tags.rb
+[docsource]: /docs/checks/app_block_valid_tags.md

data/docs/checks/asset_size_app_block_css.md

@@ -23,7 +23,7 @@ The default configuration is the following:
 
 ```yaml
 AssetSizeAppBlockCSS:
-  enabled: false
+  enabled: true
   threshold_in_bytes: 100_000
 ```
 

data/docs/checks/deprecate_lazysizes.md

@@ -10,9 +10,6 @@ This check is aimed at discouraging the use of the lazysizes JavaScript library
 
 ```liquid
 
-<!-- Reports use of "lazyload" class -->
-<img src="a.jpg" class="lazyload">
-
 <!-- Reports use of "data-srcset" and "data-sizes" attribute. Reports data-sizes="auto" -->
 <img
   alt="House by the lake"

data/docs/checks/deprecated_global_app_block_type.md

@@ -0,0 +1,65 @@
+# Check for deprecated global app block type `@global`
+This check makes sure theme sections are not using [deprecated (`@global`)][change_log] global app block type.
+
+## Check Details
+In order for theme sections to [support app blocks][support_app_blocks_in_theme_section], sections need to define a block of type `@app`. This check makes sure that theme sections are not using the deprecated (`@global`) global app block type in theme sections.
+
+:-1: Example of **incorrect** theme section for this check:
+```
+{% for block in section.blocks %}
+  {% if block.type = "@global" %}
+    {% render block %}
+  {% endif %}
+{% endfor %}
+
+{% schema %}
+{
+  "name": "Product section",
+  "blocks": [{"type": "@global"}]
+}
+{% endschema %}
+```
+
+:+1: Examples of **correct** theme section for this check:
+```
+{% for block in section.blocks %}
+  {% if block.type = "@app" %}
+    {% render block %}
+  {% endif %}
+{% endfor %}
+
+{% schema %}
+{
+  "name": "Product section",
+  "blocks": [{"type": "@app"}]
+}
+{% endschema %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+DeprecatedGlobalAppBlockType:
+  enabled: true
+```
+
+## When Not To Use It
+
+It is discouraged to disable this check.
+
+## Version
+
+This check has been introduced in Theme Check 1.5.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/deprecated_global_app_block_type.rb
+[docsource]: /docs/checks/deprecated_global_app_block_type.md
+[remote_asset]: /docs/checks/deprecated_global_app_block_type.md
+[support_app_blocks_in_theme_section]: https://shopify.dev/themes/migration#step-8-add-support-for-app-blocks-to-sections
+[change_log]: https://shopify.dev/changelog/removing-the-global-block-type-in-favour-of-the-app-block-type-in-theme-sections