You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,22 +16,6 @@ Kirby 5 is the active schema target. New docs-parity fixes, fixture updates and
16
16
17
17
The Kirby 3 and Kirby 4 schemas remain downloadable as frozen legacy artifacts, but they do not receive new docs-parity fixes or refactor work.
18
18
19
-
## What v5.4.0 Is About
20
-
21
-
v5.4.0 is not just a version bump. It is a Kirby 5 schema parity release.
22
-
23
-
The schema was audited against Kirby 5's upstream blueprint, field, section and Panel code. The main goal was to reduce false errors in IDEs for blueprint shapes that Kirby 5 really accepts, while also rejecting shapes that were only accepted by this schema by accident.
24
-
25
-
Highlights:
26
-
27
-
-`kirby5-blueprints.schema.json` is now generated from smaller source files in `schema/kirby5/**`.
28
-
- The test suite now validates canonical fixtures, official docs examples, Starterkit blueprints, reusable shape variants and pinned property manifests.
29
-
- Kirby 5-only support was expanded for translated labels/text, richer `options` forms, query/API option providers, fieldset shorthands, optional column widths, blueprint buttons, page preset inputs, boolean blueprint `options`/`permissions`, file `accept: true` and additional field properties.
30
-
- Over-accepted shapes were tightened for picker and section `query`/`search`, files/pages sections, `link.options`, `headline.numbered`, stats sizes and numeric `step` values.
31
-
- Known defaults were corrected for `date.calendar`, `textarea.spellcheck`, `files.multiple` and `structure.prepend`.
32
-
33
-
In short: v5.4.0 makes the Kirby 5 schema more faithful to Kirby itself. It does not try to model dynamic behavior such as `extends` resolution, plugin-defined fields/sections or runtime blueprint mutations.
34
-
35
19
## Install
36
20
37
21
### Schemastore (not yet)
@@ -112,6 +96,23 @@ fields:
112
96
113
97
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.
114
98
99
+
## What v5.4.0 Is About
100
+
101
+
v5.4.0 is not just a version bump. It is a Kirby 5 schema parity release.
102
+
103
+
The schema was audited against Kirby 5's upstream blueprint, field, section and Panel code. The main goal was to reduce false errors in IDEs for blueprint shapes that Kirby 5 really accepts, while also rejecting shapes that were only accepted by this schema by accident.
104
+
105
+
Highlights:
106
+
107
+
-`kirby5-blueprints.schema.json` is now generated from smaller source files in `schema/kirby5/**`.
108
+
- The test suite now validates canonical fixtures, official docs examples, Starterkit blueprints, reusable shape variants and pinned property manifests.
109
+
- The current test suite covers 1742 tests.
110
+
- Kirby 5-only support was expanded for translated labels/text, richer `options` forms, query/API option providers, fieldset shorthands, optional column widths, blueprint buttons, page preset inputs, boolean blueprint `options`/`permissions`, file `accept: true` and additional field properties.
111
+
- Over-accepted shapes were tightened for picker and section `query`/`search`, files/pages sections, `link.options`, `headline.numbered`, stats sizes and numeric `step` values.
112
+
- Known defaults were corrected for `date.calendar`, `textarea.spellcheck`, `files.multiple` and `structure.prepend`.
113
+
114
+
In short: v5.4.0 makes the Kirby 5 schema more faithful to Kirby itself. It does not try to model dynamic behavior such as `extends` resolution, plugin-defined fields/sections or runtime blueprint mutations.
115
+
115
116
## Validate
116
117
117
118
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