@syncify/schema
v0.2.4
Published
JSON Store for Syncify Shared Schema
Downloads
67
Readme
@syncify/schema
This module contains JSON Schema Stores for Syncify. Syncify is an enterprise level Shopify theme development tool and exists as a superior alternative to the Shopify CLI.
Install
You don't need to install this module. Reference it using the CDN urls.
$ pnpm add @syncify/schema -D
Usage
When referencing a schema, it is assumed that your text editor supports JSON $schema
properties.
{
"$schema": "https://unpkg.com/@syncify/schema/<name>.json",
}
Replace the
<name>
with one of the below available stores.
Stores
Below the available schema stores provided in this module.
sections
JSON Schema used for providing intellisense features for shared section files.
{
"$schema": "https://unpkg.com/@syncify/schema/sections.json",
"foo": {
"type": "image_picker",
"id": "some_id",
"label": "Lorem Ipsum"
}
}
package
JSON Schema for the syncify
key of package.json
files.
{
"json.schemas": [
{
"url": "https://unpkg.com/@syncify/schema/syncify.json",
"fileMatch": [
"package.json"
]
}
]
}
env
JSON Schema used for providing intellisense features for .env.syncify
or .env.syncify.json
- This store requires you provide VSCode workspace settings configuration.
{
"json.schemas": [
{
"url": "https://unpkg.com/@syncify/schema/env.json",
"fileMatch": [
".env.syncify",
".env.syncify.json"
]
}
]
}
Contributing
The Syncify Schema Stores are generated and maintained in Liquify.