configtemplate's package comment explained the module-root placement by
naming the embed directive in prose, which staticcheck reads as a
malformed directive (SA9009). Reworded, with a note saying why.
Found by running golangci-lint repo-wide while auditing 6108fc5, which
also showed that archie-core-qa4 reports 4/4 phases complete and offers
to close while 56 findings remain. Filed as archie-core-qa4.5 so the
epic's completion count reflects the gate rather than the phase list;
qa4.5 depends on archie-core-ts9, because the nilerr findings in grep.go
are the same swallowed-error bug and fixing them mechanically would
change tool behaviour.
18 lines
750 B
Go
18 lines
750 B
Go
// Package configtemplate embeds config.example.toml so archied setup can
|
|
// generate a first-run config.toml from the exact file operators already
|
|
// read as documentation, instead of a second copy that can drift from it.
|
|
//
|
|
// It lives at the module root, rather than under internal/, because embed
|
|
// patterns cannot reach outside the directory of the .go file that declares
|
|
// them, and config.example.toml is kept at the root where it is easy to
|
|
// find and hand-edit. (Written without the directive prefix on purpose:
|
|
// staticcheck reads "// go:embed" in prose as a malformed directive.)
|
|
package configtemplate
|
|
|
|
import _ "embed"
|
|
|
|
// Example is the verbatim contents of config.example.toml.
|
|
//
|
|
//go:embed config.example.toml
|
|
var Example []byte
|