platformos-check 0.4.12 → 0.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5795a4dfbd11ce9650dd968756ebf8762eab1528fc41a2bb968eeb6b7bfc061
-  data.tar.gz: ba6029d4a33bd1d91e600ec33aeebd9de2660567188073dfe64db36b39415ea7
+  metadata.gz: c3d6f6042c319fcddd4ffcfd7448d2f1fa23f77e7f10839b1cc77b667bfe5b13
+  data.tar.gz: b151f8a69281c760f476ac5d1e849a079691f2607f54093e03f3dd64e7b985aa
 SHA512:
-  metadata.gz: ffa173e4a4441e4d49da110129c3c964c74c2b011da9d45e4b51f4385eec43d2aa374f03754c048ec58ff8e934924f38b36f94bfd4a61e3b873324a489886ed5
-  data.tar.gz: 7c96d26c1b529b670fa316dd7202f23888dd6ffd711d9249a14bfbea516528ca9793ff3a44a80e1b032b682080bf99d190e6a11d8c8a56f2a84b236a025bd9af
+  metadata.gz: 377ff80d76ac4a465bca202d949193ea7b4f836df04068be7eece864eb74e17823e008f983831cd8e259a532e3c1b93d83b210480c3c1ebb8440e113598ce498
+  data.tar.gz: 34c02ebc74de8ac8d9bd193f502b7ebef6de635df4eb87bdb3a2454bafab841896008a8b5e67a8057ec770b08d9fad5f1e9a24e056bed65f7699c1d819ea9839

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.4.13 / 2024-10-07
+==================
+
+  * Lock liquid version
+  * Fix rubocop warnings
+
 v0.4.12 / 2024-04-13
 ==================
 

data/CONTRIBUTING.md

@@ -6,16 +6,16 @@
 * PR should explain what the feature does, and why the change exists.
 * PR should include any carrier specific documentation explaining how it works.
 * Code _must_ be tested.
