theme-check 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b841f4d2f809e07dec57140fd76f373e216f721903baa7ac1dce747b5ce77c82
-  data.tar.gz: b513333c296966cedb4d00345cb7ab1a3d4dcbb305b92b3eb96edc598867bba5
+  metadata.gz: 2b606fffc2525680e6d47cf1d45b3fbdd514c79cf426dfd28baaec20e1cc083f
+  data.tar.gz: f0b9e3b0da8f41ae48e11d91ff1ccd780e0ed6cc5b8ba80694c3cd70a33e04a0
 SHA512:
-  metadata.gz: 1d75dc49ae97db15d4622d6a59b7a12a0eab0de6a6bcf19e6e8bca3b7f6eb6f94c40c11cfcdb3ac911bbc4d93e6d08cfbb83e85de763d00cb60b6fab10bfc7bb
-  data.tar.gz: eb7c5fdb74551461de7fd643071734dc8b2442db4a5a80492b982bc392c67a100614e4a9fa3b4580e28c5f1b8321564adc8f9580618f3bcdbc36dfd4e4ab13e3
+  metadata.gz: 23ce6e8b332e57cf523db93cf14ca9c948e569703633d5b82f106e95e66dd613ab30fa448226cf4f624b24da2675179220e7fc9fe206bfa9521f722c74356ba2
+  data.tar.gz: 22e2469eba1fc8aca4e881cfc5d0ad5ea7c16a057cdba6327310906099497b72d18dbef2d4f69d328528d6801f0abb91fac78a692f68387f7378d2c8fd3986dd

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

@@ -34,3 +34,6 @@ jobs:
       run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
     - name: Run tests
       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"

data/CHANGELOG.md

@@ -1,4 +1,43 @@
 
+v0.10.0 / 2021-06-08
+==================
+
+  * Add ImgLazyLoading check for recommending loading="lazy" attribute
+
+v0.9.1 / 2021-06-04
+==================
+
+  * Convert `RemoteAsset` into an `HtmlCheck`
+  * Move Liquid logic from `RemoteAsset` to a new `AssetUrlFilters` check
+
+v0.9.0 / 2021-05-28
+==================
+
+  * Introduce HtmlCheck, and convert ParserBlockingJavaScript & ImgWidthAndHeight to it
+  * Move `script-tag` validation from ParserBlockingJavaScript to ParserBlockingScriptTag
+  * Add ability to ignore individual checks using file patterns
+  * Introduce single file and whole theme checks to optimize LSP diagnostics
+  * Fix TemplateLength counter not being reseted on each document
+  * Add missing category to ValidHTMLTranslation
+  * Set Ruby default encodings to UTF-8 to fix encoding issues
+  * Add ContentForHeaderModification check to prevent relying on the content of ``content_for_header`
+  * Fix `Content-Length` in LSP responses
+  * Fix disabling checks that emit offences in `on_end`
+  * Fix completion bug in `filter_completion_provider`
+
+v0.8.3 / 2021-05-17
+==================
+
+  * Making sure VERSION is set before referencing it
+
+v0.8.2 / 2021-05-14
+===================
+
+  * Bump NestedSnippet max_nesting_level to 3
+  * Add a message to help debug errors, and timeout checks after 5 sec
+  * Object Completions Everywhere!
+  * Include operators to space inside braces check
+
 0.8.1 / 2021-04-22
 ==================
 

data/CONTRIBUTING.md

@@ -41,7 +41,8 @@ Under `lib/theme_check/checks`, create new Ruby file with a unique name describi
 ```ruby
 module ThemeCheck
   # Does one thing, and does it well!
-  # NOTE: inherit from JsonCheck to implement a JSON based check.
+  # NOTE: inherit from `JsonCheck` to implement a JSON-based check, and from `HtmlCheck`
+  # to implement an HTML-based one. See other checks in `lib/theme_check/checks` for examples.
   class MyCheckName < LiquidCheck
     severity :suggestion # :error or :style
 

data/README.md

@@ -92,11 +92,14 @@ root: dist
 require:
   - ./path/to/my_custom_check.rb
 
-# Disable some checks
 TemplateLength:
+  # Disable some checks
   enabled: false
   # Or configure options
   max_length: 300
