Directories
¶
| Path | Synopsis |
|---|---|
|
Package approval reads and writes the record that says the owner read the documents of a specification and approves it for code generation.
|
Package approval reads and writes the record that says the owner read the documents of a specification and approves it for code generation. |
|
Package diff compares two versions of a specification element by element and classifies each difference by the version step it needs, as docs/maintenance.md (The diff verb) describes.
|
Package diff compares two versions of a specification element by element and classifies each difference by the version step it needs, as docs/maintenance.md (The diff verb) describes. |
|
Package expr is SpecArch's expression subset of CEL: it parses with the CEL parser, refuses whatever is outside the subset, checks types and evaluates with exact numbers.
|
Package expr is SpecArch's expression subset of CEL: it parses with the CEL parser, refuses whatever is outside the subset, checks types and evaluates with exact numbers. |
|
Package extract holds the readers of specarch extract.
|
Package extract holds the readers of specarch extract. |
|
Package genbpmn writes the workflows of a specification as BPMN 2.0: the logic of the specarch-gen-bpmn plug-in.
|
Package genbpmn writes the workflows of a specification as BPMN 2.0: the logic of the specarch-gen-bpmn plug-in. |
|
Package gendxlib writes the Go of a service on dxlib from a specification: the logic of the specarch-gen-go-dxlib plug-in.
|
Package gendxlib writes the Go of a service on dxlib from a specification: the logic of the specarch-gen-go-dxlib plug-in. |
|
Package generate writes documents from SpecArch files.
|
Package generate writes documents from SpecArch files. |
|
Package genopenapi writes the OpenAPI 3.1 document of a specification: the logic of the specarch-gen-openapi plug-in, in the standard dialect.
|
Package genopenapi writes the OpenAPI 3.1 document of a specification: the logic of the specarch-gen-openapi plug-in, in the standard dialect. |
|
Package gensql writes the SQL migrations of a specification: the logic of the specarch-gen-sql plug-in.
|
Package gensql writes the SQL migrations of a specification: the logic of the specarch-gen-sql plug-in. |
|
Package gensqlc writes the sqlc queries a specification derives: one per operation that writes an entity's record or reads one by its key, and one per list with its filters, search, sorts and page, with a second query for the list's total.
|
Package gensqlc writes the sqlc queries a specification derives: one per operation that writes an entity's record or reads one by its key, and one per list with its filters, search, sorts and page, with a second query for the list's total. |
|
Package gentests writes the tests of a specification's design tests and worked examples, in Go, Swift or Dart: the logic of the specarch-gen-tests-go, -swift and -dart plug-ins.
|
Package gentests writes the tests of a specification's design tests and worked examples, in Go, Swift or Dart: the logic of the specarch-gen-tests-go, -swift and -dart plug-ins. |
|
Package genui writes the screens of a specification for the web in plain JavaScript: the logic of the specarch-gen-ui plug-in.
|
Package genui writes the screens of a specification for the web in plain JavaScript: the logic of the specarch-gen-ui plug-in. |
|
Package genuits writes the screens of a specification for the web in TypeScript, on Next.js's app router and IBM's Carbon design system: the logic of the specarch-gen-ui-typescript plug-in.
|
Package genuits writes the screens of a specification for the web in TypeScript, on Next.js's app router and IBM's Carbon design system: the logic of the specarch-gen-ui-typescript plug-in. |
|
Package implies expands a set of permissions through the implications the design declares on them (permissions.<name>.implies, ADR-100): a holder of a permission holds every one it implies, transitively.
|
Package implies expands a set of permissions through the implications the design declares on them (permissions.<name>.implies, ADR-100): a holder of a permission holds every one it implies, transitively. |
|
Package literal reads a TypeScript file that holds one object literal of data, in the subset of TypeScript that is also JSON5, and compares two such files by value (ADR-093).
|
Package literal reads a TypeScript file that holds one object literal of data, in the subset of TypeScript that is also JSON5, and compares two such files by value (ADR-093). |
|
Package mark places a specification's problems at the entries a generated file shows (docs/diagnostics.md, section 5): the rule every generator plug-in marks its output by, so each target puts a problem at the same entry and writes only its own comment form.
|
Package mark places a specification's problems at the entries a generated file shows (docs/diagnostics.md, section 5): the rule every generator plug-in marks its output by, so each target puts a problem at the same entry and writes only its own comment form. |
|
Package ownership reads the ownedBy marks of an implementation file's mappings, which every generator follows: an element another stakeholder owns, and everything under its pointer, is described and compared but never generated (ADR-046).
|
Package ownership reads the ownedBy marks of an implementation file's mappings, which every generator follows: an element another stakeholder owns, and everything under its pointer, is described and compared but never generated (ADR-046). |
|
Package problems gathers every problem of a specification, the errors and warnings validate finds and the open questions, into one list, and writes it as the problems file and as a SARIF 2.1.0 log (ADR-065).
|
Package problems gathers every problem of a specification, the errors and warnings validate finds and the open questions, into one list, and writes it as the problems file and as a SARIF 2.1.0 log (ADR-065). |
|
Package semver reads and orders Semantic Versioning 2.0.0 versions and says how far one steps from another.
|
Package semver reads and orders Semantic Versioning 2.0.0 versions and says how far one steps from another. |
|
Package source reads a SpecArch YAML file into a node tree that keeps the line of every value, and into the plain value the JSON Schema check needs.
|
Package source reads a SpecArch YAML file into a node tree that keeps the line of every value, and into the plain value the JSON Schema check needs. |
|
Package spec reads a SpecArch specification from disk: the root file specarch.yaml and the stage folders beside it, merged into one document the validator and the generators work on.
|
Package spec reads a SpecArch specification from disk: the root file specarch.yaml and the stage folders beside it, merged into one document the validator and the generators work on. |
|
Package typerows matches a field of the design to a row of a type rendering (docs/idioms.md, "Stacks and type rows").
|
Package typerows matches a field of the design to a row of a type rendering (docs/idioms.md, "Stacks and type rows"). |
|
Package validate checks SpecArch specifications and implementation files: the JSON Schema of their kind first, then the rules a schema cannot express.
|
Package validate checks SpecArch specifications and implementation files: the JSON Schema of their kind first, then the rules a schema cannot express. |
|
Package vocabulary reads a vocabulary: the words of one language that extract documents finds a commitment and reads a table of fields by, and that merge reads a number of days by (docs/vocabularies.md, ADR-105).
|
Package vocabulary reads a vocabulary: the words of one language that extract documents finds a commitment and reads a table of fields by, and that merge reads a number of days by (docs/vocabularies.md, ADR-105). |
|
Package wirename writes a property's name as it goes on the wire, by the rule info.wireNames names (ADR-062), and a role's, by the rule info.roleNames names (ADR-099).
|
Package wirename writes a property's name as it goes on the wire, by the rule info.wireNames names (ADR-062), and a role's, by the rule info.roleNames names (ADR-099). |
Click to show internal directories.
Click to hide internal directories.