Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
commands/instructions
Package instructions binds flags for "stickler instructions".
|
Package instructions binds flags for "stickler instructions". |
|
commands/lint
Package lint binds flags for "stickler lint".
|
Package lint binds flags for "stickler lint". |
|
check
|
|
|
binaries
Package binaries is the native check for compiled executables tracked in git.
|
Package binaries is the native check for compiled executables tracked in git. |
|
clicommands
Package clicommands is the whole-repo check that a CLI has the three-tier layout AT ALL — that it has command packages, under internal/app/commands/, which is what the rule is named for.
|
Package clicommands is the whole-repo check that a CLI has the three-tier layout AT ALL — that it has command packages, under internal/app/commands/, which is what the rule is named for. |
|
clilayout
Package clilayout is the whole-repo correspondence check for the opinionated three-tier CLI layout.
|
Package clilayout is the whole-repo correspondence check for the opinionated three-tier CLI layout. |
|
distributed
Package distributed is the native check that a repository's centrally distributed build files are the distributed ones.
|
Package distributed is the native check that a repository's centrally distributed build files are the distributed ones. |
|
librarymarker
Package librarymarker is the native check that a repository's library.go marker is THE marker: `package library_marker`, the one sanctioned spelling.
|
Package librarymarker is the native check that a repository's library.go marker is THE marker: `package library_marker`, the one sanctioned spelling. |
|
versionstamp
Package versionstamp is the native check that a repository which RELEASES a CLI stamps the version its CLI reports.
|
Package versionstamp is the native check that a repository which RELEASES a CLI stamps the version its CLI reports. |
|
Package checks assembles every check stickler can run: the tools declared as data, plus the native checks stickler implements itself.
|
Package checks assembles every check stickler can run: the tools declared as data, plus the native checks stickler implements itself. |
|
Package config is stickler's layered configuration: the documents that declare which checks run, how each tool is invoked, and which findings are permitted to be soft.
|
Package config is stickler's layered configuration: the documents that declare which checks run, how each tool is invoked, and which findings are permitted to be soft. |
|
Package constants declares stickler's sentinel error values.
|
Package constants declares stickler's sentinel error values. |
|
Package domain holds the vocabulary shared by every domain package's Run contract.
|
Package domain holds the vocabulary shared by every domain package's Run contract. |
|
instructions
Package instructions orchestrates "stickler instructions": it asks every configured check to state the rules it enforces, and renders the answers as one document an agent can write conforming code from.
|
Package instructions orchestrates "stickler instructions": it asks every configured check to state the rules it enforces, and renders the answers as one document an agent can write conforming code from. |
|
lint
Package lint orchestrates a whole lint pass.
|
Package lint orchestrates a whole lint pass. |
|
Package report renders a finished lint pass.
|
Package report renders a finished lint pass. |
|
Package runner turns a declared tool (a config.RunnerSpec) into something that runs: it merges the tool's effective config, expands its argument and environment templates, executes the subprocess, and reads the output through the spec's parser.
|
Package runner turns a declared tool (a config.RunnerSpec) into something that runs: it merges the tool's effective config, expands its argument and environment templates, executes the subprocess, and reads the output through the spec's parser. |
|
Package suite is stickler's core vocabulary: the target a check runs over, the check interface every runner satisfies, and the aggregated result with its soft-fail ratchet.
|
Package suite is stickler's core vocabulary: the target a check runs over, the check interface every runner satisfies, and the aggregated result with its soft-fail ratchet. |
Click to show internal directories.
Click to hide internal directories.