theme-check 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b918e53777cfb70c65dacd9d9bfbdb6f4463597c8f9c81969e1baef89df7a1
-  data.tar.gz: 7e45af9a3dfeab1eafdff5533df68a9e0d67007d94661a2c974c0c2fece61095
+  metadata.gz: e154c11ed7f84b968edac05c97afb2611e816933d790347cdbdca63071d46e88
+  data.tar.gz: dd8fc72c420412ab3adfad64f3d11197f562904bd0171289debe8e440ca34c86
 SHA512:
-  metadata.gz: ea1b75ca11a66aefe5eef421f577d53716cb180799863185d36fad21a9033b5cf52579df3e593e41867513da410adc7d16de723f35b3a5435e50098b7af2a348
-  data.tar.gz: ceab091f6bf7317d899cb5459601b7dfb5294e6e4be962a421b33bad33c74fd730001dea90687f81f754d57e5cdedc5b39d0efb5d95d6c016ed965f7e4e86a9f
+  metadata.gz: 0315a3eb75f5cda96fe2be02d7533e07aa364fc7b3e08bdb2682edf50f30d13bc2c03099d015c73db2e1c6e7d06c90707068d596db044176ddcdaea4bfe3a65c
+  data.tar.gz: a7050df945829d05a0440464d0ac309d3cc55d9fdd9909259b95f2405beae746e799aad8beeb564508b0a543568dcd718edb9638c1307bb345051784818ea165

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

@@ -1,10 +1,6 @@
 name: ThemeCheck
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push]
 
 jobs:
   test:
@@ -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/CHANGELOG.md

@@ -1,4 +1,54 @@
 
+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
+==================
+
+  * Add `--fail-level` CLI flag to configure exit code
+  * Refactor all theme file classes to inherit from `ThemeFile`
+  * Fix `undefined method liquid?` error when scanning from LSP
+  * Adding asset document links
+  * Allow initializing theme app extension configuration files
+  * Allow disabling registering mock Liquid tags w/ `ThemeCheck::Tags.register_tags = false`
+  * Support Theme App Extensions
+  * Add checks for theme app extension block JS/CSS
+  * Disable Liquid::C when parsing Liquid templates
+
 v1.0.0 / 2021-06-28
 ==================
 

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

@@ -100,6 +100,8 @@ TemplateLength:
   # Or ignore certain paths
   ignore:
     - snippets/icon-*
+  # Or change the severity (error|suggestion|style)
+  severity: suggestion
 
 # Enable a custom check
 MyCustomCheck
@@ -141,3 +143,40 @@ Disable checks for the _entire document_ by placing the comment on the first lin
 
 {%assign x = 1%}
 ```
+
+## Exit Code and `--fail-level`
+
+Use the `--fail-level` (default: `error`) flag to configure the exit code of theme-check. Useful in CI scenarios.
+
+Example:
+
+```
+# Make CI fail on styles warnings, suggestions, and errors
+theme-check --fail-level style path_to_theme
+
+# Make CI fail on suggestions, and errors
+theme-check --fail-level suggestion path_to_theme
+
+# Make CI fail on errors
+theme-check path_to_theme
+```
+
+There are three fail levels:
+
+- `error`
+- `suggestion`
+- `style`
+
+Exit code meanings:
+
+- 0: Success!
+- 1: Your code doesn't pass the checks
+- 2: There's a bug in theme-check
+
+If you would like to change the severity of a check, you can do so with the `severity` attribute. Example:
+
+```yaml
+DeprecateLazysizes:
+  enabled: true
+  severity: error
+```

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

@@ -1,7 +1,13 @@
 root: .
 
+extends: :nothing
+
 require: []
 
+include_categories: []
+
+exclude_categories: []
+
 ignore:
   - node_modules/*
 
@@ -17,6 +23,7 @@ LiquidTag:
 MissingTemplate:
   enabled: true
   ignore: []
+  ignore_missing: []
 
 NestedSnippet:
   enabled: true
@@ -38,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
@@ -161,3 +168,23 @@ ImgLazyLoading:
 HtmlParsingError:
   enabled: true
   ignore: []
+
+AssetSizeAppBlockJavaScript:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeAppBlockCSS:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 100_000
+
+AppBlockValidTags:
+  enabled: false
+  ignore: []
+
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50

data/config/nothing.yml

@@ -0,0 +1,11 @@
+root: .
+
+require: []
+
+include_categories: []
+
+exclude_categories: []
+
+ignore:
+  - node_modules/*
+

data/config/theme_app_extension.yml

@@ -0,0 +1,168 @@
+root: .
+
+extends: :nothing
+
+require: []
+
+include_categories: []
+
+exclude_categories: []
+
+ignore:
+  - node_modules/*
+
+ConvertIncludeToRender:
+  enabled: true
+  ignore: []
+
+LiquidTag:
+  enabled: true
+  ignore: []
+  min_consecutive_statements: 4
+
+MissingTemplate:
+  enabled: true
+  ignore: []
+  ignore_missing: []
+
+NestedSnippet:
+  enabled: true
+  ignore: []
+  max_nesting_level: 3
+
+RequiredLayoutThemeObject:
+  enabled: true
+  ignore: []
+
+SpaceInsideBraces:
+  enabled: true
+  ignore: []
+
+SyntaxError:
+  enabled: true
+  ignore: []
+
+TemplateLength:
+  enabled: true
+  ignore: []
+  max_length: 200
+  # Exclude content of {% schema %} in line count
+  exclude_schema: true
+
+UnknownFilter:
+  enabled: true
+  ignore: []
+
+UnusedAssign:
+  enabled: true
+  ignore: []
+
+UnusedSnippet:
+  enabled: true
+  ignore: []
+
+MatchingSchemaTranslations:
+  enabled: true
+  ignore: []
+
+MatchingTranslations:
+  enabled: true
+  ignore: []
+
+TranslationKeyExists:
+  enabled: true
+  ignore: []
+
+ValidHTMLTranslation:
+  enabled: true
+  ignore: []
+
+ValidJson:
+  enabled: true
+  ignore: []
+
+ValidSchema:
+  enabled: true
+  ignore: []
+
+UndefinedObject:
+  enabled: true
+  ignore: []
+  exclude_snippets: true
+
+RequiredDirectories:
+  enabled: false
+  ignore: []
+
+DeprecatedFilter:
+  enabled: true
+  ignore: []
+
+MissingEnableComment:
+  enabled: true
+  ignore: []
+
+ParserBlockingJavaScript:
+  enabled: true
+  ignore: []
+
+ParserBlockingScriptTag:
+  enabled: true
+
+AssetSizeJavaScript:
+  enabled: true
+  severity: suggestion
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeCSS:
+  enabled: true
+  severity: suggestion
+  ignore: []
+  threshold_in_bytes: 100_000
+
+ImgWidthAndHeight:
+  enabled: true
+  ignore: []
+
+RemoteAsset:
+  enabled: true
+  ignore: []
+
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []
+
+ImgLazyLoading:
+  enabled: true
+  ignore: []
+
+HtmlParsingError:
+  enabled: true
+  ignore: []
+
+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