Add theme block type completion in {% schema %}
#632
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `BlockTypeCompletionProvider` offers value completions of the
`blocks.[].type` property inside section and theme block `{% schema %}` tags.
```liquid
{% schema %}
{
"blocks": [
{ "type": "█" },
]
}
{% endschema %}
```
Fixes #627
charlespwd
force-pushed
the
feature/block-type-completion-example
branch
from
13ff1da
to
b041721
Compare
charlespwd
commented
Dec 2, 2024
Comment on lines
+69
to
+71
| export function isPresetBlockPath(path: JSONPath) { | ||
| return path.at(0) === 'presets'; | ||
| } |
There was a problem hiding this comment.
Unused but might want to refactor and use for #628
charlespwd
commented
Dec 2, 2024
Comment on lines
+76
to
+82
| // - presets.[](recursive .blocks.[].type) | ||
| // - presets.[](recursive .blocks.{}.type) | ||
| const topLevel = path.at(0); | ||
| if (topLevel !== 'blocks' && topLevel !== 'presets') return false; | ||
| if (path.length < 4) return false; // minimum path length | ||
| const [shouldBeBlocks, _idOrIndex, shouldBeType] = path.slice(-3); | ||
| return shouldBeBlocks === 'blocks' && shouldBeType === 'type'; |
There was a problem hiding this comment.
Same that was something I used before I planned to split #628 to a different provider
graygilmore
approved these changes
Dec 2, 2024
| @@ -166,7 +166,11 @@ export class DocumentManager { | |||
|
|
|||
| /** Lazy and only computed once per file version */ | |||
| getSchema: memo(async () => { | |||
| if (!this.getModeForUri || !this.isValidSchema) return undefined; | |||
| // For when you don't care about validation... (e.g. tests) | |||
There was a problem hiding this comment.
Maybe we could only return this is a test env?
Comment on lines
+59
to
+60
| label: `"${name}"`, | ||
| insertText: `"${name}"`, |
There was a problem hiding this comment.
Suggested change
| label: `"${name}"`, | |
| insertText: `"${name}"`, | |
| label: name, | |
| insertText: name, |
My eyes might be deceiving me but I think we can just do this?
| } from 'vscode-languageserver-protocol'; | ||
| import { DocumentManager } from '../../documents'; | ||
|
|
||
| export function getParams( |
There was a problem hiding this comment.
Are these really "params"? Maybe I need to rethink what I think params are in theme-tools context?
Edit: ah, I see these were just copy/pasted from an existing file anyways
| expect(completions.items.map((item) => item.label)).to.include.members([ | ||
| '"@app"', | ||
| '"@theme"', | ||
| ...blockNames.map((x) => `"${x}"`), |
There was a problem hiding this comment.
Interpolation overload perhaps?
Suggested change
| ...blockNames.map((x) => `"${x}"`), | |
| ...blockNames, |
Comment on lines
+124
to
+126
| expect(completions.items.map((item) => item.label)).not.to.include.members([ | ||
| ...blockNames.map((x) => `"${x}"`), | ||
| ]); |
There was a problem hiding this comment.
Suggested change
| expect(completions.items.map((item) => item.label)).not.to.include.members([ | |
| ...blockNames.map((x) => `"${x}"`), | |
| ]); | |
| expect(completions.items.map((item) => item.label)).not.to.include.members(blockNames); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you adding in this PR?
The
BlockTypeCompletionProvideroffers value completions of theblocks.[].typeproperty inside section and theme block{% schema %}tags.{% schema %} { "blocks": [ { "type": "█" }, ] } {% endschema %}Fixes #627
block-type-completion.mp4
What's next? Any followup issues?
#545
Before you deploy
changeset