https://github.com/nhost/config-schema
https://github.com/nhost/config-schema
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nhost/config-schema
- Owner: nhost
- Created: 2022-05-27T10:53:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-03T20:46:03.000Z (almost 3 years ago)
- Last Synced: 2025-02-13T13:19:32.263Z (4 months ago)
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON schema for Nhost `config.yaml`
_Note_: this is a work in progress
1. Clone this repo
2. Open with VS code (make sure you have the [Yaml extension installed](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml))
3. Open `config.yaml`. What's red won't be taken into account when using the CLI
4. See [this PR](https://github.com/nhost/nhost-config/pull/1/files#diff-5eeedcdc1cc8716f825d02fb2a490d6b6a7ad41d559285a63a583b6702113ec8)
## Rationale
- There is too little documentation about how `config.yaml` works
- Incorrect configuration goes silent
## To do
- As Nhost `config.yaml` extends Hasura's, the `version` field is Hasura config's version, not Nhost's
- the variables hierarchy can be somehow improved
- comma-separated values are strings whereas it could be yaml arrays
- add definition to the [JSON Schema store](https://www.schemastore.org/json/) as most IDEs are using it