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

package/errors/E0608.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0608: the lineage imports a package that is not available here
+
+The lineage imports a package no module provides. Only thema's own module
+is built in; another module must be listed in the deps of a cue.mod/module.cue
+above the lineage, for the loader to fetch it.
+
+## Example
+
+`pkg/x.cue`:
+
+```cue
+package x
+
+import "example.com/nothere"
+
+lin: nothere.Lineage
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0608]: the lineage imports example.com/nothere, which is not available here
+ --> pkg/x.cue:3:8
+  |
+3 | import "example.com/nothere"
+  |        ^^^^^^^^^^^^^^^^^^^^^
+  |
+  = help: only github.com/sdboyer/thema is built in; another module must be declared in the deps of a cue.mod/module.cue above the lineage
+```

package/errors/E0609.md

@@ -0,0 +1,33 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0609: loading the lineage's CUE failed
+
+CUE's loader failed in a way thema does not describe further, here a syntax
+error in the lineage file. The detail is the loader's own message.
+
+## Example
+
+`broken.cue`:
+
+```cue
+name: "ship"
+schemas: "0": "0": {schema: {a: string
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0609]: loading the lineage's CUE failed
+ --> broken.cue:2:40
+  |
+2 | schemas: "0": "0": {schema: {a: string
+  |                                       ^
+  |
+  = detail: expected '}', found 'EOF'
+```

package/errors/E0611.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0611: the data's format could not be recognized
+
+The data document parses as neither JSON nor YAML, and no format was named
+with -e. Naming the format shows what its parser reports.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`bad.json`:
+
+```json
+{"a": "Argo"
+```
+
+thema reports:
+
+```
+error[E0611]: bad.json is neither JSON nor YAML
+  |
+  = help: name the format with -e json or -e yaml to see what its parser reports
+```

package/errors/E0612.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0612: the data's format flag disagrees with its file extension
+
+The format named with -e disagrees with the data file's extension.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0612]: -e yaml was given, but data.json has a json extension
+```

package/errors/E0613.md

@@ -0,0 +1,30 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0613: no data was given, or the data path cannot be read
+
+No data was given: no path argument, and nothing on stdin.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0613]: no data was given
+  |
+  = help: pass the path to a JSON or YAML file, or pipe the data on stdin
+```

package/errors/E0614.md

@@ -0,0 +1,36 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0614: the data format flag names a format thema does not read
+
+The format named with -e is not one thema reads. It takes json or yaml.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0614]: -e toml names a format thema does not read
+  |
+  = help: -e takes json or yaml
+```

package/errors/E0616.md

@@ -0,0 +1,33 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0616: a file cannot be written
+
+A command could not write a file it needed to: here `thema lineage fmt`
+rewriting a version file that is not in the authoring form's layout, which
+the author's permissions do not let it change. The detail is the operating
+system's reason.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {name: string, count: int}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	name:  string
+	count: int
+}
+```
+
+thema reports:
+
+```
+error[E0616]: ship/history/0.0.thema cannot be written
+  |
+  = detail: permission denied
+```

package/errors/E0617.md

@@ -0,0 +1,15 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0617: this thema was built without the playground
+
+thema serve playground serves the playground built into this thema, and this
+one was built without it. The help says how to build it in: the bundle is
+generated, then embedded under the playgroundui build tag.
+
+thema reports:
+
+```
+error[E0617]: this thema was built without the playground
+  |
+  = help: build it in: go generate ./cmd/thema/playground && go build -tags playgroundui ./cmd/thema
+```

package/errors/E0618.md

@@ -0,0 +1,16 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0618: the server cannot listen on the address
+
+thema serve playground could not listen on the address given with --addr: it
+is not a valid address, is in use, or needs privileges the command
+lacks. The detail is the operating system's reason.
+
+thema reports:
+
+```
+error[E0618]: cannot listen on 127.0.0.1:99999
+  |
+  = detail: listen tcp: address 99999: invalid port
+  = help: choose another address with --addr
+```

package/errors/E0620.md