+  # Or ignore certain paths
+  ignore:
+    - snippets/icon-*
 
 # Enable a custom check
 MyCustomCheck

data/RELEASING.md

@@ -9,11 +9,13 @@
    rake prerelease[$VERSION]
    ```
 
-3. Commit your changes and make a PR.
+3. Run [`git changelog`](https://github.com/tj/git-extras) to update `CHANGELOG.md`.
 
-4. Merge your PR to master.
+4. Commit your changes and make a PR.
 
-5. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
+5. Merge your PR to master.
+
+6. On [Shipit](https://shipit.shopify.io/shopify/theme-check/rubygems), deploy your commit.
 
 ## Homebrew Release Process
 

data/config/default.yml

@@ -7,92 +7,137 @@ ignore:
 
 ConvertIncludeToRender:
   enabled: true
+  ignore: []
 
 LiquidTag:
   enabled: true
+  ignore: []
   min_consecutive_statements: 4
 
 MissingTemplate:
   enabled: true
+  ignore: []
 
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  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: []
 
 DefaultLocale:
   enabled: true
+  ignore: []
 
 TranslationKeyExists:
   enabled: true
+  ignore: []
 
 ValidHTMLTranslation:
   enabled: true
+  ignore: []
 
 ValidJson:
   enabled: true
+  ignore: []
 
 ValidSchema:
   enabled: true
+  ignore: []
 
 MissingRequiredTemplateFiles:
   enabled: true
+  ignore: []
 
 UndefinedObject:
   enabled: true
+  ignore: []
   exclude_snippets: true
 
 RequiredDirectories:
   enabled: true
+  ignore: []
 
 DeprecatedFilter:
   enabled: true
+  ignore: []
 
 MissingEnableComment:
   enabled: true
+  ignore: []
 
 ParserBlockingJavaScript:
   enabled: true
+  ignore: []
+
+ParserBlockingScriptTag:
+  enabled: true
 
 AssetSizeJavaScript:
   enabled: false
+  ignore: []
   threshold_in_bytes: 10_000
+  ignore: []
 
 AssetSizeCSS:
   enabled: false
+  ignore: []
   threshold_in_bytes: 100_000
+  ignore: []
 
 ImgWidthAndHeight:
   enabled: true
+  ignore: []
 
 RemoteAsset:
   enabled: true
+  ignore: []
+
+AssetUrlFilters:
+  enabled: true
+  ignore: []
+
+ContentForHeaderModification:
+  enabled: true
+  ignore: []
+
+ImgLazyLoading:
+  enabled: true
+  ignore: []

data/data/shopify_liquid/tags.yml

@@ -8,6 +8,8 @@
 - cycle
 - decrement
 - echo
+- else
+- elsif
 - for
 - form
 - if
@@ -25,3 +27,4 @@
 - stylesheet
 - tablerow
 - unless
+- when

data/docs/checks/asset_url_filters.md

@@ -0,0 +1,56 @@
+# Ensure `asset_url` filters are used when serving assets (`AssetUrlFilters`)
+
+See the [`RemoteAsset` check documentation][remote_asset] for a detailed explanation on why remote assets are discouraged.
+
+## Check Details
+
+This check is aimed at eliminating unnecessary HTTP connections.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- Using multiple CDNs -->
+{{ "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" | stylesheet_tag }}
+
+<!-- Missing img_url filter -->
+{{ url | img_tag }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{{ 'bootstrap.min.css' | asset_url | stylesheet_tag }}
+
+<!-- Images -->
+{{ url | img_url | img_tag }}
+```
+
+Use the [`assets_url`](asset_url) or [`img_url`](img_url) filter to load the files in your theme's `assets/` folder from the Shopify CDN.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+AssetUrlFilters:
+  enabled: true
+```
+
+## When Not To Use It
+
+When the remote content is highly dynamic.
+
+## Version
+
+This check has been introduced in Theme Check 0.9.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/remote_asset_filters.rb
+[docsource]: /docs/checks/remote_asset_filters.md
+[remote_asset]: /docs/checks/remote_asset.md
+[asset_url]: https://shopify.dev/docs/themes/liquid/reference/filters/url-filters#assert_url
+[img_url]: https://shopify.dev/docs/themes/liquid/reference/filters/url-filters#img_url

data/docs/checks/content_for_header_modification.md

@@ -0,0 +1,42 @@
+# Do not depend on the content of `content_for_header` (`ContentForHeaderModification`)
+
+Do not rely on the content of `content_for_header` as it might change in the future, which could cause your Liquid code behavior to change.
+
+## Check Details
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign parts = content_for_header | split: ',' %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+The only acceptable usage of `content_for_header` is:
+
+```liquid
+{{ content_for_header }}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ContentForHeaderModification:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+- [`theme.liquid` template considerations][considerations]
+
+[codesource]: /lib/theme_check/checks/check_class_name.rb
+[docsource]: /docs/checks/check_class_name.md
+[considerations]: https://shopify.dev/docs/themes/theme-templates/theme-liquid#template-considerations

