theme-check 0.10.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b6a91e5ac4b1e2045b1e4fb2748e5ecb9600206f9ba07df401c1410bf494fc
-  data.tar.gz: b6fb1b3957ae5aecd7b2efbaa76a2e3c07390ec442f94d416ea5b20ca2cbf966
+  metadata.gz: 28cb25e47867151bea85360a9f07667f46ea30ad90285f16cc74e85370ad39d9
+  data.tar.gz: 2023811dad002a72f00e2c26562ff3e6b5f2f49c748d44968fd94d1f9e72300f
 SHA512:
-  metadata.gz: e2ca68b31968949dc52240c8ee5ca607e10e063b500cda0a7b06306589849f2bc0098f1b0742f962a91a0ca282aa504acb9f7c0de6b785afff0b577b84fa6eba
-  data.tar.gz: c7186299a1168c5ad1e3cd6544ee8c8248b96a492e1dc82481c26a69e75fb1f04172ceb58da61e310a393fd36c9b990464542e7528810c7bea556b5b8ce9b61d
+  metadata.gz: f3a5339873aea7a325cbc3f3715e9166b1f7734226e3d9ac7b400f048629a514f3eec5d559c77eaf70febacda35416b8332d8d1a6ebefa1d9a34f29474a4e41d
+  data.tar.gz: 19eec11d1eb86188fe170bce61f884072340d848e800b2bb2b344cddf3561d60594e4f066199b7f9157b54da81ce8afebc5e6db0f3dbfbc5fac208c95d2b5ed8

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,45 @@
 
+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
+==================
+
+  * Convert `AssetSizeCSS` to `HtmlCheck`
+  * Add `DeprecateLazysizes` & `DeprecateBgsizes` checks
+  * Allow hardcoded CDN urls in `RemoteAsset`
+  * Bump `LiquidTag` `min_consecutive_statements` default to 5
+  * Exclude {% javascript %} and {% stylesheet %} from line counts in `TemplateLength`
+  * Bump `TemplateLength` `max_length` default to 500
+  * Fix `StringScanner#skip(String)` not being supported on some Rubies
+  * Fix `ParsingHelpers#outside_of_strings` handling of empty strings
+  * Update to support new `{% render %}` syntax
+  * Converted `AssetSizeJavaScript` to `HtmlCheck`
+
+v0.10.2 / 2021-06-18
+==================
+
+  * Fix error when parsing a template with lots of HTML attributes.
+  * Add `HtmlParsingError` check for reporting errors during HTML parsing.
+
 v0.10.1 / 2021-06-11
 ==================
 

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/Rakefile

@@ -75,7 +75,7 @@ task :new_check, [:name] do |_t, args|
     code_source: code_source,
     doc_source: doc_source,
   )
-  sh "bundle exec ruby -Itest test/checks/my_new_check_test.rb"
+  sh "bundle exec ruby -Itest #{test_source}"
 end
 
 def erb(file, to, **args)

data/config/default.yml

@@ -1,7 +1,13 @@
 root: .
 
+extends: :nothing
+
 require: []
 
+include_categories: []
+
+exclude_categories: []
+
 ignore:
   - node_modules/*
 
@@ -12,7 +18,7 @@ ConvertIncludeToRender:
 LiquidTag:
   enabled: true
   ignore: []
-  min_consecutive_statements: 4
+  min_consecutive_statements: 5
 
 MissingTemplate:
   enabled: true
@@ -38,9 +44,13 @@ SyntaxError:
 TemplateLength:
   enabled: true
   ignore: []
-  max_length: 200
+  max_length: 500
   # Exclude content of {% schema %} in line count
   exclude_schema: true
+  # Exclude content of {% stylesheet %} in line count
+  exclude_stylesheet: true
+  # Exclude content of {% javascript %} in line count
+  exclude_javascript: true
 
 UnknownFilter:
   enabled: true
@@ -99,6 +109,14 @@ DeprecatedFilter:
   enabled: true
   ignore: []
 
+DeprecateLazysizes:
+  enabled: true
+  ignore: []
+
+DeprecateBgsizes:
+  enabled: true
+  ignore: []
+
 MissingEnableComment:
   enabled: true
   ignore: []
@@ -109,16 +127,20 @@ ParserBlockingJavaScript:
 
 ParserBlockingScriptTag:
   enabled: true
+  ignore: []
 
 AssetSizeJavaScript:
   enabled: false
-  ignore: []
   threshold_in_bytes: 10_000
   ignore: []
 
 AssetSizeCSS:
   enabled: false
+  threshold_in_bytes: 100_000
   ignore: []
+
+AssetSizeCSSStylesheetTag:
+  enabled: false
   threshold_in_bytes: 100_000
   ignore: []
 
@@ -141,3 +163,17 @@ ContentForHeaderModification:
 ImgLazyLoading:
   enabled: true
   ignore: []
+
+HtmlParsingError:
+  enabled: true
+  ignore: []
+
+AssetSizeAppBlockJavaScript:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeAppBlockCSS:
+  enabled: false
+  ignore: []
+  threshold_in_bytes: 100_000

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,153 @@
+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: []
+
+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
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeCSS:
+  enabled: true
+  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
+  ignore: []
+  threshold_in_bytes: 10_000
+
+AssetSizeAppBlockCSS:
+  enabled: true
+  ignore: []
+  threshold_in_bytes: 100_000

data/data/shopify_liquid/objects.yml

@@ -40,6 +40,7 @@
 - linklist
 - linklists
 - location
+- localization
 - metafield
 - model
 - model_source
@@ -55,6 +56,7 @@
 - powered_by_link
 - product
 - product_option
+- product_variant
 - recommendations
 - request
 - routes