bwilliams
67215a6aaa
CODE_CONVENTIONS.md sets out the conventions for Go code in this repository: naming, layout, comments, errors, logging, configuration and tests. .golangci.json enables the linters that check the parts that can be checked (each limited to the rules the conventions use); the rest is applied by hand. Applied across the codebase: - Naming: full-word names in application code, initialisms in one case (BuyerID, PrintJSON, PrintYAML, ocdsGetBuyerID), no names shadowing built-ins (min/max are minGap/maxGap), mustRaw renamed rawJSON as it returns nil rather than panicking, and config.ConfigLevelToLogLevel renamed LevelToLogLevel. - Layout: lines kept to 80 characters where possible, assignments taken out of if and for statements that don't fit, wrapped arguments all on one line or one per line, steps separated by blank lines, no else after a return, function and struct literals wrapped. - Comments: doc comments on every exported name (including each section's Map, Flatten, TypeOf, ValueOf and SetValue), section banners, British spelling. - Errors: a created error starts with its package name, a wrapping error adds only what was being done, sentinels in one commented var block, errors.Is and errors.As in place of == and type assertions, and no err := shadowing of a named result. That fixes the mock server losing its access log's close error. - Logging: the fetcher passes its workers an untagged logger, so findatender's lines are tagged with their own component rather than with fetcher's as well; cmd/mock-fts logs "stopped" with slog. - Configuration: util.WithTimeout (moved from the websocket package) applies a timeout of 0 or less as no limit, used for the websocket write and ping, TCP close and tcpserver shutdown timeouts; every setting documents what 0 or empty means, including the rate limit rule's keys in internal/config/README.md. - Tests: related tests merged into table-driven ones with named cases. Separately from CODE_CONVENTIONS.md, internal/store/README.md gains a soft SQL style convention for the queries in internal/store/queries.go, and the queries are reformatted to follow it.
86 lines
2.4 KiB
Go
86 lines
2.4 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"log/slog"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"git.avsdev.uk/Go/job-search/internal/config"
|
|
"git.avsdev.uk/Go/job-search/internal/logging"
|
|
)
|
|
|
|
// Options holds the flags shared by every command. Bind registers them on the
|
|
// root command and RunSetup acts on them.
|
|
type Options struct {
|
|
configFile string
|
|
debug bool
|
|
quiet bool
|
|
}
|
|
|
|
// Bind registers the shared flags as persistent flags on the root command cmd.
|
|
func (o *Options) Bind(cmd *cobra.Command) {
|
|
flags := cmd.PersistentFlags()
|
|
flags.StringVarP(&o.configFile, "config", "c", "", "configuration file")
|
|
flags.BoolVarP(&o.debug, "debug", "d", false, "enable debug messages")
|
|
flags.BoolVarP(
|
|
&o.quiet, "quiet", "q", false, "don't report info or warning messages",
|
|
)
|
|
}
|
|
|
|
// RunSetup prepares a command to run and returns its configuration. When
|
|
// loadConfig is true it loads the configuration (from the --config file if
|
|
// given), with --debug and --quiet overriding its log level, and then, unless
|
|
// terminalLog is true, switches logging to the configured log file (staying
|
|
// on the terminal, with a warning, if none is configured).
|
|
func (o *Options) RunSetup(
|
|
cmd *cobra.Command, loadConfig, terminalLog bool,
|
|
) (*config.JobSearchConfig, error) {
|
|
// Flags and arguments are valid from here on, so errors are runtime
|
|
// failures: report them without cobra's usage text.
|
|
cmd.SilenceUsage = true
|
|
|
|
// Check for debug level or quiet suppression via args
|
|
conf := &config.JobSearchConfig{
|
|
Logging: config.JSCLogging{},
|
|
}
|
|
if o.debug {
|
|
conf.Logging.Level = "debug"
|
|
} else if o.quiet {
|
|
conf.Logging.Level = "error"
|
|
}
|
|
|
|
// Only load config if command requests it (nearly always true)
|
|
if loadConfig {
|
|
// Load config - from specified file if provided
|
|
if err := config.Init(o.configFile, conf); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Change logging level based off newly loaded config
|
|
if conf.Logging.LogLevel() <= slog.LevelDebug && !logging.IsDebugEnabled() {
|
|
logging.EnableDebug()
|
|
}
|
|
|
|
// Check if the logging should be switched to file
|
|
if !terminalLog {
|
|
if conf.Logging.File == "" {
|
|
slog.Warn("no log file configured; logging to the terminal")
|
|
} else if err := logging.LogToFile(conf.Logging.File); err != nil {
|
|
return nil, fmt.Errorf("opening log file: %w", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
return conf, nil
|
|
}
|
|
|
|
// Finish shuts down any open file logger
|
|
func (o *Options) Finish() error {
|
|
if logging.IsFileLogger() {
|
|
return logging.Shutdown()
|
|
}
|
|
|
|
return nil
|
|
}
|