theme-check 1.10.3 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2774c1d3e2e9b8fa7dab0fdd4174dbfd3e625c608af349c30f526f00a6b9123
-  data.tar.gz: 69bdb078be8aa938b2dec75a62206840586ae1a015620ec3c9ce727e49fc2e07
+  metadata.gz: 81371af549f2572360879747bb2e4a05ccddc52e564180d6ae7d0b8e73026e3f
+  data.tar.gz: 586263191e54240240110853f7a4973413bb5aa1c1e2412c2ac293876a25fc1f
 SHA512:
-  metadata.gz: aa83efd1994e95fd12defc06b13567fac6e80fd830fb870f7a50b650424b8ed339848271ac35c608b6bc40a3e884665a3136c1f75e150be937be8b78e74df9fc
-  data.tar.gz: 848e2752ecc6e6bb4b0954663dac298f869a191d0b4b146fd488b8a9a442a5573a1c716c84658b2654431f96db1572309c70991a2e29e37c1bf82bd337c79edd
+  metadata.gz: b050fff19499529cc00a4382ddc2b525002cfb3058bb4f292d0a2181093d4a4854e62f1cf0736397f0eee40aca8d2f1ec073a3a6093b1e50106fd66600938e90
+  data.tar.gz: '09f65761f31e53c11c3e723d1651426a6787b5360a67bf8c9c833cd51ab2352b32b18b69580c143193f45ce9438e09a22c95dda66a98c344e4eaee5d3293ce9b'

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+<!--A clear and concise description of what the bug is.-->
+
+**Expected**
+<!-- Include what you expect should happen here -->
+
+**Actual**
+<!-- Include a description of what actually happens here -->
+
+**Stack trace**
+```
+<!-- When provided, please include the entire error message in here -->
+```
+
+**Debugging information**
+- OS [e.g. Windows, Mac, Linux]
+- Version (output of `theme-check --version` in a terminal)
+
+**Additional context**
+<!-- Add any other context or screenshots about the problem here. -->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!-- Add any other context or screenshots about the feature request here. -->

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

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

@@ -13,7 +13,7 @@ jobs:
           - windows-latest
         version:
           - 3.0.0
-          - 2.6.6
+          - 2.7.6
         theme:
           - Shopify/dawn
 

data/.gitignore

@@ -14,3 +14,6 @@ Gemfile.lock
 packaging/builds
 .vscode
 *.DS_Store
