mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-17 06:11:21 +01:00
feat(wm): JSON schemas, and the module's typed options
komorebi.json is described as a JSON Schema, made from the Rust types that read it: komorebic prints the schema of komorebi.json, of an applications.json, of a notification and of a message, and the daemon answers the same four questions on its socket. schema.json and schema.asc.json are committed (just jsonschema). The module's config option is typed from the schema: schemars-nixgen makes nix/komorebi-options.nix from schema.json (just nixgen), so a layout komorebi does not have, or a value of the wrong kind, does not evaluate. The module writes config as a komorebi.json and gives it to the daemon with --config. configFile and the file the module writes are checked against the schema when the system is built. applicationSpecificConfiguration takes files from GitHub, and there are none by default, since no community file for Plasma is known. Two checks keep the generated files honest without the tools that make them. schema-fresh compares the schemas with what komorebic prints, and the hash on the first line of the options with the schema. nix-options-validation evaluates the options against the example configuration, written in Nix and in JSON. nixos-module-eval also evaluates the module with the sources turned off: with applicationSpecificConfiguration.enable = false the sources are left out of the config that is written, and with no config either there is nothing to write and the unit passes no --config. ARCHITECTURE has the guarantee row that names the two checks.
This commit is contained in:
1 parent
ed34286bca
commit
3a3a0f8f24
29 files changed
+2754
-49
No files matched your search
@@ -187,3 +187,32 @@ index of the workspace, the number of containers and the layout;
|
||||
[`named-workspace-layout-rule`](../cli/named-workspace-layout-rule.md) takes the name of the
|
||||
workspace instead. A rule for a count that has one replaces it. The clear commands take every
|
||||
rule of the workspace away and leave it with the layout it has.
|
||||
|
||||
## The schema
|
||||
|
||||
The Rust types that read `komorebi.json` also describe it as a JSON Schema, which an editor can
|
||||
check the file against, and which the NixOS module is typed from. [`schema.json`](../../schema.json)
|
||||
in the repository is the schema of `komorebi.json`, [`schema.asc.json`](../../schema.asc.json) the
|
||||
schema of an [`applications.json`](application-specific-configuration.md), and the commands print
|
||||
them (and two more), without a daemon:
|
||||
|
||||
```sh
|
||||
komorebic static-config-schema
|
||||
komorebic application-specific-configuration-schema
|
||||
komorebic notification-schema
|
||||
komorebic socket-schema
|
||||
```
|
||||
|
||||
[`notification-schema`](../cli/notification-schema.md) is the schema of what a
|
||||
[subscriber](subscribing-to-notifications.md) is sent, and
|
||||
[`socket-schema`](../cli/socket-schema.md) the schema of a message. To check a file by hand:
|
||||
|
||||
```sh
|
||||
komorebic static-config-schema > schema.json
|
||||
check-jsonschema --schemafile schema.json ~/.config/komorebi/komorebi.json
|
||||
```
|
||||
|
||||
`check-jsonschema` reads plain JSON, so comments in the file have to come out first. The schema
|
||||
does not stop komorebi from reading a file that does not follow it: a key it does not have is
|
||||
dropped, as [above](#one-file-for-every-platform).
|
||||
|
||||
Reference in new issue
Block a user