Permalink
Comparing changes
Choose two branches to see what’s changed or to start a new pull request.
If you need to, you can also or
learn more about diff comparisons.
Open a pull request
Create a new pull request by comparing changes across two branches. If you need to, you can also .
Learn more about diff comparisons here.
...
8
contributors
Commits on Jan 23, 2025
Commits on Jan 24, 2025
-
Add util function to read liquid doc definitions for a snippet Implement SnippetHoverProvider Connect SnippetHoverProvider with server Add changeset Provide default value for getLiquidDocDefinitionsForURI Rename SnippetHoverProvider -> RenderSnippetHoverProvider
-
Refactor - Simplify code by moving liquid doc visiting logic to its o…
…wn module ---- We didn't need to use the make pattern at least at this stage, so I'm removing the code in ThemeCheckCommon and placing it in its own module. We may need to revisit this when we are writing theme checks. However, for the purpose of hover, this is where the code should live.
-
Refactor Liquid documentation types and update references to improve …
…clarity - Renamed `GetLiquidDocDefinitionsForURI` to `GetSnippetDefinitionForURI` - Introduced `SnippetDefinition` type to replace `LiquidDocDefinition`, enhancing type specificity.
-
-
Commits on Jan 27, 2025
-
[LiquidDoc] Add snippet hover support inside of {% render %} tag (#703)
## What are you adding in this PR? Shopify/developer-tools-team#496 **1) Hover support for Liquid snippets inside of a `{% render %}` tag. Users will now see:** - The snippet name as a header - A list of parameters with their types and descriptions (if documented) If there is no `{% doc %}` present in the snippet, we will just render the snippet name **2) Caching for fetching LiquidDoc definitions** ##### Example snippet documentation: ```liquid {% doc %} @param {String} title - The title of the product @param {Number} border-radius - The border radius in px {% enddoc %} ``` ##### When hovering over `product-card` in `{% render 'product-card' %}`, users will see: ```markdown ### product-card **Parameters:** - `title`: String - The title of the product - `border-radius`: Number - The border radius in px ``` Uploading Cursor - liquidDoc.ts — theme-tools.mp4… #### Hovering a snippet with docs  #### Hovering a snippet without liquiddoc  ## What's next? Any followup issues? - Consider adding validation for param types - Add support for return value documentation - Add support for example usage documentation ## What did you learn? This is my first time working with the hover API in VS code. Pretty cool to read up on! ## Before you deploy - [x] I included a minor bump `changeset` - [x] My feature is backward compatible
-
-
-
-
[LiquidDoc] Prevent rendering of hover tooltip for snippets with no r…
…enderable content (#729) ## What are you adding in this PR? `{% render 'snippet' %}` Prevents rendering hover tooltip for snippets that: - do not exist - do not have renderable content. **Renderable content**: Currently, this means that it requires a `LiquidDoc` definition with `@param` annotations, though this will soon expand to the description and `@example` as well ## Before you deploy <!-- Delete the checklists you don't need --> <!-- Check changes --> - [ ] This PR includes a new checks or changes the configuration of a check - [ ] I included a minor bump `changeset` - [ ] It's in the `allChecks` array in `src/checks/index.ts` - [ ] I ran `yarn build` and committed the updated configuration files <!-- It might be that a check doesn't make sense in a theme-app-extension context --> <!-- When that happens, the check's config should be updated/overridden in the theme-app-extension config --> <!-- see packages/node/configs/theme-app-extension.yml --> - [ ] If applicable, I've updated the `theme-app-extension.yml` config <!-- Public API changes, new features --> - [ ] I included a minor bump `changeset` - [x] My feature is backward compatible <!-- Bug fixes --> - [x] I included a patch bump `changeset`
-
[LiquidDoc] Modify paramDescription to be null if empty (#737)
## What are you adding in this PR? Returns `null` in the `liquid-html-parser` if `paramDescription` value is `''`. Also added some test coverage in the language server for this case. - [paramDescription](https://github.com/Shopify/theme-tools/blob/main/packages/liquid-html-parser/grammar/liquid-html.ohm#L403) is always matched in the grammar. I experimented with changing that matching logic but ultimately felt it was simpler this logic in instead `stage-2`, though we could revisit this <!-- Bug fixes --> - [x] I included a patch bump `changeset`
Commits on Jan 28, 2025
-
Add duplicate settings ID detection for theme checker
Implements a new validation check to prevent duplicate setting IDs across theme configurations. This helps theme developers identify and fix duplicate IDs early in development, preventing potential conflicts and overrides. The implementation includes: - New JSONCheckDefinition for unique setting ID validation - Test coverage for valid and invalid theme configurations - Detection logic for finding duplicate IDs in settings schema See: Ticket: 49020903 Shopify/cli#4187
-
-
-
[Theme Check] Add check for duplicate settings id's (#696)
Closes Shopify/developer-tools-team#263 Implements a new validation check to prevent duplicate setting IDs across theme configurations. This helps theme developers identify and fix duplicate IDs early in development, preventing potential conflicts and overrides. The implementation includes: - New JSONCheckDefinition for unique setting ID validation - Test coverage for valid and invalid theme configurations - Detection logic for finding duplicate IDs in settings schema See: Ticket: 49020903 Shopify/cli#4187 ## What are you adding in this PR? This PR adds a new theme check validator that detects duplicate setting IDs in theme configurations. The validator scans settings_schema.json files and reports an error when it finds multiple settings using the same ID value, preventing potential runtime conflicts. Key changes: - New UniqueSettingIds check that validates setting ID uniqueness - Integration with the existing theme checker infrastructure - Test coverage for both valid and invalid scenarios - Error reporting with precise location information ## What's next? Any followup issues? Potential follow-ups: - Consider extending the check to validate uniqueness across sections - Add documentation for theme developers about ID uniqueness requirements - Consider adding quick-fix suggestions for duplicate IDs ## What did you learn? Working with AST traversal for JSON validation showed that we need a consistent approach to handle nested property validation. The existing node type checks provided a good pattern to follow. ## Before you deploy <!-- Delete the checklists you don't need --> <!-- Check changes --> - [x] This PR includes a new checks or changes the configuration of a check - [x] I included a minor bump `changeset` - [x] It's in the `allChecks` array in `src/checks/index.ts` - [x] I ran `yarn build` and committed the updated configuration files
-
-
-
-
Commits on Jan 30, 2025
-
Merge pull request #731 from Shopify/changeset-release/main
Theme Tools Release — 2025-01-28
-
Update repository URL definition to be case sensitive
Without this we'll fail to publish to NPM due to a provenance failure that looks like this: ``` error an error occurred while publishing @shopify/theme-language-server-browser: E422 422 Unprocessable Entity - PUT https://registry.npmjs.org/@shopify%2ftheme-language-server-browser - Error verifying sigstore provenance bundle: Failed to validate repository information: package.json: "repository.url" is "git+https://github.com/shopify/theme-tools.git", expected to match "https://github.com/Shopify/theme-tools" from provenance ```
Commits on Jan 31, 2025
-
Merge pull request #746 from Shopify/gg-fix-repository-url
Update repository URL definition to be case sensitive
-
-
Merge pull request #747 from Shopify/changeset-release/main
Theme Tools Release — 2025-01-31
There are no files selected for viewing
Large diffs are not rendered by default.
This file was deleted.
This file was deleted.