+
+# Theme Liquid docs live at git@github.com:Shopify/theme-liquid-docs.git,
+/data/shopify_liquid/documentation/

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+v1.12.0 / 2022-12-12
+==================
+
+  * Introduce Intelligent Code Completion ([#672](https://github.com/Shopify/theme-check/issues/672))
+  * Update TROUBLESHOOTING.md to include language server stopping guide ([#664](https://github.com/Shopify/theme-check/issues/664))
+  * Create troubleshooting doc, update contributing and readme with links ([#630](https://github.com/Shopify/theme-check/issues/630))
+  * robots Object in robots.txt file ([#644](https://github.com/Shopify/theme-check/issues/644)). Thanks @we5!
+
+v1.11.0 / 2022-08-22
+====================
+
+## TL;DR
+
+  * New check, overdue fixes and dropped support for ruby 2.6.
+
+## Features
+
+  * :new: [AssetPreload](https://github.com/Shopify/theme-check/blob/main/docs/checks/asset_preload.md) check ([#605](https://github.com/shopify/theme-check/issues/605)). Thanks @krzksz!
+    * Encourages the use of the new platform features for some sweet 103 Early Hints gains powered by the `preload_tag` and `preload: true` media filter argument.
+
+## Fixes:
+
+### General
+
+  * Add support for new comment syntax `{% # this is an inline comment %}` ([#533](https://github.com/shopify/theme-check/issues/533))
+  * Fix UnusedAssign false positives from `{% render ... with|for var %}` ([#608](https://github.com/shopify/theme-check/issues/608))
+  * Update list of platform filters ([#626](https://github.com/shopify/theme-check/issues/626))
+
+### Language Server
+
+  * Make `runChecks` command respect `onlySingleFileChecks` LSP config ([#624](https://github.com/shopify/theme-check/issues/624))
+  * Handle file delete|rename ([#611](https://github.com/shopify/theme-check/issues/611))
+  * Prevent server from hanging on error ([#623](https://github.com/shopify/theme-check/issues/623))
+
+### Linter
+
+  * Help migrate named sizes (master|pico|etc.) in `img_url` with `DeprecatedFilter` corrector ([#619](https://github.com/shopify/theme-check/issues/619))
+  * Fix MissingTemplate `ignore` config interactions (#613)
+  * Fix MissingRequiredTemplateFiles JSON file corrector ([#616](https://github.com/shopify/theme-check/issues/616))
+  * Fixes theme-check-disable when disable comment is followed by another (#617)
+  * Fix handling of `{% render block %}` in UnusedSnippet ([#615](https://github.com/shopify/theme-check/issues/615))
+  * Fix IndexError: string not matched in matching translation keys fixer ([#602](https://github.com/shopify/theme-check/issues/602))
+  * Handle variable lookup as names in UnusedAssign ([#612](https://github.com/shopify/theme-check/issues/612))
+
+## Breaking change (maybe)
+
+  * Bump min version of ruby to 2.7 ([#609](https://github.com/shopify/theme-check/issues/609))
+    * Upstream change from Shopify/liquid as ruby 2.6 is now EOL.
 
 v1.10.3 / 2022-06-16
 ==================

data/CONTRIBUTING.md

@@ -21,6 +21,84 @@ For your contribution to be accepted you will need to sign the [Shopify Contribu
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Run Language Server 
+If you're making changes to the language server and you want to debug, you can run the repo's version of `theme-check-language-server`.
+
+### Setup
+
+Before configuring your IDE, run the following commands in a terminal:
+
+  * Make sure you have a `$HOME/bin`
+      ```bash
+      mkdir -p $HOME/bin
+      ```
+  * Paste this script to create an executable wrapper in `$HOME/bin/theme-check-language-server` for language server
+      ```bash
+      cat <<-'EOF' > $HOME/bin/theme-check-language-server
+      #!/usr/bin/env bash
+      cd "$HOME/src/github.com/Shopify/theme-check" &> /dev/null
+      chruby () {
+        source '/opt/dev/sh/chruby/chruby.sh'
+        chruby "$@"
+      }
+      export THEME_CHECK_DEBUG=true
+      export THEME_CHECK_DEBUG_LOG_FILE="/tmp/theme-check-debug.log"
+      touch "$THEME_CHECK_DEBUG_LOG_FILE"
+      chruby 2.7 &>/dev/null
+      gem env &>/dev/null
+      bin/theme-check-language-server
+      EOF
+      ```
+  * Make the script executable
+      ```bash
+      chmod u+x $HOME/bin/theme-check-language-server
+      ```
+
+#### Configure VS Code
+
+* Install the [Shopify Liquid](https://github.com/shopify/theme-check-vscode) plugin
+
+* Add the following to `settings.json`:
+
+```json
+"shopifyLiquid.formatterDevPreview": true,
+"shopifyLiquid.languageServerPath": "/Users/<YOUR_USERNAME>/bin/theme-check-language-server",
+```
+
+#### Configure Vim
+
+If you use `coc.nvim` as your completion engine, add this to your CocConfig:
+
+```json
+"languageserver": {
+  "theme-check": {
+    "command": "/Users/<YOUR_USERNAME>/bin/theme-check-language-server",
+    "trace.server": "verbose",
+    "filetypes": ["liquid", "liquid.html"],
+    "rootPatterns": [".theme-check.yml", "snippets/*"],
+    "settings": {
+      "themeCheck": {
+        "checkOnSave": true,
+        "checkOnEnter": true,
+        "checkOnChange": false
+      }
+    }
+  }
+```
+
+### Confirm Setup
+
+* In another terminal from the root of theme check run `tail -f /tmp/theme-check-debug.log` to watch the server logs 
+* Restart your IDE, confirm the response for initialize in the logs is pointing to the language server in the `$HOME/bin` directory (the version will be different)
+
+```json
+    "serverInfo": {
+        "name": "/Users/johndoe/bin/theme-check-language-server",
+        "version": "1.10.3"
+    }
+```
+
+
 ## Running Tests
 
 ```
@@ -123,3 +201,7 @@ chrome /tmp/fg.svg
 What you'll see is an interactive version of the following image:
 
 ![flamegraph](docs/flamegraph.svg)
+
+## Troubleshooting
+
+If you run into issues during development, see the [troubleshooting guide](/TROUBLESHOOTING.md)

data/README.md

@@ -115,32 +115,31 @@ See [config/default.yml](config/default.yml) for available options & defaults.
 Use Liquid comments to disable and re-enable all checks for a section of your template:
 
 ```liquid
-{% comment %}theme-check-disable{% endcomment %}
+{% # theme-check-disable %}
 {% assign x = 1 %}
-{% comment %}theme-check-enable{% endcomment %}
+{% # theme-check-enable %}
 ```
 
 Disable a specific check by including it in the comment:
 
 ```liquid
-{% comment %}theme-check-disable UnusedAssign{% endcomment %}
+{% # theme-check-disable UnusedAssign %}
 {% assign x = 1 %}
-{% comment %}theme-check-enable UnusedAssign{% endcomment %}
+{% # theme-check-enable UnusedAssign %}
 ```
 
 Disable multiple checks by including them as a comma-separated list:
 
 ```liquid
-{% comment %}theme-check-disable UnusedAssign,SpaceInsideBraces{% endcomment %}
+{% # theme-check-disable UnusedAssign,SpaceInsideBraces %}
 {%assign x = 1%}
-{% comment %}theme-check-enable UnusedAssign,SpaceInsideBraces{% endcomment %}
+{% # theme-check-enable UnusedAssign,SpaceInsideBraces %}
 ```
 
 Disable checks for the _entire document_ by placing the comment on the first line:
 
 ```liquid
-{% comment %}theme-check-disable SpaceInsideBraces{% endcomment %}
-
+{% # theme-check-disable SpaceInsideBraces %}
 {%assign x = 1%}
 ```
 
@@ -191,3 +190,7 @@ DeprecateLazysizes:
 ⚠️ **Note:** Quickfixes only work on a freshly checked file. If any of those configurations are turned off, you will need to rerun theme-check in order to apply quickfixes.
 
 In VS Code, these can be set directly in your `settings.json`.
+
+## Contributing
+
+For guidance on contributing, refer to this [doc](/CONTRIBUTING)

data/Rakefile

@@ -53,6 +53,13 @@ task :prerelease, [:version] do |_t, args|
   ThemeCheck::Releaser.new.release(args.version)
 end
 
+desc("Download theme-liquid-docs")
+task :download_theme_liquid_docs do
+  require 'theme_check/shopify_liquid/source_manager'
+
+  ThemeCheck::ShopifyLiquid::SourceManager.download
+end
+
 desc "Create a new check"
 task :new_check, [:name] do |_t, args|
   require "theme_check/string_helpers"

data/TROUBLESHOOTING.md

@@ -0,0 +1,65 @@
+# Troubleshooting
+
+## Issues with Language Server 
+
+### Language server erroring out on startup
+
+The following error can cause language server to crash:
+```bash
+Calling `DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. Please call `DidYouMean.correct_error(error_name, spell_checker)' instead.
+/Users/johndoe/.gem/ruby/3.1.2/gems/bundler-2.2.22/lib/bundler/spec_set.rb:91:in `block in materialize': Could not find ruby-prof-0.18.0 in any of the sources (Bundler::GemNotFound)
+```
+
+Confirm the version of theme-check matches the version in the wrapper in `~/bin/theme-language-server`. If it doesn't match the ruby version, run the following from the theme-check directory:
+
+```bash
+chruby 3.1.2 #your `~/bin/theme-language-server` ruby version
+bundle install
+```
+
+### Language server changes not propogating to your IDE
+
+Look at logs for language server and check the response for initialize. If it looks like this, you're pointing to the Shopify CLI and not the language server in the repo:
+
+```json
+    "serverInfo": {
+        "name": "/opt/homebrew/bin/shopify",
+        "version": "1.10.3"
+    }
+```
+
+Check the config for your IDE/completion engine and confirm the Shopify CLI path isn't present (this by default overrides theme-check pointing to the repo's language server). If you're using VS Code this would be in your `settings.json`. 
+
+The response for initialize should look like this:
+
+```json
+    "serverInfo": {
+        "name": "/Users/johndoe/src/github.com/Shopify/theme-check/bin/theme-check-language-server",
+        "version": "1.10.3"
+    }
+```
+
+If this isn't an issue, confirm the theme check repo's version of ruby matches the ruby version of your theme. If it doesn't, from the theme-check repo run:
+
+```bash
+chruby 3.1.2 #your theme ruby version
+bundle install
+```
+
+### Language server sends an `initialize()` request to the client and stops
+
+To debug, confirm these steps are included in your local language server startup script:
+
+```bash 
+export THEME_CHECK_DEBUG=true
+export THEME_CHECK_DEBUG_LOG_FILE="/tmp/theme-check-debug.log"
+touch "$THEME_CHECK_DEBUG_LOG_FILE"
+```
+
+An example script can be found [here](/CONTRIBUTING.md#run-language-server).
+
+Open `/tmp/theme-check-debug.log` in your IDE. Check if there are any exceptions being raised by language server. 
+
+If there are no exceptions, check if there are any logs that aren't in jsonrpc. The language server and client use stdin and stdout to communicate using jsonrpc. Debugging statements that aren't in a jsonrpc format might trigger unexpected behavior (this includes any logs from language server or echo statements in your language server script).
+
+

data/config/default.yml

@@ -131,6 +131,10 @@ ParserBlockingScriptTag:
   enabled: true
   ignore: []
 
+AssetPreload:
+  enabled: true
+  ignore: []
+
 AssetSizeJavaScript:
   enabled: false
   threshold_in_bytes: 10_000

data/data/shopify_liquid/built_in_liquid_objects.json

@@ -0,0 +1,60 @@
+[
+  {
+    "properties": [
+      {
+        "name": "first",
+        "return_type": [
+          {
+            "type": "generic"
+          }
+        ],
+        "description": "Returns the first item of an array."
+      },
+      {
+        "name": "size",
+        "description": "Returns the number of items in an array."
+      },
+      {
+        "name": "last",
+        "return_type": [
+          {
+            "type": "generic"
+          }
+        ],
+        "description": "Returns the last item of an array."
+      }
+    ],
+    "name": "array",
+    "description": "Arrays hold lists of variables of any type."
+  },
+  {
+    "properties": [
+      {
+        "name": "size",
+        "description": "Returns the number of characters in a string."
+      }
+    ],
+    "name": "string",
+    "description": "Strings are sequences of characters wrapped in single or double quotes."
+  },
+  {
+    "properties": [],
+    "name": "number",
+    "description": "Numeric values, including floats and integers."
+  },
+  {
+    "properties": [],
+    "name": "boolean",
+    "description": "A binary value, either true or false."
+  },
+  {
+    "properties": [],
+    "name": "nil",
+    "description": "An undefined value. Tags or outputs that return nil don't print anything to the page. They are also treated as false."
+  },
+  {
+    "properties": [],
+    "name": "empty",
+    "description": "An empty object is returned if you try to access an object that is defined, but has no value. For example a page or product that’s been deleted, or a setting with no value. You can compare an object with empty to check whether an object exists before you access any of its attributes."
+  }
+]