@sdboyer/thema-ui 0.0.0-stage → 0.1.0

package/errors/E0331.md

@@ -0,0 +1,64 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0331: a mapping's key is not a plain field name
+
+A mapping's key is a plain field name: the target field it produces. A quoted,
+computed or pattern label is not one.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		"\("b")": v0_0.a
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+```
+
+thema reports:
+
+```
+error[E0331]: a mapping's key is a plain field name
+ --> history/1.0.thema:8:3
+  |
+8 |         "\("b")": v0_0.a
+  |         ^^^^
+  |
+
+error[E0346]: ForwardLens produces nothing for b, which 1.0 requires: add b: <mapping> to v1_0
+ --> history/1.0.thema:5:1
+  |
+5 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+
+error[E0347]: 0.0 declares a and 1.0 does not, and nothing maps it: write <field>: v0_0.a to move it, or a: _drop
+ --> history/1.0.thema:5:1
+  |
+5 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+```

package/errors/E0332.md

@@ -0,0 +1,52 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0332: a mapping has an attribute
+
+Nothing attaches to a mapping. A lacuna is declared in the lens's lacunas
+field, keyed by the mapping it describes, not as an attribute on the mapping.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	firstfield: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	firstfield:  string
+	secondfield: int
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		secondfield: -1 @lacuna(Placeholder, "-1 is a placeholder")
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	firstfield:  string
+	secondfield: int
+}
+```
+
+thema reports:
+
+```
+error[E0332]: a mapping has no attributes; a lacuna is declared in the lens's lacunas field, keyed by the mapping
+ --> history/1.0.thema:9:19
+  |
+9 |         secondfield: -1 @lacuna(Placeholder, "-1 is a placeholder")
+  |                         ^
+  |
+```

package/errors/E0333.md

@@ -0,0 +1,61 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0333: a lens body or its lacunas declare a hidden field or a definition
+
+A lens maps data fields. A hidden field (_x) or a definition (#X) is not
+data, so a lens body and its lacunas have neither. That also keeps the
+operations, spelled _drop, _coalesce, _match and _each, and _item from ever
+naming a field.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	kind: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	kind: "a" | "b"
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		_match: "a"
+		kind: _match(v0_0.kind, {"a": "a", [_]: "b"})
+	}
+	lacunas: {
+		kind: [{
+			type:    LossyFieldMapping
+			message: "kinds other than a become b"
+		}]
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	kind: "a" | "b"
+}
+```
+
+thema reports:
+
+```
+error[E0333]: the ForwardLens in history/1.0.thema declares _match, a hidden field, which is not data
+ --> history/1.0.thema:8:3
+  |
+8 |         _match: "a"
+  |         ^^^^^^
+  |
+  = note: a lens maps data fields, so a key is a field of the target, or of its lacunas, by name
+  = help: remove it; to map a field whose name starts with _ or #, quote the key: "_match": ...
+```

package/errors/E0334.md

@@ -0,0 +1,61 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0334: a nested body embeds something other than a path into the source instance
+
+A nested body may embed a path into the source instance, `{v0_0.meta, x: 1}`,
+to copy the fields found there and add to them. It may embed nothing else.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	meta: {
+		owner: string
+	}
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	meta: {
+		owner: string
+		team:  string
+	}
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		meta: {
+			defaults
+			team: "unassigned"
+		}
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	meta: {
+		owner: string
+		team:  string
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0334]: a nested body may embed only v0_0.<path>, to copy from it
+  --> history/1.0.thema:12:4
+   |
+12 |             defaults
+   |             ^^^^^^^^
+   |
+```

package/errors/E0335.md

@@ -0,0 +1,57 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0335: a _coalesce is not _coalesce(source path, fallback)
+
+coalesce takes two arguments: a reference into the source instance, and the
+fallback to use when the referenced field is absent.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a?: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		b: _coalesce(v0_0.a)
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+```
+
+thema reports:
+
+```
+error[E0335]: _coalesce takes two arguments: _coalesce(v0_0.<path>, fallback)
+ --> history/1.0.thema:8:6
+  |
+8 |         b: _coalesce(v0_0.a)
+  |            ^^^^^^^^^
+  |
+
+error[E0347]: 0.0 declares a and 1.0 does not, and nothing maps it: write <field>: v0_0.a to move it, or a: _drop
+ --> history/1.0.thema:5:1
+  |
+5 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+```

package/errors/E0336.md

@@ -0,0 +1,50 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0336: a _match is not _match(source path, arms)
+
+match takes two arguments: a reference into the source instance, and its
+arms, a struct of `value: value` entries with an optional `[_]` catch-all.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	kind: "a" | "b"
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	kind: 1 | 2
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		kind: _match(v0_0.kind)
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	kind: 1 | 2
+}
+```
+
+thema reports:
+
+```
+error[E0336]: _match takes two arguments: _match(v0_0.<path>, {...})
+ --> history/1.0.thema:8:9
+  |
+8 |         kind: _match(v0_0.kind)
+  |               ^^^^^^
+  |
+```