data/docs/checks/img_lazy_loading.md

@@ -0,0 +1,61 @@
+# Lazy loading image tags (`ImgLazyLoading`)
+
+Lazy loading is a strategy to identify resources as non-blocking (non-critical) and load these only when needed. It's a way to shorten the length of the critical rendering path, which translates into reduced page load times.
+
+Lazy loading can occur on different moments in the application, but it typically happens on some user interactions such as scrolling and navigation.
+
+Very often, webpages contain many images that contribute to data-usage and how fast a page can load. Most of those images are off-screen (non-critical), requiring user interaction (an example being scroll) in order to view them.
+
+_Quoted from [MDN - Lazy loading][mdn]_
+
+## Check Details
+
+This check is aimed at defering loading non-critical images.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<img src="a.jpg">
+
+<!-- Replaces lazysize.js -->
+<img src="a.jpg" class="lazyload">
+
+<!-- `auto` is deprecated -->
+<img src="a.jpg" loading="auto">
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<img src="a.jpg" loading="lazy">
+
+<!-- `eager` is also accepted, but prefer `lazy` -->
+<img src="a.jpg" loading="eager">
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ImgLazyLoading:
+  enabled: true
+```
+
+## When Not To Use It
+
+If you don't want to defer loading of images, then it's safe to disable this rule.
+
+## Version
+
+This check has been introduced in Theme Check 0.10.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+- [MDN - Lazy loading][mdn]
+
+[codesource]: /lib/theme_check/checks/img_lazy_loading.rb
+[docsource]: /docs/checks/img_lazy_loading.md
+[mdn]: https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading

data/docs/checks/nested_snippet.md

@@ -45,7 +45,7 @@ The default configuration for this check is the following:
 ```yaml
 NestedSnippet:
   enabled: true
-  max_nesting_level: 2
+  max_nesting_level: 3
 ```
 
 ### `max_nesting_level`

data/docs/checks/parser_blocking_script_tag.md

@@ -0,0 +1,53 @@
+# Discourage use of parser-blocking `script_tag` filter (`ParserBlockingScriptTag`)
+
+The `script_tag` filter emits a parser-blocking script tag.
+
+See the [ParserBlockingJavaScript check documentation][parser_blocking_javascript] for why this is generally discouraged.
+
+## Check Details
+
+This check is aimed at eliminating parser-blocking JavaScript on themes.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- The script_tag filter outputs a parser-blocking script -->
+{{ 'app-code.js' | asset_url | script_tag }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<!-- Good. Using the asset_url filter + defer -->
+<script src="{{ 'theme.js' | asset_url }}" defer></script>
+
+<!-- Also good. Using the asset_url filter + async -->
+<script src="{{ 'theme.js' | asset_url }}" async></script>
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+ParserBlockingScriptTag:
+  enabled: true
+```
+
+## When Not To Use It
+
+This should only be turned off with the `theme-check-disable` comment when there's no better way to accomplish what you're doing than with a parser-blocking script.
+
+It is discouraged to turn this rule off.
+
+## Version
+
+This check has been introduced in Theme Check 0.9.0.
+
+## Resources
+
+- [ParserBlockingJavaScript check][parser_blocking_javascript]
+- [Documentation Source][docsource]
+
+[parser_blocking_javascript]: /docs/checks/parser_blocking_javascript.md
+[docsource]: /docs/checks/parser_blocking_script_tag.md