https://github.com/bnomei/kirby-schema
JSON Schema file for Kirby CMS blueprints
https://github.com/bnomei/kirby-schema
autocompletion blueprint json-schema kirby kirby-cms phpstorm validation vscode yaml
Last synced: about 1 month ago
JSON representation
JSON Schema file for Kirby CMS blueprints
- Host: GitHub
- URL: https://github.com/bnomei/kirby-schema
- Owner: bnomei
- License: mit
- Created: 2022-06-25T12:39:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-24T13:15:43.000Z (2 months ago)
- Last Synced: 2026-01-25T01:09:11.746Z (2 months ago)
- Topics: autocompletion, blueprint, json-schema, kirby, kirby-cms, phpstorm, validation, vscode, yaml
- Language: JavaScript
- Homepage: https://forum.getkirby.com/t/blueprint-yaml-file-autocompletion-and-validation-in-your-favourite-code-editor/25905
- Size: 565 KB
- Stars: 50
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kirby JSON Schema
[](https://getkirby.com)
[](https://getkirby.com)
[](https://getkirby.com)
[](https://discordapp.com/users/bnomei)
[](https://www.buymeacoffee.com/bnomei)
JSON Schema file for Kirby blueprints
## Install
### Schemastore (not yet)
Ideally, this repo's schema would be available from the [Schemastore](https://www.schemastore.org/json/), and there would be almost zero configuration in most IDEs. But that is something the Kirby CMS team should eventually do, not me.
### Download the Schema
You can clone the entire repo or download the file `kirbyX-blueprints.schema.json`, where `X` matches your intended Kirby version. Put that file inside your project or in a global space of your dev setup. Then configure your IDE to use that file to get Schema information for Kirby's blueprints.
## Configure your IDE
### VSCode
You will need the [Red Hat VS Code YAML Extension](https://github.com/redhat-developer/vscode-yaml), and then you can use the `yaml.schemas` setting to add your schema like this:
```yaml
"yaml.schemas": {
"/path/to/your/schema/kirby5-blueprints.schema.json": "site/blueprints/**/*.yml"
}
```
or via an URL (thanks @janstuemmel)
```yaml
"yaml.schemas": {
"https://raw.githubusercontent.com/bnomei/kirby-schema/refs/heads/main/kirby5-blueprints.schema.json": "site/blueprints/**/*.yml"
}
```
This will automatically use the schema for all blueprint files.
The extension prepends `/` on the path so its `/~/YOUR_FOLDER/kirby3-schema/kirby5-blueprints.schema.json`.
> [!NOTE]
> thanks @tobimori and @iskrisis
### PHPStorm
Clone this repo to your local machine. Open the IDE settings and search for `JSON Schema`. Then select `Languages & Frameworks` » `Schemas and DTDs` » `JSON Schema Mappings`. Click the `+` button at the top to add a new JSON validate configuration. Then, fill in the corresponding name, file or URL, and version.
For testing, I mapped it to my `site/blueprints` folder.
### Sublime Text
You can use the schema in Sublime Text by cloning this repo to your local machine and setting a custom JSON schema location using [this Sublime Text extension](https://github.com/sublimelsp/LSP-json?tab=readme-ov-file#custom-schemas]) and wildcards in `fileMatch` [schema settings](https://github.com/sublimelsp/LSP-yaml/blob/7b928a7b84f25381b01fa98c04ca7b1418b3a465/LSP-yaml.sublime-settings#L37) ([more](https://github.com/sublimelsp/LSP-json?tab=readme-ov-file#custom-schemas)).
## Blueprint detection
Since Kirby reuses some types like `file`, `info`, `pages` in fields and sections the schema cannot always determine which blueprint you are working on with absolute certainty. For now, I introduced a `blueprint` property to solve this. Use it in your `block`, `field`, `file`, `page`, `section`, `site`, `tab` and `user` blueprints.
```diff
+ blueprint: site
title: My Site Blueprint
fields:
text:
type: text
```
```diff
+ blueprint: page
title: My Page Blueprint
fields:
text:
type: text
```
> [!IMPORTANT]
> Adding the `blueprint` property does not affect Kirby in any way. It is just a hint for your IDE. It's safe to share such blueprints with colleagues that do not have the schema installed.
## Known Limitations
### Extends - Here be Dragons
The `extends` property on blueprint definitions is an edge case for the schema. The schema is a pattern matcher at heart, and it cannot validate what you are extending from in inspecting referenced files. There is no way that I am aware of to make `extends` play nice. For that reason I decided to have the schema surface an error instead of muting/hiding the inability to validate that part of the blueprint.
## Validate
Check out the test files in the `tests` folder on how to programmatically validate your blueprints with the schema. You can use a similar setup in your CI pipeline.
## Disclaimer
This schema is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-schema/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this schema in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.