Feature/preset block settings completion #732
Open
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
aswamy
force-pushed
the
feature/preset-block-settings-completion
branch
from
3d3ab01 to
1ca8046
Compare
aswamy
force-pushed
the
feature/preset-block-settings-completion
branch
from
1ca8046 to
e875edf
Compare
aswamy
force-pushed
the
feature/preset-block-settings-completion
branch
from
e875edf to
820091c
Compare
graygilmore
approved these changes
Jan 29, 2025
| @@ -169,7 +169,7 @@ export class DocumentManager { | |||
| if (!this.getModeForUri || !this.isValidSchema) return undefined; | |||
|
|
|||
| const mode = await this.getModeForUri!(uri); | |||
| return toSchema(mode, uri, sourceCode, this.isValidSchema); | |||
| return toSchema(mode, uri, sourceCode, this.isValidSchema, false); | |||
There was a problem hiding this comment.
Great question! This is definitely going to be a controversial take here. Would love to get @charlespwd 's opinion on it before i merge.
- Our default schema parser is very strict (does not like any syntax errors)
- But if you are a dev who's typing their schema, you're going to have syntax errors while typing.
- E.g. You haven't provided a value for the key you are about to type
"presets": [ { "settings": { "█" } } ]- You need auto-completion to type inside that quotes, but since your schema is invalid, all auto-completion gets disabled (BAD)
- We need less strict JSON parsing (at least during completion, hovers, etc.) BUT not during theme checks
There was a problem hiding this comment.
Ah! That makes sense to me I think. Not sure what else we could do otherwise, tbh.
| * The PresetsBlockSettingsPropertyCompletionProvider offers value completions of the | ||
| * `presets.[].(recursive blocks.[]).settings` keys inside section and theme block `{% schema %}` tags. | ||
| * | ||
| * @example |
There was a problem hiding this comment.
Love including the description and example here. I will add this to the branch I'm working on!
There was a problem hiding this comment.
Worth adding tests specifically for this function?
| import { Translations } from '@shopify/theme-check-common'; | ||
|
|
||
| export function schemaSettingsPropertyCompletionItems( | ||
| parsedSchema: any, |
There was a problem hiding this comment.
Are we able to get rid of the anys in here?
There was a problem hiding this comment.
Unfortunately, valid schemas returned from getSchema are any so not much i can do here.
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?
Fixes #623
Testing
example:
What's next? Any followup issues?
Pickup remaining tasks under #545
Before you deploy
changeset