theme-check 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc4aaf3260408a9b52d9afaa59662308f173a5d5dcd0f3663cbcc68da1d7f39
-  data.tar.gz: 50cd7e0d42fda99ad3816a846c25868c38b92ea521e0be759c515548dd82f70b
+  metadata.gz: 9bfe8af624c0fe355dedcf6036609fc1366196011af2207b8365c0bb3389f3f5
+  data.tar.gz: 526353e93c6d8bc3bb902b24d81084c581cecdbd0bd98e29d9c1fd95ff00aff3
 SHA512:
-  metadata.gz: 7ffad3310e441edd678143de233584a09167ffff1e09b96109cef417d360d797821dc9ef3491af4564608cd3b35aa59be41ebea6bb76030e1544d53bc9db8d02
-  data.tar.gz: 30b6d8f3b58b95c833a78bc30ceea6cfcfa35d563e3d184b6aee51817965be87b352c2dbad5ff67a74f2a64479fe1945c11db738c1bfb6e64f610ae15b862cb3
+  metadata.gz: 49b583b1bbfa5fb7a59370ec6d09e6b1099ecf3ffa22a6fc55cf099fe26ab682637bf3c943c54786b0a36b80b20501491bb9623255af3323901d33f7cdbb8897
+  data.tar.gz: 02ed21413f0d437a77a8859cd7a4df76d296e4bf51f88c4470c8b9f74c89fefe32431cbb2658159fecc48bc79bdf4762f1db00bf21f2ff78fa81c239b29d765e

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

@@ -1,23 +1,19 @@
 name: ThemeCheck
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+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
@@ -36,4 +32,4 @@ jobs:
       run: bundle exec rake
     - name: Test runtime
       # Testing that runtime can execute, not testing the results themselves
-      run: bundle exec theme-check ./test/theme | grep -q "files inspected"
+      run: bundle exec theme-check ./test/theme | grep -q "files inspected"

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,54 @@
 
+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
+==================
+
+  * Add Windows Support ([#364](https://github.com/shopify/theme-check/issues/364))
+  * Ignore empty `{{}}` in SpaceInsideBraces ([#350](https://github.com/shopify/theme-check/issues/350))
+  * Switch to main branch
+  * Minor documentation fixes
+
 v1.1.0 / 2021-07-06
 ==================
 

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"

data/RELEASING.md

@@ -13,7 +13,14 @@
 
 4. Commit your changes and make a PR.
 
-5. Merge your PR to master.
+   ```bash
+   git checkout -b "bump/theme-check-$VERSION"
+   git add docs/checks CHANGELOG.md lib/theme_check/version.rb
+   git commit -m "Bump theme-check version to $VERSION"
+   hub compare "main:bump/theme-check-$VERSION"
+   ```
+
+5. Merge your PR to main.
 
 6. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
 
@@ -46,5 +53,30 @@
 
    ```bash
    # shortcut if you have `hub` installed
-   hub compare "master:bump/theme-check-$VERSION"
+   hub compare "main:bump/theme-check-$VERSION"
+   ```
+
+## Shopify CLI Release Process
+
+1. Release `theme-check` on RubyGems by following the steps in the previous section.
+
+2. Update the `theme-check` version in [`shopify-cli`](https://github.com/shopify/shopify-cli)'s `Gemfile.lock` and `shopify-cli.gemspec` files.
+
+   Such as in [this PR.](https://github.com/Shopify/shopify-cli/pull/1357/files)
+
+3. Create a branch + a commit on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
+
+   ```bash
+   VERSION=X.X.X
+   git checkout -b "bump/theme-check-$VERSION"
+   git add Gemfile.lock
+   git add shopify-cli.gemspec
+   git commit -m "Bump theme-check version to $VERSION"
+   ```
+
+4. Create a pull-request for those changes on the [`shopify-cli`](https://github.com/Shopify/shopify-cli) repository.
+
+   ```bash
+   # shortcut if you have `hub` installed
+   hub compare "main:bump/theme-check-$VERSION"
    ```

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