@@ -0,0 +1,37 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0620: a flag or argument is not valid
+
+A flag or argument is not valid, here a version that is not of the form
+<major>.<minor>. The help says what the flag takes.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+			}
+		}
+	}
+}
+```
+
+`data.json`:
+
+```json
+{"a": "Argo"}
+```
+
+thema reports:
+
+```
+error[E0620]: "3" is not a version
+  |
+  = help: a version is <major>.<minor>, such as 1.0
+```

package/errors/E0621.md

@@ -0,0 +1,45 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0621: an example's example.cue is not valid
+
+Each lineage a playground deployment offers as an example has an example.cue
+beside its version files, describing it: a category, the group it is listed
+in, and optionally a title and a summary, each a string. Nothing else may be
+in it.
+
+## Example
+
+`lineages/pets/cat/history/0.0.thema`:
+
+```cue
+Schema: {
+	lives: int
+}
+```
+
+`lineages/pets/cat/tip.thema`:
+
+```cue
+Schema: {
+	lives: int
+}
+```
+
+`lineages/pets/cat/example.cue`:
+
+```cue
+category: "Pets"
+color:    "grey"
+```
+
+thema reports:
+
+```
+error[E0621]: lineages/pets/cat/example.cue has a field color, which is not category, title or summary
+ --> lineages/pets/cat/example.cue:2:1
+  |
+2 | color:    "grey"
+  | ^^^^^
+  |
+  = help: remove the field
+```

package/errors/E0622.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0622: the examples directory holds no example
+
+A directory of lineages offers the playground the ones with an example.cue
+beside their version files, and a directory with none offers nothing, which
+is a mistake: the notes list the lineages it holds without one.
+
+## Example
+
+`lineages/wip/draft/history/0.0.thema`:
+
+```cue
+Schema: {
+	x: int
+}
+```
+
+`lineages/wip/draft/tip.thema`:
+
+```cue
+Schema: {
+	x: int
+}
+```
+
+thema reports:
+
+```
+error[E0622]: lineages holds no example
+  |
+  = note: lineages/wip/draft holds a lineage but no example.cue
+  = help: an example is a lineage's directory of version files with an example.cue beside them
+```

package/errors/E0623.md

@@ -0,0 +1,33 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0623: the directory for a new lineage already holds version files
+
+`thema lineage init` creates a new lineage, and never overwrites one: the
+directory it would write the new lineage's tip.thema in already holds version
+files, here the tip and history of the lineage ship.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	name: string
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	name: string
+}
+```
+
+thema reports:
+
+```
+error[E0623]: ship already holds a lineage's version files
+  |
+  = help: init creates a new lineage and never overwrites one: give -l a directory that holds no version files
+```

package/errors/E0624.md

@@ -0,0 +1,34 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0624: the document is not of an OpenAPI version thema converts
+
+`thema lineage init openapi` converts OpenAPI 3.0 and 3.1 documents, which
+declare their version in an `openapi` field. Here the document is OpenAPI 2,
+Swagger, which declares `swagger: "2.0"` instead, and keeps its schemas under
+`definitions`.
+
+## Example
+
+`swagger.json`:
+
+```json
+{
+  "swagger": "2.0",
+  "info": {"title": "ships", "version": "v1"},
+  "paths": {},
+  "definitions": {
+    "Ship": {
+      "type": "object",
+      "properties": {"name": {"type": "string"}}
+    }
+  }
+}
+```
+
+thema reports:
+
+```
+error[E0624]: the document declares no OpenAPI version, so it is not an OpenAPI document thema converts
+  |
+  = help: an OpenAPI 3 document declares its version as a string, as in openapi: "3.0.0"; convert an OpenAPI 2 (Swagger) document to OpenAPI 3 first
+```

package/errors/E0625.md

@@ -0,0 +1,28 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0625: the directory to position a lineage's files under is not a valid path
+
+A tool that compiles a lineage positions its files under a directory with
+`authoring.At`, so that lineages from different directories, composed into one
+value, name their own files. The directory is a path of the `fs.FS` the
+lineage was loaded from: relative and separated by `/`, with no `.` or `..`
+elements. Here it climbs out of the filesystem with `..`.
+
+## Example
+
+`query/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+thema reports:
+
+```
+error[E0625]: "../operations/get/query" is not a directory to position the lineage's files under
+  |
+  = note: the directory is a path of an fs.FS: relative and separated by /, with no . or .. elements
+  = help: pass the lineage's directory as a path of its fs.FS, such as operations/get/query
+```

package/errors/E0626.md

@@ -0,0 +1,54 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0626: the lineage bound on the development path is not the one that was compiled
+
+A tool that composes lineages into one value binds the tip of one, compiled
+on the development path, as that value holds it, with
+`authoring.BindDevelopmentValue`. The development path tolerates the lenses
+missing from the tip's edge only for the lineage that was compiled with them
+missing. Here the value bound is the history alone, without the tip: it has
+none of the tip's version, so it is not the lineage that was compiled.
+
+## Example
+
+`ship/history/0.0.thema`:
+
+```cue
+Schema: {
+	a: string
+	b: int
+}
+```
+
+`ship/tip.thema`:
+
+```cue
+Schema: {
+	a: string
+}
+```
+
+`value.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				a: string
+				b: int
+			}
+		}
+	}
+}
+```
+
+thema reports:
+
+```
+error[E0626]: the lineage to bind on the development path has versions 0.0, where ship was compiled with 0.0, 1.0
+  |
+  = note: the development path tolerates the lenses missing from the tip's edge because ship was compiled with them missing, so it binds only the lineage ship was compiled to
+  = help: bind the lineage that Compiled.File builds, as the larger value holds it
+```

package/errors/E0627.md

@@ -0,0 +1,27 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0627: the placements given to Compose cannot be written as one package
+
+A tool composes lineages into one package with `thema.Compose`, which writes
+each lineage's file into the package nested under fields at the lineage's
+path. A path that names a list element, a pattern, an optional or required
+constraint, or a hidden label cannot be written as fields. Here the path
+indexes a list.
+
+## Example
+
+`text.cue`:
+
+```cue
+name: "get"
+schemas: "0": "0": schema: {a?: string}
+```
+
+thema reports:
+
+```
+error[E0627]: a placement's path is made of field and definition labels, and placement 0's path operations[0] is not
+  |
+  = note: 0 is a list index, and a placement goes in a field
+  = help: place the file at a path of regular field and definition labels
+```

package/errors/E0628.md

@@ -0,0 +1,63 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0628: a generated file on disk is not what would be generated
+
+With --check, a command that generates files writes nothing, and checks the
+files already on disk instead: here `thema lineage gen gotypes`, whose files
+for version 0.0 are out of date, and for version 0.1 were never generated. One
+diagnostic names each file; running the command without --check regenerates
+them.
+
+## Example
+
+`lineage.cue`:
+
+```cue
+name: "ship"
+schemas: {
+	"0": {
+		"0": {
+			schema: {
+				name: string
+			}
+		}
+		"1": {
+			schema: {
+				name:  string
+				crew?: int
+			}
+		}
+	}
+}
+lenses: "0.1->0.0": {
+	v0_1: _
+	v0_0: name: v0_1.name
+}
+```
+
+`gen/v0_0/types.go`:
+
+```
+// Code generated by thema. DO NOT EDIT.
+
+package v0_0
+
+// Ship is version 0.0 of the ship lineage's schema.
+type Ship struct {
+	Title string `json:"title"`
+}
+```
+
+thema reports:
+
+```
+error[E0628]: a generated file on disk is what would be generated, and v0_0/types.go differs
+  |
+  = note: the path is relative to -o, gen
+  = help: run the command without --check to regenerate it
+
+error[E0628]: a generated file is on disk, and v0_1/types.go is missing
+  |
+  = note: the path is relative to -o, gen
+  = help: run the command without --check to regenerate it
+```

package/errors/E0701.md

@@ -0,0 +1,25 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0701: generating code from the schema failed
+
+A generator could not express a schema the lineage accepts: here TypeScript,
+for a struct closed with CUE's close(). The schema is valid; the target
+language has no equivalent for the construct. The detail is the generator's
+own message.
+
+## Example
+
+`request.json`:
+
+```json
+{"lineage": {"normal": {"path": "lineage.cue", "text": "name: \"ship\"\nschemas: {\n\t\"0\": {\n\t\t\"0\": {\n\t\t\tschema: {\n\t\t\t\tcrew: close({size: int})\n\t\t\t}\n\t\t}\n\t}\n}\n"}}}
+```
+
+thema reports:
+
+```
+error[E0701]: generating TypeScript from schema 0.0 failed
+  |
+  = detail: generating TS for schema root failed: Found an error in the field 'crew:6:5'. Error: not expecting op type 6
+  = help: the schema is valid; TypeScript cannot express some construct in it
+```

package/errors/E0801.md

@@ -0,0 +1,23 @@
+<!-- Generated by go test ./diag; do not edit. -->
+
+# E0801: the playground request is malformed
+
+The playground was asked for an operation it does not have, or sent a request
+that is not the JSON the operation takes. This is a bug in whatever sent the
+request; the help lists the operations.
+
+## Example
+
+`request.json`:
+
+```json
+{}
+```
+
+thema reports:
+
+```
+error[E0801]: "translate-all" is not an operation of the playground
+  |
+  = help: the operations are bind, compile, decompile, example, examples, format, init, jsonschema, openapi, register-examples, translate, typescript, validate and validate-any
+```