Skip to content

Commit 56e4129

Browse files
committed
📝 explained extends props limitations
Signed-off-by: Bruno Meilick <[email protected]>
1 parent 4b1dc52 commit 56e4129

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@ fields:
7676
> [!IMPORTANT]
7777
> 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.
7878
79+
## Known Limitations
80+
81+
### Extends - Here be Dragons
82+
83+
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.
84+
7985
## Validate
8086

8187
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.

0 commit comments

Comments
 (0)