package/errors/E0337.md

@@ -0,0 +1,54 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0337: an _each is not _each(source list, body)
+
+each takes two arguments: a reference to a list in the source instance, and a
+body of mappings over `item`, applied to each element.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	items: [...{
+		title: string
+	}]
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	items: [...{
+		name: string
+	}]
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		items: _each(v0_0.items)
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	items: [...{name: string}]
+}
+```
+
+thema reports:
+
+```
+error[E0337]: _each takes two arguments: _each(v0_0.<list>, {...})
+  --> history/1.0.thema:10:10
+   |
+10 |         items: _each(v0_0.items)
+   |                ^^^^^
+   |
+```

package/errors/E0338.md

@@ -0,0 +1,62 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0338: a _match's arms are not constant arms with at most one catch-all
+
+A match's arms are a struct of `value: value` entries, each matching one
+source constant to one target constant, with at most one `[_]` catch-all arm.
+An arm's value that is not a constant is not one.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	kind: "a" | "b"
+	x:    int
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	kind: int
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		kind: _match(v0_0.kind, {
+			"a": v0_0.x
+			"b": 2
+		})
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	kind: int
+}
+```
+
+thema reports:
+
+```
+error[E0338]: a _match arm's value must be a constant
+ --> history/1.0.thema:9:9
+  |
+9 |             "a": v0_0.x
+  |                  ^^^^
+  |
+
+error[E0347]: 0.0 declares x and 1.0 does not, and nothing maps it: write <field>: v0_0.x to move it, or x: _drop
+ --> history/1.0.thema:5:1
+  |
+5 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+```

package/errors/E0340.md

@@ -0,0 +1,57 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0340: a lens reads a field its source version does not declare
+
+A mapping reads a field its source version does not declare. No instance of the
+source has it, so the lens never has a value to copy.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		b: v0_0.nope
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+```
+
+thema reports:
+
+```
+error[E0340]: 0.0 does not declare nope
+ --> history/1.0.thema:8:6
+  |
+8 |         b: v0_0.nope
+  |            ^^^^
+  |
+
+error[E0347]: 0.0 declares a and 1.0 does not, and nothing maps it: write <field>: v0_0.a to move it, or a: _drop
+ --> history/1.0.thema:5:1
+  |
+5 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+```

package/errors/E0341.md

@@ -0,0 +1,51 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0341: a lens maps a field its target version does not declare
+
+A mapping produces a field its target version does not declare. A lens writes
+only what its target declares, however open the author wrote the schema.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		b:    v0_0.a
+		nope: v0_0.a
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	b: string
+}
+```
+
+thema reports:
+
+```
+error[E0341]: 1.0 does not declare nope
+ --> history/1.0.thema:9:3
+  |
+9 |         nope: v0_0.a
+  |         ^^^^
+  |
+```

package/errors/E0342.md

@@ -0,0 +1,53 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0342: a lens drops a field its target version requires
+
+A drop says a source field has no place in the target. Where the target
+requires a field of that name, dropping it would leave a required field absent.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		a: _drop
+		b: 1
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+```
+
+thema reports:
+
+```
+error[E0342]: 1.0 requires a; dropping it would leave it absent
+ --> history/1.0.thema:9:3
+  |
+9 |         a: _drop
+  |         ^
+  |
+```

package/errors/E0343.md

@@ -0,0 +1,56 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0343: a lens moves an optional field to a required one with no fallback
+
+A field optional in the source and required in the target cannot simply be
+copied: an instance that lacks it would have nothing to put there. coalesce says
+what to use when it is absent.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a:  string
+	b?: int
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+	c: bool
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		c: true
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+	c: bool
+}
+```
+
+thema reports:
+
+```
+error[E0343]: b is optional in 0.0 and required in 1.0: write b: _coalesce(v0_0.b, <fallback>) to say what to use when it is absent
+ --> history/1.0.thema:3:2
+  |
+3 |     b: int
+  |     ^
+  |
+```