Skip to content
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

Support default.setting completion + hover #717

Merged
merged 5 commits into from
Jan 23, 2025
Merged

Support default.setting completion + hover #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
67d9807
Update "PresetsSettings*" providers to "Settings*"
aswamy Jan 17, 2025
79800b2
Add utility for checking if URI is a section/block file
aswamy Jan 17, 2025
bbebc28
Support default.settings completion + hover
aswamy Jan 22, 2025
cc43bc3
Dont fetch metafields during tests
aswamy Jan 17, 2025
d5c123a
Remove `uriPatterns` from JSON providers
aswamy Jan 22, 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
8 changes: 8 additions & 0 deletions .changeset/rotten-needles-allow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@shopify/theme-language-server-common': minor
---

Support `default.settings` completion + hover

- Fix bug where `presets.[].settings` hover only worked on first setting
- Fix bug where preset block completion creates an error when `blocks` isn't defined
8 changes: 4 additions & 4 deletions packages/theme-language-server-common/src/json/JSONContributions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ import { SchemaTranslationHoverProvider } from './hover/providers/SchemaTranslat
import { TranslationPathHoverProvider } from './hover/providers/TranslationPathHoverProvider';
import { RequestContext } from './RequestContext';
import { findSchemaNode } from './utils';
import { PresetsSettingsPropertyCompletionProvider } from './completions/providers/PresetsSettingsPropertyCompletionProvider';
import { PresetsSettingsHoverProvider } from './hover/providers/PresetsSettingsHoverProvider';
import { SettingsPropertyCompletionProvider } from './completions/providers/SettingsPropertyCompletionProvider';
import { SettingsHoverProvider } from './hover/providers/SettingsHoverProvider';

/** The getInfoContribution API will only fallback if we return undefined synchronously */
const SKIP_CONTRIBUTION = undefined as any;
Expand Down Expand Up @@ -54,13 +54,13 @@ export class JSONContributions implements JSONWorkerContribution {
this.hoverProviders = [
new TranslationPathHoverProvider(),
new SchemaTranslationHoverProvider(getDefaultSchemaTranslations),
new PresetsSettingsHoverProvider(getDefaultSchemaTranslations),
new SettingsHoverProvider(getDefaultSchemaTranslations),
];
this.completionProviders = [
new SchemaTranslationsCompletionProvider(getDefaultSchemaTranslations),
new BlockTypeCompletionProvider(getThemeBlockNames),
new PresetsBlockTypeCompletionProvider(getThemeBlockNames, getThemeBlockSchema),
new PresetsSettingsPropertyCompletionProvider(getDefaultSchemaTranslations),
new SettingsPropertyCompletionProvider(getDefaultSchemaTranslations),
];
}

Expand Down
6 changes: 2 additions & 4 deletions ...heme-language-server-common/src/json/completions/providers/BlockTypeCompletionProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { JSONPath } from 'vscode-json-languageservice';
import { JSONCompletionItem } from 'vscode-json-languageservice/lib/umd/jsonContributions';
import { CompletionItemKind } from 'vscode-languageserver-protocol';
import { isLiquidRequestContext, RequestContext } from '../../RequestContext';
import { fileMatch } from '../../utils';
import { isSectionOrBlockFile } from '../../utils';
import { JSONCompletionProvider } from '../JSONCompletionProvider';
import { GetThemeBlockNames } from '../../JSONContributions';

Expand All @@ -28,13 +28,11 @@ import { GetThemeBlockNames } from '../../JSONContributions';
* {% endschema %}
*/
export class BlockTypeCompletionProvider implements JSONCompletionProvider {
private uriPatterns = [/^.*\/(sections|blocks)\/[^\/]*\.liquid$/];

constructor(private getThemeBlockNames: GetThemeBlockNames) {}

async completeValue(context: RequestContext, path: JSONPath): Promise<JSONCompletionItem[]> {
if (
!fileMatch(context.doc.uri, this.uriPatterns) ||
!isSectionOrBlockFile(context.doc.uri) ||
!isLiquidRequestContext(context) ||
!isBlockDefinitionPath(path)
) {
Expand Down
10 changes: 4 additions & 6 deletions ...nguage-server-common/src/json/completions/providers/PresetsBlockTypeCompletionProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { deepGet, isError } from '@shopify/theme-check-common';
import { JSONPath } from 'vscode-json-languageservice';
import { JSONCompletionItem } from 'vscode-json-languageservice/lib/umd/jsonContributions';
import { isLiquidRequestContext, RequestContext } from '../../RequestContext';
import { fileMatch } from '../../utils';
import { isSectionOrBlockFile } from '../../utils';
import { JSONCompletionProvider } from '../JSONCompletionProvider';
import {
createBlockNameCompletionItems,
Expand All @@ -12,7 +12,7 @@ import { GetThemeBlockNames, GetThemeBlockSchema } from '../../JSONContributions

/**
* The PresetsBlockTypeCompletionProvider offers value completions of the
* `presets.[](recursive .blocks.[].type)` keys inside section and theme block `{% schema %}` tags.
* `presets.[](recursive .blocks.[]).type` keys inside section and theme block `{% schema %}` tags.
*
* @example
* {% schema %}
Expand All @@ -28,16 +28,14 @@ import { GetThemeBlockNames, GetThemeBlockSchema } from '../../JSONContributions
* {% endschema %}
*/
export class PresetsBlockTypeCompletionProvider implements JSONCompletionProvider {
private uriPatterns = [/^.*\/(sections|blocks)\/[^\/]*\.liquid$/];

constructor(
private getThemeBlockNames: GetThemeBlockNames,
private getThemeBlockSchema: GetThemeBlockSchema,
) {}

async completeValue(context: RequestContext, path: JSONPath): Promise<JSONCompletionItem[]> {
if (
!fileMatch(context.doc.uri, this.uriPatterns) ||
!isSectionOrBlockFile(context.doc.uri) ||
!isLiquidRequestContext(context) ||
!isPresetBlockPath(path)
) {
Expand Down Expand Up @@ -72,7 +70,7 @@ export class PresetsBlockTypeCompletionProvider implements JSONCompletionProvide
parsedBlockSchema = parentBlockSchema.parsed;
}

const blocks: { type: string }[] = parsedBlockSchema.blocks;
const blocks: { type: string }[] = parsedBlockSchema.blocks || [];

const blockGroups = {
themeBlocks: false,
Expand Down
161 changes: 0 additions & 161 deletions ...r-common/src/json/completions/providers/PresetsSettingsPropertyCompletionProvider.spec.ts
View file
Open in desktop

This file was deleted.

6 changes: 2 additions & 4 deletions ...guage-server-common/src/json/completions/providers/SchemaTranslationCompletionProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@ import {
translationOptions,
} from '../../../translations';
import { isLiquidRequestContext, RequestContext } from '../../RequestContext';
import { fileMatch } from '../../utils';
import { isSectionOrBlockFile } from '../../utils';
import { JSONCompletionItem, JSONCompletionProvider } from '../JSONCompletionProvider';

export class SchemaTranslationsCompletionProvider implements JSONCompletionProvider {
private uriPatterns = [/(sections|blocks)\/[^\/]*\.liquid$/];

constructor(private getDefaultSchemaTranslations: GetTranslationsForURI) {}

async completeValue(context: RequestContext, path: JSONPath): Promise<JSONCompletionItem[]> {
if (!fileMatch(context.doc.uri, this.uriPatterns) || !isLiquidRequestContext(context)) {
if (!isSectionOrBlockFile(context.doc.uri) || !isLiquidRequestContext(context)) {
return [];
}

Expand Down
Loading
Loading