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.

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

Introduce JSON Schemas support #20

Open
karreiro opened this issue Nov 4, 2022 · 1 comment
Open

Introduce JSON Schemas support #20

karreiro opened this issue Nov 4, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@karreiro
Copy link
Contributor

karreiro commented Nov 4, 2022

Is your feature request related to a problem? Please describe.

Introducing support to JSON Schemas would make the usage of this repository smoother. It would also document objects for free and set expectations about the data structures.

Describe the solution you'd like
TBD

Describe alternatives you've considered
TBD

@karreiro karreiro added the enhancement New feature or request label Nov 4, 2022
@panoply
Copy link

panoply commented Feb 18, 2023

@karreiro

I will likely get through these by next week and currently only objects and filters are supported. For the sake of convenience and because I consume them within the Liquify monorepo they are available in the Liquify Schema submodule.

Feel free to apply or use as a strap reference.

Objects

https://unpkg.com/@liquify/schema/theme-docs/objects.json

CDN: https://unpkg.com/@liquify/schema/theme-docs/objects.json
RAW: https://github.com/panoply/liquify-schema/blob/master/stores/theme-docs-objects.json

Filters

https://unpkg.com/@liquify/schema/theme-docs/filters.json

CDN: https://unpkg.com/@liquify/schema/theme-docs/filters.json
RAW: https://github.com/panoply/liquify-schema/blob/master/stores/theme-docs-filters.json

Tags

TODO

Note 

Because the JSON data structures use array types, it is not possible to simply leverage the integrated $schema prop for inferring the stores within text editors that implement JSON LSP. Folks will need to match stores from within their appropriate editor configs (i.e: workspace settings).
 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants