Add config/settings_schema.json JSON schema #536
Conversation
| "json.schemas": [ | ||
| { | ||
| "fileMatch": [ | ||
| "tests/fixtures/section-*.json" | ||
| ], | ||
| "url": "./schemas/theme/section.json" | ||
| }, | ||
| { | ||
| "fileMatch": [ | ||
| "tests/fixtures/translations-*.json" | ||
| ], | ||
| "url": "./schemas/theme/translations.json" | ||
| }, | ||
| { | ||
| "fileMatch": [ | ||
| "tests/fixtures/theme-settings-*.json" | ||
| ], | ||
| "url": "./schemas/theme/theme_settings.json" | ||
| } | ||
| ] |
There was a problem hiding this comment.
This is how we can have VS Code do the intellisense automatically in the fixtures folder. Makes dev-ing things rather easy :)
| "const": "article", | ||
| "description": "A setting of type article outputs an article picker field that's automatically populated with the available articles for the store. You can use these fields to capture an article selection, such as the article to feature on the homepage.", | ||
| "markdownDescription": "A setting of type `article` outputs an article picker field that's automatically populated with the available articles for the store. You can use these fields to capture an article selection, such as the article to feature on the homepage.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#article)" | ||
| }, |
There was a problem hiding this comment.
Turns out that the way to have a "documented enum" is to have a oneOf rule of const. Does the same thing but each const can be documented.
There was a problem hiding this comment.
Makes sense.
Is this something in the official docs or did you do some detective work to find out about this?
I tried to find some explanations on my own and found some info on stackoverflow and github
There was a problem hiding this comment.
(For documentation purposes): Discovered it from trial and error. It's much more verbose, but also probably easier to maintain in the new setup.
Also, add proper validation for color_scheme_group. It's a little less DRY, but also more declarative and easier to understand.
charlespwd
force-pushed
the
feature/better-input-settings-docs
branch
from
a9fd75e to
3be3533
Compare
| "default": true, | ||
| "label": true, | ||
| "info": true, | ||
| "id": true |
There was a problem hiding this comment.
We need those so that additionalProperties validates correctly.
https://json-schema.org/understanding-json-schema/reference/object#extending
| @@ -25,8 +25,7 @@ | |||
| "maximum": 2 | |||
| }, | |||
| "settings": { | |||
| "description": "Section specific settings.", | |||
There was a problem hiding this comment.
AFAIK, we display the markdownDescription on hover - where would the description provided here render?
Followup -> It seems like it will go with
- $ref -> markdownDescription
- $ref -> description
- description from this file
| "properties": { | ||
| "type": { | ||
| "const": "article", | ||
| "description": "A setting of type article outputs an article picker field that's automatically populated with the available articles for the store. You can use these fields to capture an article selection, such as the article to feature on the homepage.", |
There was a problem hiding this comment.
Q for learning: do we need both description and markdownDescription?
There was a problem hiding this comment.
markdownDescription is a undocumented feature of vscode-json-languageservice that lets you resolve links and stuff. Didn't want to have markdown links in editors that don't support it, so I used markdownDescription to put in links.
| "const": "article", | ||
| "description": "A setting of type article outputs an article picker field that's automatically populated with the available articles for the store. You can use these fields to capture an article selection, such as the article to feature on the homepage.", | ||
| "markdownDescription": "A setting of type `article` outputs an article picker field that's automatically populated with the available articles for the store. You can use these fields to capture an article selection, such as the article to feature on the homepage.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#article)" | ||
| }, |
There was a problem hiding this comment.
Makes sense.
Is this something in the official docs or did you do some detective work to find out about this?
I tried to find some explanations on my own and found some info on stackoverflow and github
input-settings.jsonsettings.jsonsetting.jsonFixes Shopify/develop-advanced-edits#149
settings-validation.mp4
To tophat:
tests/fixtures/theme-settings-*.jsonfile, the file association is baked into the VS Code settings of the repo.