@sdboyer/thema-ui 0.0.0-bootstrap.0 → 0.1.0

package/errors/E0501.md

@@ -0,0 +1,51 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0501: the data lacks a field the schema requires
+
+The data has no value for a field the schema requires. A schema field with no
+default is required: `count: int` must be present in every instance. The
+primary position is the data document; the note points at the schema's
+declaration.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				name:  string
+				count: int
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{
+	"name": "Argo"
+}
+```
+
+thema reports:
+
+```
+error[E0501]: the data lacks count, which schema 0.0 declares as int
+ --> data.json:1:1
+  |
+1 | {
+  | ^
+  |
+ ::: lineage.cue:7:5
+  |
+7 |                 count: int
+  |                 ----- declared here
+  |
+  = detail: count: incomplete value int
+```

package/errors/E0502.md

@@ -0,0 +1,50 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0502: the data has a field the schema does not declare
+
+The data has a field the schema does not declare. Schemas are closed when
+validating, keeping the author's `...`: an instance may hold only the fields
+its schema declares, except where the author wrote `...` or a pattern
+constraint admits the field. When the unknown field's name is close to a
+declared one, the help names it.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				name:  string
+				count: int
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{
+	"name":  "Argo",
+	"count": 3,
+	"cuont": 4
+}
+```
+
+thema reports:
+
+```
+error[E0502]: the data has cuont, which schema 0.0 does not declare
+ --> data.json:4:3
+  |
+4 |     "cuont": 4
+  |      ^^^^^
+  |
+  = detail: cuont: field not allowed
+  = help: did you mean count?
+```

package/errors/E0503.md

@@ -0,0 +1,52 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0503: a value in the data is of a kind the schema does not accept
+
+A value in the data is of a kind the schema does not accept: a string where the
+schema declares an int. The headline names the data's value and the kind the
+schema declares; a struct or list in the data is named by its kind, and a long
+value is shortened. The note points at the schema's declaration.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				name:  string
+				count: int
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{
+	"name":  "Argo",
+	"count": "three"
+}
+```
+
+thema reports:
+
+```
+error[E0503]: count in the data is "three", but schema 0.0 declares it as int
+ --> data.json:3:11
+  |
+3 |     "count": "three"
+  |              ^^^^^^^
+  |
+ ::: lineage.cue:7:5
+  |
+7 |                 count: int
+  |                 ----- declared here
+  |
+  = detail: count: conflicting values "three" and int (mismatched types string and int)
+```

package/errors/E0504.md

@@ -0,0 +1,64 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0504: a value in the data is outside what the schema allows
+
+A value in the data is of the right kind but outside what the schema allows:
+out of a bound the schema sets, failing a validator it applies, or not the
+constant it fixes. Here the schema bounds `count` and fixes `kind`.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				kind:  "ship"
+				count: int & >=0 & <10
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{
+	"kind":  "boat",
+	"count": 12
+}
+```
+
+thema reports:
+
+```
+error[E0504]: kind in the data is "boat", but schema 0.0 requires "ship"
+ --> data.json:2:11
+  |
+2 |     "kind":  "boat",
+  |              ^^^^^^
+  |
+ ::: lineage.cue:6:5
+  |
+6 |                 kind:  "ship"
+  |                 ---- required here
+  |
+  = detail: kind: conflicting values "ship" and "boat"
+
+error[E0504]: count in the data is 12, outside the bound <10 that schema 0.0 sets
+ --> data.json:3:11
+  |
+3 |     "count": 12
+  |              ^^
+  |
+ ::: lineage.cue:7:12
+  |
+7 |                 count: int & >=0 & <10
+  |                        --- the bound is set here
+  |
+  = detail: count: invalid value 12 (out of bound <10)
+```

package/errors/E0505.md

@@ -0,0 +1,51 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0505: a value in the data matches none of the alternatives the schema allows
+
+A value in the data matches none of the alternatives of a disjunction in the
+schema. CUE reports one reason per alternative; each is a note, so the author
+sees why every alternative was rejected.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				size: int | "large"
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{
+	"size": true
+}
+```
+
+thema reports:
+
+```
+error[E0505]: size in the data matches none of the alternatives schema 0.0 allows
+ --> data.json:2:10
+  |
+2 |     "size": true
+  |             ^^^^
+  |             ---- size: conflicting values true and "large" (mismatched types bool and string)
+  |             ---- size: conflicting values true and int (mismatched types bool and int)
+  |
+ ::: lineage.cue:6:11
+  |
+6 |                 size: int | "large"
+  |                       --- the alternatives are declared here
+  |
+  = detail: size: 2 errors in empty disjunction:
+```

package/errors/E0506.md

@@ -0,0 +1,48 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0506: the data is not concrete
+
+The data itself is not concrete. Data must be fully specified: a value with
+a constraint in place of a value, such as `int`, cannot be an instance of any
+schema. This arises when data is built in CUE rather than parsed from JSON or
+YAML.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				count: int
+			}
+		}
+	}
+}
+```
+
+`data.cue`:
+
+```cue
+count: int
+```
+
+thema reports:
+
+```
+error[E0506]: count in the data is not concrete: it is still int
+ --> data.cue:1:8
+  |
+1 | count: int
+  |        ^^^
+  |
+ ::: lineage.cue:6:5
+  |
+6 |                 count: int
+  |                 ----- declared here
+  |
+  = detail: count: incomplete value int
+```

package/errors/E0507.md

@@ -0,0 +1,41 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0507: the data does not parse
+
+The data document does not parse as the format it was given or detected as.
+The position is where the parser stopped; the detail is what it reported.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`bad.json`:
+
+```json
+{"a": "Argo"
+```
+
+thema reports:
+
+```
+error[E0507]: bad.json is not valid JSON
+ --> bad.json:1:13
+  |
+1 | {"a": "Argo"
+  |             ^
+  |
+  = detail: invalid JSON: unexpected end of JSON input
+```

package/errors/E0508.md

@@ -0,0 +1,39 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0508: the data is an instance of no schema in the lineage
+
+An operation that searches the lineage for the data's schema found none that
+accepts it: the CLI's translate, or the playground's validate-any, or its
+translate without a from version. Validating against one version (data
+validate -v) names what that schema rejects.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": 1}
+```
+
+thema reports:
+
+```
+error[E0508]: the data is an instance of no schema in the lineage
+  |
+  = help: validate it against one version with -v to see what that schema rejects
+```

package/errors/E0601.md

@@ -0,0 +1,22 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0601: the lineage path does not exist or cannot be read
+
+The path given with -l does not exist. The lineage is a .cue file or a
+directory of .cue files.
+
+## Example
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0601]: missing.cue does not exist
+  |
+  = help: pass the path to a .cue file or a directory with -l
+```

package/errors/E0602.md

@@ -0,0 +1,28 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0602: no CUE package was found at the lineage path
+
+The path given with -l exists, but CUE's loader found no package there: no
+.cue files, or none for the package asked for.
+
+## Example
+
+`docs/README.md`:
+
+```
+Not a lineage.
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0602]: there is no CUE package at docs
+  |
+  = help: a lineage is a .cue file, or a directory of .cue files in one package
+```

package/errors/E0603.md

@@ -0,0 +1,65 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0603: the lineage path holds lineages in several CUE packages
+
+A directory given with -l holds more than one CUE package, and more than
+one of them holds a lineage. thema cannot choose; name one file, or move the
+lineages apart.
+
+## Example
+
+`two/a.cue`:
+
+```cue
+package a
+
+import "github.com/sdboyer/thema"
+
+lin: thema.Lineage & {
+	name: "a"
+	schemas: {
+		"0": {
+			"0": {
+				schema: {
+					a: string
+				}
+			}
+		}
+	}
+}
+```
+
+`two/b.cue`:
+
+```cue
+package b
+
+import "github.com/sdboyer/thema"
+
+lin: thema.Lineage & {
+	name: "b"
+	schemas: {
+		"0": {
+			"0": {
+				schema: {
+					a: string
+				}
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0603]: packages a and b at the lineage path both hold a lineage
+  |
+  = help: name one package's file with -l, or move the lineages apart
+```

package/errors/E0604.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0604: the CUE path given for the lineage is not a path
+
+The CUE path given with -p does not parse as a path expression.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0604]: "a[" is not a CUE path
+  |
+  = detail: expected operand, found 'EOF'
+  = help: -p takes a path into the package, such as lin or lineages.ship
+```

package/errors/E0605.md

@@ -0,0 +1,36 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0605: there is no value at the CUE path given for the lineage
+
+The CUE path given with -p parses, but the package has no value there.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0605]: there is no value at nothere in lineage.cue
+  |
+  = help: -p names a field of the package that holds the lineage
+```

