Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli implements the global `vukem` command: project scaffolding, generators, the dev server and delegation of app commands to the project's own binary (cmd/app).
|
Package cli implements the global `vukem` command: project scaffolding, generators, the dev server and delegation of app commands to the project's own binary (cmd/app). |
|
starter/app/controllers
Package controllers holds the HTTP handlers.
|
Package controllers holds the HTTP handlers. |
|
starter/app/jobs
Package jobs holds the queued jobs.
|
Package jobs holds the queued jobs. |
|
starter/app/models
Package models holds the database models.
|
Package models holds the database models. |
|
starter/app/requests
Package requests holds validated request inputs.
|
Package requests holds validated request inputs. |
|
starter/database/factories
Package factories builds models with fake data for tests and seeders.
|
Package factories builds models with fake data for tests and seeders. |
|
starter/routes
Package routes declares the HTTP routes.
|
Package routes declares the HTTP routes. |
|
Package codemod edits Go source the way a developer would: it appends an element to the slice literal returned by a known function and adds the imports it needs.
|
Package codemod edits Go source the way a developer would: it appends an element to the slice literal returned by a known function and adds the imports it needs. |
|
Package disposition builds safe Content-Disposition attachment headers for client-facing download names (export and web.Ctx.Download).
|
Package disposition builds safe Content-Disposition attachment headers for client-facing download names (export and web.Ctx.Download). |
|
Package naming converts identifiers between Go and database/file conventions.
|
Package naming converts identifiers between Go and database/file conventions. |
|
Package principal carries the identity a guard authenticated for one request.
|
Package principal carries the identity a guard authenticated for one request. |
|
Package sqlscan finds the "?" bind placeholders of a SQL statement, skipping string literals, quoted identifiers and comments the way the target dialect lexes them.
|
Package sqlscan finds the "?" bind placeholders of a SQL statement, skipping string literals, quoted identifiers and comments the way the target dialect lexes them. |
|
Package testutil holds helpers shared by the core packages' tests.
|
Package testutil holds helpers shared by the core packages' tests. |
|
tools
|
|
|
apicheck
command
Command apicheck compares the exported API of the core module and of every published module (drivers/*, contrib/*) with its latest stable release tag, using golang.org/x/exp/cmd/apidiff:
|
Command apicheck compares the exported API of the core module and of every published module (drivers/*, contrib/*) with its latest stable release tag, using golang.org/x/exp/cmd/apidiff: |
|
commitlint
command
Command commitlint validates a commit message file against Conventional Commits 1.0.
|
Command commitlint validates a commit message file against Conventional Commits 1.0. |
|
covergate
command
Command covergate fails when a core package is below its coverage gate (docs/testing.md): 80% by default, 90% for the strict packages.
|
Command covergate fails when a core package is below its coverage gate (docs/testing.md): 80% by default, 90% for the strict packages. |
|
fixinline
command
Command fixinline checks that go fix inlines every //go:fix inline wrapper of the repository correctly:
|
Command fixinline checks that go fix inlines every //go:fix inline wrapper of the repository correctly: |
|
modcheck
command
Command modcheck gates the nested modules on being resolvable the way a consumer resolves them: from their own go.mod, with no workspace.
|
Command modcheck gates the nested modules on being resolvable the way a consumer resolves them: from their own go.mod, with no workspace. |
|
release
command
Command release cuts a release at the end of a PLAN.md task group:
|
Command release cuts a release at the end of a PLAN.md task group: |
Click to show internal directories.
Click to hide internal directories.