Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli implements the rig command line.
|
Package cli implements the rig command line. |
|
Package compile turns a Postgres schema and its table configuration into the frozen document every generator reads.
|
Package compile turns a Postgres schema and its table configuration into the frozen document every generator reads. |
|
Package diag collects the problems rig finds and reports them together.
|
Package diag collects the problems rig finds and reports them together. |
|
Package dockerdb manages the throwaway Postgres rig runs migrations against.
|
Package dockerdb manages the throwaway Postgres rig runs migrations against. |
|
gen
|
|
|
allgen
Package allgen imports every built-in generator for its registration.
|
Package allgen imports every built-in generator for its registration. |
|
gentest
Package gentest is the shared harness for testing generators.
|
Package gentest is the shared harness for testing generators. |
|
genutil
Package genutil holds what more than one Go generator needs.
|
Package genutil holds what more than one Go generator needs. |
|
gobuf
Package gobuf emits Go source.
|
Package gobuf emits Go source. |
|
goclient
Package goclient generates a Go SDK for the API: the types a caller holds and one method per endpoint.
|
Package goclient generates a Go SDK for the API: the types a caller holds and one method per endpoint. |
|
modelgo
Package modelgo generates the model layer: the entity, its enums, its query types, and the inputs that change it.
|
Package modelgo generates the model layer: the entity, its enums, its query types, and the inputs that change it. |
|
openapigen
Package openapigen generates an OpenAPI 3.1 document from the compiled document, so a specification cannot describe an API that does not exist.
|
Package openapigen generates an OpenAPI 3.1 document from the compiled document, so a specification cannot describe an API that does not exist. |
|
persistgo
Package persistgo generates the persistence layer: a repository interface and its pgx implementation.
|
Package persistgo generates the persistence layer: a repository interface and its pgx implementation. |
|
servergo
Package servergo generates the HTTP layer: routing, decoding, and the registration struct.
|
Package servergo generates the HTTP layer: routing, decoding, and the registration struct. |
|
servicego
Package servicego generates the API layer's types and the interface your service layer implements.
|
Package servicego generates the API layer's types and the interface your service layer implements. |
|
tsbuf
Package tsbuf builds one TypeScript file.
|
Package tsbuf builds one TypeScript file. |
|
tsclient
Package tsclient generates a TypeScript SDK for the API: the types a front end holds, one method per endpoint, and a factory per live-sync stream.
|
Package tsclient generates a TypeScript SDK for the API: the types a front end holds, one method per endpoint, and a factory per live-sync stream. |
|
Command godoccheck fails on an exported symbol with no doc comment.
|
Command godoccheck fails on an exported symbol with no doc comment. |
|
Package introspect reads a live Postgres schema into rig's intermediate representation.
|
Package introspect reads a live Postgres schema into rig's intermediate representation. |
|
Package migcheck checks a project's migration file names before they are applied to anything.
|
Package migcheck checks a project's migration file names before they are applied to anything. |
|
Package naming converts between the three casings rig deals with: the snake_case of Postgres, the PascalCase of Go and TypeScript identifiers, and the camelCase of JSON keys.
|
Package naming converts between the three casings rig deals with: the snake_case of Postgres, the PascalCase of Go and TypeScript identifiers, and the camelCase of JSON keys. |
|
Package pgtypes maps Postgres types onto Go types and scan strategies.
|
Package pgtypes maps Postgres types onto Go types and scan strategies. |
|
Package project reads rig.yaml, the file that marks the root of a rig project and configures everything that is not per-table.
|
Package project reads rig.yaml, the file that marks the root of a rig project and configures everything that is not per-table. |
|
Command release prepares a lockstep release of every published rig module.
|
Command release prepares a lockstep release of every published rig module. |
|
Package revision records when a project's API surface last changed.
|
Package revision records when a project's API surface last changed. |
|
Package scaffold writes the files a new rig project starts from.
|
Package scaffold writes the files a new rig project starts from. |
|
Package tableconf reads the per-table YAML that annotates an introspected schema.
|
Package tableconf reads the per-table YAML that annotates an introspected schema. |
|
Package tablesync keeps table configuration in step with the database.
|
Package tablesync keeps table configuration in step with the database. |
|
Package version answers what build of rig this is.
|
Package version answers what build of rig this is. |
|
Package yamlconf loads YAML configuration and keeps track of where every key came from.
|
Package yamlconf loads YAML configuration and keeps track of where every key came from. |
Click to show internal directories.
Click to hide internal directories.