@sdboyer/thema-ui 0.0.0-stage → 0.1.0

package/errors/E0102.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0102: a version file is not CUE syntax
+
+A version file is CUE syntax. CUE's parser found something it could not read;
+its account is in the detail, positioned where parsing failed.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+```
+
+thema reports:
+
+```
+error[E0102]: a version file is not CUE syntax
+ --> history/0.0.thema:2:12
+  |
+2 |     a: string
+  |              ^
+  |
+  = detail: expected '}', found 'EOF'
+```

package/errors/E0103.md

@@ -0,0 +1,41 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0103: a version file has a package clause
+
+A version file is not a CUE package: it is one version of one lineage, and the
+compiler assembles the lineage from the files. A package clause does not belong
+in it.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+package ship
+
+Schema: {
+	a: string
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+package ship
+
+Schema: {
+	a: string
+}
+```
+
+thema reports:
+
+```
+error[E0103]: history/0.0.thema has a package clause
+ --> history/0.0.thema:1:1
+  |
+1 | package ship
+  | ^^^^^^^
+  |
+  = help: a version file is not a CUE package; remove the clause
+```

package/errors/E0104.md

@@ -0,0 +1,5 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0104: a version file imports a package
+
+**Retired.** A version file may import CUE's builtin packages since #104. An import of any other package is E0143, the rule for schemas and lenses in either form.

package/errors/E0105.md

