Skip to content

Allow disabling theme docset augmentation for vanilla liquid LSP #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yoavbls wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Allow disabling theme docset augmentation for vanilla liquid LSP #1095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bdac93
feat(lsp): allow disabling theme docset augmentation
yoavbls Dec 31, 2025
29d3261
Bump versions
yoavbls Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/theme-language-server-browser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shopify/theme-language-server-browser",
"version": "2.20.0",
"version": "2.20.1",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"author": "CP Clermont <[email protected]>",
Expand All @@ -27,7 +27,7 @@
"type-check": "tsc --noEmit"
},
"dependencies": {
"@shopify/theme-language-server-common": "2.20.0",
"@shopify/theme-language-server-common": "2.20.1",
"vscode-languageserver": "^8.0.2"
}
}
2 changes: 1 addition & 1 deletion packages/theme-language-server-common/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shopify/theme-language-server-common",
"version": "2.20.0",
"version": "2.20.1",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"author": "CP Clermont <[email protected]>",
Expand Down
5 changes: 4 additions & 1 deletion packages/theme-language-server-common/src/server/startServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export function startServer(
jsonValidationSet,
themeDocset: remoteThemeDocset,
fetchMetafieldDefinitionsForURI,
augmentDocset = true,
}: Dependencies,
) {
const fs = new CachedFileSystem(injectedFs);
Expand Down Expand Up @@ -175,7 +176,9 @@ export function startServer(
};

// These are augmented here so that the caching is maintained over different runs.
const themeDocset = new AugmentedThemeDocset(remoteThemeDocset);
// Allow consumers to disable augmentation for vanilla liquid LSP
const themeDocset =
augmentDocset ? new AugmentedThemeDocset(remoteThemeDocset) : remoteThemeDocset;
const cssLanguageService = new CSSLanguageService(documentManager);
const runChecks = debounce(
makeRunChecks(documentManager, diagnosticsManager, {
Expand Down
8 changes: 8 additions & 0 deletions packages/theme-language-server-common/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,14 @@ export interface RequiredDependencies {
* This should only be used in node environments; not on the browser.
*/
fetchMetafieldDefinitionsForURI: (uri: URI) => Promise<void>;

/**
* Controls augmentation of the provided ThemeDocset.
Copy link
Contributor

@graygilmore graygilmore Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could be a little more specific here. Something like:

Suggested change
* Controls augmentation of the provided ThemeDocset.
* Controls whether Shopify-specific Liquid should be included

And we could even rename the option to something like includeShopifyTags or something like that. @Shopify/developer-tools what do you think?

*
* - true (default): wrap with AugmentedThemeDocset
* - false: use the provided ThemeDocset as-is
*/
augmentDocset?: boolean;
}

export namespace ThemeGraphReferenceRequest {
Expand Down
4 changes: 2 additions & 2 deletions packages/theme-language-server-node/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shopify/theme-language-server-node",
"version": "2.20.0",
"version": "2.20.1",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"author": "CP Clermont <[email protected]>",
Expand Down Expand Up @@ -29,7 +29,7 @@
"dependencies": {
"@shopify/theme-check-docs-updater": "^3.23.0",
"@shopify/theme-check-node": "^3.23.0",
"@shopify/theme-language-server-common": "2.20.0",
"@shopify/theme-language-server-common": "2.20.1",
"glob": "^8.0.3",
"node-fetch": "^2.6.11",
"vscode-languageserver": "^8.0.2",
Expand Down