-* Be consistent. Write clean code that follows [Ruby community standards](https://github.com/bbatsov/ruby-style-guide).
+* Be consistent. Write clean code that follows the [Ruby community standards](https://github.com/bbatsov/ruby-style-guide).
 * Code should be generic and reusable.
 
 ## How to contribute
 
-1. Fork it ( https://github.com/Platform-OS/platformos-lsp )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Fork it (https://github.com/Platform-OS/platformos-lsp).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.
 
 ## Run Language Server
 
@@ -49,9 +49,9 @@ Before configuring your IDE, run the following commands in a terminal:
 
 #### Configure VS Code
 
-1. Download provided .vsix file
-2. Install it manually via View -> Extensions -> ... -> Install from VSIX
-3. Configure settings.json
+1. Download provided `.vsix` file.
+2. Install it manually via View -> Extensions -> ... -> Install from VSIX.
+3. Configure `settings.json`:
 
 ```
 "platformosCheck.checkOnChange": true,
@@ -90,8 +90,8 @@ If you use `coc.nvim` as your completion engine, add this to your CocConfig:
 
 ### Confirm Setup
 
-* In another terminal from the root of theme check run `tail -f /tmp/platformos-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)
+* From the root of platformos-check, run `tail -f /tmp/platformos-check-debug.log` in another terminal to watch the server logs.
+* Restart your IDE, confirm the response for initialization in the logs is pointing to the language server in the `$HOME/bin` directory (the version will be different).
 
 ```json
     "serverInfo": {
@@ -118,9 +118,9 @@ bin/platformos-check /path/to/your/app
 
 Run `bundle exec rake "new_check[MyNewCheckName]"` to generate all the files required to create a new check.
 
-Check the [Check API](/docs/api/check.md) for how to implement a check. Also take a look at other checks in [lib/platformos_check/checks](/lib/platformos_check/checks).
+Check the [Check API](/docs/api/check.md) for how to implement a check. Also, take a look at other checks in [lib/platformos_check/checks](/lib/platformos_check/checks).
 
-We done implementing your check, add it to `config/default.yml` to enable it:
+When you're done implementing your check, add it to `config/default.yml` to enable it:
 
 ```yaml
 MyNewCheckName:
@@ -128,7 +128,9 @@ MyNewCheckName:
   ignore: []
 ```
 
-If the check is configurable, the `initialize` argument names and default values should also be duplicated inside `config/default.yml`. eg.:
+If the check is configurable, the `initialize` argument names and default values should also be duplicated inside `config/default.yml`. 
+
+For example:
 
 ```ruby
 class MyCheckName < LiquidCheck
@@ -148,9 +150,9 @@ MyNewCheckName:
 
 ## Debugging
 
-A couple of things are turned on when the `PLATFORMOS_CHECK_DEBUG` environment variable is set.
+When the `PLATFORMOS_CHECK_DEBUG` environment variable is set, several features are enabled:
 
-1. The check timeout is turned off. This means you can add `binding.pry` in tests and properly debug with `bundle exec rake tests:in_memory`
+1. The check timeout is disabled. This allows you to use `binding.pry` in tests and debug with `bundle exec rake tests:in_memory`.
 2. The `--profile` flag appears. You can now create Flamegraphs to inspect performance.
 
 ```
@@ -173,7 +175,7 @@ bin/platformos-check-language-server
 
 #### Flamegraph
 
-With the `--profile` flag, you can run platformos-check on a theme and the `ruby-prof-flamegraph` printer will output profiling information in a format [Flamegraph](/brendangregg/FlameGraph) understands.
+With the `--profile` flag, you can run platformos-check on your platformOS application and the `ruby-prof-flamegraph` printer will output profiling information in a format [Flamegraph](/brendangregg/FlameGraph) understands.
 
 
 **Setup:**
@@ -206,4 +208,4 @@ What you'll see is an interactive version of the following image:
 
 ## Troubleshooting
 
-If you run into issues during development, see the [troubleshooting guide](/TROUBLESHOOTING.md)
+If you run into issues during development, see the [Troubleshooting Guide](/TROUBLESHOOTING.md).

data/README.md

@@ -1,18 +1,27 @@
-# platformOS Check ✅ - A linter for platformOS
+# platformOS Check ✅ - A Linter for platformOS
 
-PlatformOS Check is a tool that helps you follow platformOS recommendations & best practices by analyzing the Liquid inside your app.
+PlatformOS Check is a tool that checks your app’s Liquid code to make sure it follows the recommended best practices for [platformOS](https://www.platformos.com/).
+This tool looks for common errors and areas where your code could be improved, helping you clean up and optimize your code by pointing out syntax mistakes, outdated elements, and performance issues.
 
-![](docs/preview.png)
+![](docs/platformos-check.jpg)
 
 ## Supported Checks
 
-PlatformOS Check currently checks for the following:
+PlatformOS Check currently performs the following checks:
+
+**Syntax Validation:**
 
 ✅ Liquid syntax errors  
 ✅ JSON syntax errors  
-✅ Missing partials and graphqls  
-✅ Unused variables (via `{% assign var = ... %}`, {% function var = ... %} etc.)  
+
+**Resource Verification:**
+
+✅ Missing partials and GraphQL files  
+✅ Unused variables (using `{% assign var = ... %}`, {% function var = ... %} and similar tags)  
 ✅ Unused partials  
+
+**Code Efficiency and Quality:**
+
 ✅ Template length  
 ✅ Deprecated tags  
 ✅ Unknown tags  
@@ -22,57 +31,70 @@ PlatformOS Check currently checks for the following:
 ✅ Undefined objects  
 ✅ Deprecated filters  
 ✅ Missing `platformos-check-enable` comment  
-✅ Invalid arguments provided to `{% graphql %}` tags  
+✅ Invalid arguments in `{% graphql %}` tags  
 ✅ Missing `authenticity_token` in `<form>`  
 ✅ Unreachable code
 
-As well as checks that prevent easy to spot performance problems:
+**Performance Optimization:**
 
-✅ [GraphQL in for loop](/docs/checks/graphql_in_for_loop.md)  
-✅ Use of [parser-blocking](/docs/checks/parser_blocking_javascript.md) JavaScript  
-✅ [Missing width and height attributes on `img` tags](/docs/checks/img_width_and_height.md)
+✅ Preventing the [use of GraphQL queries inside loops](/docs/checks/graphql_in_for_loop.md)  
+✅ Identifying [parser-blocking JavaScript](/docs/checks/parser_blocking_javascript.md)
+✅ Ensuring `img` tags have [width and height attributes to improve loading times](/docs/checks/img_width_and_height.md)
 
-For detailed descriptions and configuration options, [take a look at the complete list.](/docs/checks/)
+For detailed descriptions and configuration options, [take a look at the complete list of checks](/docs/checks/).
 
-With more to come! Suggestions welcome ([create an issue](https://github.com/Platform-OS/platformos-lsp/issues)).
+We continually update and expand our checks. If you have suggestions, please [let us know by creating an issue](https://github.com/Platform-OS/platformos-lsp/issues).
 
 ## Installation
 
-- download and install the extension [more]
-- next steps
-  -> [using-local-ruby]
-  -> [docker]
+- Download and [install the platformOS Liquid extension](https://marketplace.visualstudio.com/items?itemName=platformOS.platformos-check-vscode)
+- Choose your installation method for Ruby and platformos-check gem:
+* [Using Locally Installed Ruby](#using-locally-installed-ruby)
+* [Using Docker](#using-docker)
 
-### Using locally installed ruby
+### Using Locally Installed Ruby
 
 #### Requirements
 
 - Ruby 3.2+
 
-### Install ruby and platform-check gem
+### Install Ruby and platformos-check gem
+
+⚠️ **Note:** Please make sure you install Ruby and the gem for your user and not as root to avoid permission issues. Install without using `sudo`.
 
-1. Download the latest version of Ruby - https://www.ruby-lang.org/en/documentation/installation/
+1. Download and install Ruby version 3.2 or higher using the [Official Ruby documentation](https://www.ruby-lang.org/en/documentation/installation/).
 
-Verify that you've installed at least version 3.2:
+Ensure your Ruby is 3.2 or higher: 
+
+```
+ruby -v
+```
 
-`ruby -v`
+⚠️ **Note:** Restart your terminal after installation.
 
-⚠️ **Note:**  You might need to restart  the terminal after installing.
-⚠️ **Note:*** Please make sure you install ruby for your user, not the root
+2. Install platformos-check gem, using:
 
-2. Install platformos-check gem
+```
+gem install platformos-check
+```
 
-`gem install platformos-check`
+Confirm the installation was successful by checking the version:
 
-You can verify the installation was successful by invoking `platformos-check --version`. If you chose this method, use `platformos-check-language-server` as a path to your language server instead of `/Users/<username/platformos-check-language-server`
+```
+platformos-check --version
+```
 
-⚠️ **Note:*** Please make sure you  install the gem for your user, not the root - i.e. without `sudo`
+If you chose this method, use `platformos-check-language-server` as a path to your language server instead of `/Users/<username/platformos-check-language-server`.
 
 ### Using Docker
 
-#### PlatformOS Check Language Server
+To set up the PlatformOS Check Language Server using Docker, follow these steps:
+
+#### platformOS Check Language Server
 
-- Create an executable `platformos-check-language-server` file and place it within a directory listed in your $PATH variable.
+1. Create a file named `platformos-check-language-server` and ensure it's executable and placed within a directory listed in your $PATH variable.
+
+2. Use the following script:
 
 ```bash
 DIR=$(pwd)
@@ -89,15 +111,18 @@ exec docker run -i \
   -e PLATFORMOS_CHECK_DEBUG_LOG_FILE=$LOG_FILE \
    $IMAGE_NAME $@
 ```
-This script will automatically download the latest Docker image and initiate a language server. Visual Studio Code (VSC) manages this process automatically. However, you can run the script for verification if needed.
+
+This script downloads the latest Docker image and starts the language server. Visual Studio Code (VS Code) can manage this process automatically, but you can also run the script manually for verification if needed.
 
 #### Troubleshooting
 
-- In the event of `onlySingleFileChecks: true` not functioning as expected, please examine your Visual Studio Code (VSC) workspace. Ensure that the workspace contains only a single project.
+- If the `onlySingleFileChecks: true` setting does not work as expected, check your Visual Studio Code (VS Code) workspace settings. Ensure that the workspace contains only a single project.
 
-#### PlatformOS Check
+#### PlatformOS Check as a Standalone Function
 
-PlatformOS Check can be used also as a standalone function. Prepare the following executable script:
+PlatformOS Check can also be used as a standalone function.
+
+1. Prepare and run the following script to set up the Docker environment:
 
 ```bash
 DIR=$(pwd)
@@ -114,22 +139,32 @@ exec docker run -i \
   -e PLATFORMOS_CHECK_DEBUG_LOG_FILE=$LOG_FILE \
    $IMAGE_NAME $@
 ```
-To verify installation run `platformos-check --help`.
 
-Usage example for CI/CD:
+2. To check if the tool is correctly installed up, run:
+
+```
+platformos-check --help
+```
+
+**Usage example for CI/CD:**
+
 ```
 platformos-check --fail-level error
 ```
 
+This setting ensures that the CI process will fail if any errors are detected during the checks.
+
 ## Configuration
 
-Add a `.platformos-check.yml` file at the root of your app.
+To configure PlatformOS Check according to your project's needs, you create a `.platformos-check.yml` file in the root directory of your application.
+
+See [config/default.yml](config/default.yml) for available options and their default values.
 
-See [config/default.yml](config/default.yml) for available options & defaults.
+## Disable Checks with Comments
 
-## Disable checks with comments
+Control the behavior of PlatformOS Check within your Liquid templates using comments to disable and re-enable checks as needed.
 
-Use Liquid comments to disable and re-enable all checks for a section of your file:
+### Temporarily Disabling All Checks
 
 ```liquid
 {% # platformos-check-disable %}
@@ -137,7 +172,11 @@ Use Liquid comments to disable and re-enable all checks for a section of your fi
 {% # platformos-check-enable %}
 ```
 
-Disable a specific check by including it in the comment:
+All checks will be ignored between the `disable` and `enable` comments.
+
+### Disabling a Specific Check
+
+To disable a specific check, such as `UnusedAssign`, include the check's name in the comment:
 
 ```liquid
 {% # platformos-check-disable UnusedAssign %}
@@ -145,7 +184,9 @@ Disable a specific check by including it in the comment:
 {% # platformos-check-enable UnusedAssign %}
 ```
 
-Disable multiple checks by including them as a comma-separated list:
+### Disabling Multiple Checks
+
+To disable multiple checks simultaneously, list them in a comma-separated format within the comments:
 
 ```liquid
 {% # platformos-check-disable UnusedAssign,SpaceInsideBraces %}
@@ -153,7 +194,9 @@ Disable multiple checks by including them as a comma-separated list:
 {% # platformos-check-enable UnusedAssign,SpaceInsideBraces %}
 ```
 
-Disable checks for the _entire document_ by placing the comment on the first line:
+### Disabling Checks for the Entire Document
+
+To disable a check throughout the entire document, place the disabling comment in the first line:
 
 ```liquid
 {% # platformos-check-disable SpaceInsideBraces %}
@@ -162,9 +205,9 @@ Disable checks for the _entire document_ by placing the comment on the first lin
 
 ## Exit Code and `--fail-level`
 
-Use the `--fail-level` (default: `error`) flag to configure the exit code of platformos-check. Useful in CI scenarios.
+Configure the exit code of platformos-check using the `--fail-level` (default: `error`) flag, which is especially useful in continuous integration (CI) scenarios. This flag helps you control at what severity level checks should cause your CI process to fail.
 
-Example:
+### Usage Examples
 
 ```
 # Make CI fail on styles warnings, suggestions, and errors
@@ -177,19 +220,23 @@ platformos-check --fail-level suggestion path_to_app
 platformos-check path_to_app
 ```
 
+### Fail Levels
+
 There are three fail levels:
 
 - `error`
 - `suggestion`
 - `style`
 
-Exit code meanings:
+### Exit Code Meanings
+
+- 0: Success — no issues found.
+- 1: Your code does not pass the specified fail level of checks.
+- 2: Error in platformos-check itself — indicates a bug within the tool.
 
-- 0: Success!
-- 1: Your code doesn't pass the checks
-- 2: There's a bug in platformos-check
+### Customizing Check Severity
 
-If you would like to change the severity of a check, you can do so with the `severity` attribute. Example:
+You can adjust the severity of specific checks using the `severity` attribute in your configuration file:
 
 ```yaml
 DeprecateLazysizes:
@@ -197,17 +244,21 @@ DeprecateLazysizes:
   severity: error
 ```
 
+This configuration, for example, treats the "DeprecateLazysizes" check as an error, thus influencing the exit code according to the `--fail-level` set.
+
 ## Language Server Configurations
 
-- `platformosCheck.checkOnOpen` (default: `true`) makes it so theme check runs on file open.
-- `platformosCheck.checkOnChange` (default: `true`) makes it so theme check runs on file change.
-- `platformosCheck.checkOnSave` (default: `true`) makes it so theme check runs on file save.
-- `platformosCheck.onlySingleFileChecks` (default: `false`) makes it so we only check the opened files and disable "whole application" checks (e.g. UnusedPartial, TranslationKeyExists)
+Configure the PlatformOS Check language server to optimize how it interacts with your files in the development environment. The following settings can be adjusted in your editor's configuration file. 
+
+In VS Code, you can set it directly in your `settings.json` file.
 
-⚠️ **Note:** Quickfixes only work on a freshly checked file. If any of those configurations are turned off, you will need to rerun platformos-check in order to apply quickfixes.
+- `platformosCheck.checkOnOpen` (default: `true`): Automatically runs checks when a file is opened.
+- `platformosCheck.checkOnChange` (default: `true`): Executes checks whenever changes are made to a file.
+- `platformosCheck.checkOnSave` (default: `true`): Initiates checks every time a file is saved.
+- `platformosCheck.onlySingleFileChecks` (default: `false`): Limits checks to the currently opened file, excluding checks that involve the entire application such as `UnusedPartial` or `TranslationKeyExists`.
 
-In VS Code, these can be set directly in your `settings.json`.
+⚠️ **Note:** Quickfixes only work on files that have been recently checked. If you have disabled the automatic checking configurations, you need to manually rerun platformos-check to enable quickfixes.
 
 ## Contributing
 
-For guidance on contributing, refer to this [doc](/CONTRIBUTING.md)
+We welcome contributions from the community! For detailed guidance on how to contribute, please refer to our [contribution guidelines](/CONTRIBUTING.md). Your input helps us make the tool better for everyone.

data/RELEASING.md

@@ -1,17 +1,23 @@
 ## Releasing platformOS Check
 
-1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+Follow these steps to release a new version of latformOS Check:
 
-2. Run the following command to update the version in `lib/platformos_check/version.rb` and replace the `PLATFORMOS_CHECK_VERSION` placeholder in the documentation for new rules:
+1. **Versioning**: Refer to the [Semantic Versioning page](http://semver.org) to determine the appropriate version number for the new release based on the changes made.
+
+2. **Update Version**: Update the version number in the `lib/platformos_check/version.rb` file. Also, replace the `PLATFORMOS_CHECK_VERSION` placeholder in the documentation for any new rules.
+Use the following command to automate these updates:
 
    ```bash
    VERSION="X.X.X"
    rake prerelease[$VERSION]
    ```
 
-3. Run [`git changelog`](https://github.com/tj/git-extras) to update `CHANGELOG.md`.
+3. **Update Changelog**: Use the [`git changelog` command](https://github.com/tj/git-extras) to automatically update the `CHANGELOG.md` with the latest commit descriptions.
+   ```bash
+   git changelog
+   ```
 
-4. Commit your changes and make a PR.
+4. **Commit and Prepare PR**: Commit the changes and prepare a pull request for review.
 
    ```bash
    git checkout -b "bump/platformos-check-$VERSION"
@@ -20,9 +26,10 @@
    hub compare "main:bump/platformos-check-$VERSION"
    ```
 
-5. Merge your PR to main.
+5. **Merge PR**: After review, merge your pull request into the main branch.
+
+6. **Create GitHub Release**: [Create a GitHub release](https://github.com/Platform-OS/platformos-lsp/releases/new) for the change using the updated version tag.
 
-6. [Create a GitHub release](https://github.com/Platform-OS/platformos-lsp/releases/new) for the change.
 
    ```
    VERSION=v1.X.Y
@@ -32,4 +39,4 @@
    gh release create -t $VERSION
    ```
 
-   (It's a good idea to copy parts of the CHANGELOG in there)
+⚠️ **Note:** Incorporate relevant parts of the CHANGELOG into the release notes to provide context on the changes.

data/TROUBLESHOOTING.md

@@ -2,34 +2,43 @@
 
 ## Issues with Language Server
 
-### Language server erroring out on startup
+### Language Server Crashing on Startup
 
-The following error can cause language server to crash:
+The following error can cause Language Server to crash:
+
+**Error Message:**
 ```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 platformos-check matches the version in the wrapper in `~/bin/platformos-check-language-server`. If it doesn't match the ruby version, run the following from the platformos-check directory:
+**Solution:**
+Ensure the `platformos-check` version in the wrapper in `~/bin/platformos-check-language-server` matches the expected Ruby version. If it doesn't match the Ruby version, run the following command from the platformos-check directory:
 
 ```bash
-chruby 3.1.2 #your `~/bin/platformos-check-language-server` ruby version
+chruby 3.1.2  #your `~/bin/platformos-check-language-server` ruby version
 bundle install
 ```
 
-### Language server sends an `initialize()` request to the client and stops
+If discrepancies are found, update your environment with the correct version of Ruby and re-install the necessary gems:
+
+### Language Server Initialization Issue
+
+**Symptom:**
 
-To debug, confirm these steps are included in your local language server startup script:
+The language server sends an `initialize()` request to the client but then stops responding.
 
+**Debugging Steps:**
+
+1. Ensure your local language server startup script includes these steps:
 ```bash
 export PLATFORMOS_CHECK_DEBUG=true
 export PLATFORMOS_CHECK_DEBUG_LOG_FILE="/tmp/platformos-check-debug.log"
 touch "$PLATFORMOS_CHECK_DEBUG_LOG_FILE"
 ```
 
-An example script can be found [here](/CONTRIBUTING.md#run-language-server).
-
-Open `/tmp/platformos-check-debug.log` in your IDE. Check if there are any exceptions being raised by language server.
+An example script can be found [in the Contributing Guide](/CONTRIBUTING.md#run-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).
+2. Open the debug log located at `/tmp/platformos-check-debug.log` in your IDE. Check if there are any exceptions being raised by the language server.
 
+3. If no exceptions are found, verify that all logs are properly formatted in JSON-RPC. The language server and client communicate using JSON-RPC over `stdin` and `stdout`. Debugging statements that aren't in a JSON-RPC format might trigger unexpected behavior. This includes any logs from the language server or echo statements in your language server script.