@@ -0,0 +1,62 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0105: a version file has a field that is not schema, ForwardLens or BackwardLens
+
+A version file has at most three fields: schema, ForwardLens and BackwardLens.
+Anything else is usually a typo; when the name is close to one of the three,
+the help names it.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+scehma: {
+	a: string
+	b: int
+}
+
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		b: 1
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+scehma: {
+	a: string
+	b: int
+}
+```
+
+thema reports:
+
+```
+error[E0105]: scehma is not a field of a version file
+ --> history/1.0.thema:1:1
+  |
+1 | scehma: {
+  | ^^^^^^
+  |
+  = help: did you mean Schema?
+
+error[E0108]: history/1.0.thema declares no Schema
+ --> history/1.0.thema:1:1
+  |
+1 | scehma: {
+  | ^^^^^^
+  |
+  = help: every version file declares Schema: {...}
+```

package/errors/E0106.md

@@ -0,0 +1,46 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0106: a version file declares a field twice
+
+A version file declares each of its fields once. CUE would unify two
+declarations of schema; a version file has one schema, written in one place.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+
+Schema: {
+	b: int
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+
+Schema: {
+	b: int
+}
+```
+
+thema reports:
+
+```
+error[E0106]: history/0.0.thema declares Schema twice
+ --> history/0.0.thema:5:1
+  |
+1 | Schema: {
+  | ------ first declared here
+...
+5 | Schema: {
+  | ^^^^^^
+  |
+```

package/errors/E0107.md

@@ -0,0 +1,48 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0107: a lens block is not a struct
+
+A lens block is a struct: `{v<from>: _, v<to>: {...}}`, declaring the instance
+the lens takes and the body that produces the instance it returns.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+
+ForwardLens: 5
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+```
+
+thema reports:
+
+```
+error[E0107]: ForwardLens is not a struct
+ --> history/1.0.thema:6:14
+  |
+6 | ForwardLens: 5
+  |              ^
+  |
+  = help: a lens block is {v<from>: _, v<to>: {...}}, naming the tip's instance tip
+```

package/errors/E0108.md

@@ -0,0 +1,45 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0108: a version file declares no schema
+
+Every version file declares a schema; that is what a version is. A file with
+only lenses has nothing for them to map to.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+ForwardLens: {
+	v0_0: _
+	v1_0: {
+		a: v0_0.a
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+
+```
+
+thema reports:
+
+```
+error[E0108]: history/1.0.thema declares no Schema
+ --> history/1.0.thema:1:1
+  |
+1 | ForwardLens: {
+  | ^^^^^^^^^^^
+  |
+  = help: every version file declares Schema: {...}
+```

package/errors/E0109.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0109: a version file uses CUE's struct shorthand
+
+A version file's three fields, Schema, ForwardLens and BackwardLens, keep
+their braces, so that each reads as the block it is. CUE's struct shorthand,
+`Schema: a: b`, collapses one into a line, and is refused there. Beneath the
+three fields the shorthand is accepted; thema's formatter expands it.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: name: string
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	name: string
+}
+```
+
+thema reports:
+
+```
+error[E0109]: Schema: name: ... is CUE's struct shorthand, which a version file's Schema does not use
+ --> history/0.0.thema:1:9
+  |
+1 | Schema: name: string
+  |         ^^^^
+  |
+  = note: a version file's three fields keep their braces, so that each reads as the block it is
+  = help: write Schema: {name: ...}
+```

package/errors/E0110.md

@@ -0,0 +1,17 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0110: the lineage's directory has no version files
+
+The lineage has no frozen versions under `history/`. Binding reads only the
+frozen versions, and ignores the tip, so a lineage whose only version is its
+tip binds only on the development path, until the tip is cut to
+`history/0.0.thema`.
+
+thema reports:
+
+```
+error[E0110]: the lineage has no versions under history/
+  |
+  = note: binding reads the frozen versions under history/ and ignores the tip; a lineage whose only version is its tip binds only on the development path
+  = help: cut the tip to history/0.0.thema
+```

package/errors/E0111.md

@@ -0,0 +1,55 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0111: a lens block is not shaped as a lens
+
+A lens block reads like a function: `{v0_0: _, v1_0: {...}}` declares that the
+lens takes an instance of 0.0 and produces an instance of 1.0, with an optional
+`lacunas: {...}`. Here the instance it takes is given a type, where it must be
+`_`: the lens takes any instance of its source version.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`ship/history/1.0.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+
+ForwardLens: {
+	v0_0: {a: string}
+	v1_0: {
+		b: 1
+	}
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+```
+
+thema reports:
+
+```
+error[E0111]: ForwardLens takes an instance of 0.0: declare it as v0_0: _
+ --> history/1.0.thema:7:8
+  |
+7 |     v0_0: {a: string}
+  |           ^
+  |
+  = help: ForwardLens for the lens from 0.0 to 1.0 is {v0_0: _, v1_0: {...}}, with an optional lacunas: {...}
+```

package/errors/E0112.md

@@ -0,0 +1,40 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0112: a version file's schema has an error
+
+A version file's schema is evaluated on its own before the lineage is
+assembled, and this one has an error of its own: a conflict CUE reports.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: 1
+	a: 2
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: 1
+	a: 2
+}
+```
+
+thema reports:
+
+```
+error[E0112]: a version file's schema has an error
+ --> history/0.0.thema:3:5
+  |
+2 |     a: 1
+  |        - also here
+3 |     a: 2
+  |        ^
+  |
+  = detail: schema.a: conflicting values 2 and 1
+```

package/errors/E0120.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0120: the lineage does not declare a field every lineage has
+
+Every lineage declares a name and its schemas. This one declares no name. The
+primary position is the lineage itself.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0120]: the lineage does not declare name
+ --> lineage.cue:1:1
+  |
+1 | schemas: {
+  | ^^^^^^^
+  |
+  = help: every lineage declares name and schemas
+```

package/errors/E0121.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0121: a field every lineage has is not concrete
+
+A lineage's name and schemas are concrete: the name is a string literal, not a
+constraint on one. Here the name is left as `string`, so there is no name.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: string
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0121]: name is not concrete
+ --> lineage.cue:1:1
+  |
+1 | name: string
+  | ^^^^
+  |
+```

package/errors/E0122.md

@@ -0,0 +1,26 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0122: the lineage declares no schemas
+
+A lineage declares at least one schema, version 0.0. This one declares none.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {}
+```
+
+thema reports:
+
+```
+error[E0122]: the lineage declares no schemas
+ --> lineage.cue:2:1
+  |
+2 | schemas: {}
+  | ^^^^^^^
+  |
+  = help: declare at least version 0.0 under schemas
+```

package/errors/E0123.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0123: a field that is not part of a lineage, a schema entry or a lens
+
+A lineage, a schema entry and a lens each have a fixed set of fields; a field
+outside that set is usually a typo, and the help names the field that is
+closest. Hidden fields and definitions are not checked: they are the author's
+own helpers.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			shcema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0123]: shcema is not a field of a schema entry
+ --> lineage.cue:5:4
+  |
+5 |             shcema: {
+  |             ^^^^^^
+  |
+  = help: did you mean schema?
+```

package/errors/E0124.md

@@ -0,0 +1,36 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0124: a schemas key that is not a version
+
+Schemas are keyed by major version, then minor version, each a non-negative
+integer written as a string: `"0": "0"` is version 0.0. A key that is not such
+an integer is not a version.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"v0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0124]: "v0" is not a major version
+ --> lineage.cue:3:2
+  |
+3 |     "v0": {
+  |     ^^^^
+  |
+  = help: schemas are keyed by major, then minor version, each a non-negative integer such as "0"
+```

package/errors/E0125.md

@@ -0,0 +1,43 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0125: a lenses key that is not a lens edge
+
+Lenses are keyed by the edge they map across, `"<from>-><to>"`, such as
+`"1.0->0.1"`. A key of any other shape is not an edge.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+lenses: {
+	"0.0=>1.0": {
+		input: _
+		result: {
+			a: input.a
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0125]: "0.0=>1.0" is not a lens edge
+  --> lineage.cue:12:2
+   |
+12 |     "0.0=>1.0": {
+   |     ^^^^^^^^^^
+   |
+   = help: lenses are keyed by "<from>-><to>" versions, such as "1.0->0.1"
+```

package/errors/E0126.md

@@ -0,0 +1,38 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0126: the lineage is not an instance of thema.Lineage
+
+The lineage is not an instance of thema.Lineage, for a reason thema has no more
+specific code for; CUE's own account is in the detail. Here the name is a
+number where a lineage's name is a string.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: 5
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0126]: the lineage is not an instance of thema.Lineage
+  --> lineage.cue:1:7
+   |
+ 1 | name: 5
+   |       ^
+   |
+   = note: in thema's own CUE
+    --> thema/lineage.cue:28:9
+   = detail: name: conflicting values 5 and =~"^[A-Za-z][A-Za-z0-9_]*$" (mismatched types int and string)
+```