package/errors/E0606.md

@@ -0,0 +1,44 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0606: a cue.mod/module.cue above the lineage is not valid
+
+A cue.mod/module.cue was found above the lineage path, but it does not
+declare module, so the module's name is unknown.
+
+## Example
+
+`mod/cue.mod/module.cue`:
+
+```cue
+modul: "example.com/typo"
+```
+
+`mod/lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0606]: mod/cue.mod/module.cue does not declare module
+  |
+  = detail: field not found: module
+  = help: a module file declares module: "<path>" and language: version: "<version>"
+```

package/errors/E0607.md

@@ -0,0 +1,57 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0607: the CUE module requires a version of thema's CUE other than the one this program embeds
+
+The cue.mod/module.cue above the lineage depends on a version of thema's
+CUE module other than the one this program embeds. thema's CLI resolves
+github.com/sdboyer/thema to its own embedded copy, and only to that; the help
+names the version to declare.
+
+## Example
+
+`mod/cue.mod/module.cue`:
+
+```cue
+module: "example.com/skew"
+language: version: "v0.9.0"
+deps: "github.com/sdboyer/thema@v0": {v: "v0.0.1"}
+```
+
+`mod/x.cue`:
+
+```cue
+package x
+
+import "github.com/sdboyer/thema"
+
+lin: thema.Lineage & {
+	name: "x"
+	schemas: {
+		"0": {
+			"0": {
+				schema: {
+					a: string
+				}
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0607]: the CUE module requires thema v0.0.1, but this program embeds v0.1.0
+ --> mod/x.cue:3:8
+  |
+3 | import "github.com/sdboyer/thema"
+  |        ^^^^^^^^^^^^^^^^^^^^^^^^^^
+  |
+  = help: set deps["github.com/sdboyer/thema@v0"].v to "v0.1.0" in cue.mod/module.cue
+```