Refactored main.go into cmd/jobsearch/main.go (in case separate commands are introduced later) which has required the options mechanism to change slightly as well as the logging.
This commit is contained in:
1 parent
de3ebf68c5
commit
6436253629
14 files changed
+273
-224
No files matched your search
@@ -19,10 +19,11 @@ package config
|
||||
import (
|
||||
"log/slog"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/cli"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func NewCommand() *cobra.Command {
|
||||
func NewCommand(opts *cli.Options) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "config",
|
||||
Short: "Configuration management",
|
||||
@@ -33,9 +34,9 @@ func NewCommand() *cobra.Command {
|
||||
slog.Debug("config.PersistentPostRun")
|
||||
},
|
||||
}
|
||||
cmd.AddCommand(commandShow())
|
||||
cmd.AddCommand(commandGet())
|
||||
cmd.AddCommand(commandSet())
|
||||
cmd.AddCommand(commandShow(opts))
|
||||
cmd.AddCommand(commandGet(opts))
|
||||
cmd.AddCommand(commandSet(opts))
|
||||
cmd.AddCommand(commandInit())
|
||||
return cmd
|
||||
}
|
||||
@@ -17,7 +17,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
|
||||
@@ -25,7 +24,7 @@ import (
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func commandGet() *cobra.Command {
|
||||
func commandGet(opts *cli.Options) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "get [config_key]",
|
||||
Args: cobra.ExactArgs(1),
|
||||
@@ -43,9 +42,9 @@ func commandGet() *cobra.Command {
|
||||
return err
|
||||
}
|
||||
|
||||
conf, ok := cli.ConfigFromContext(cmd.Context())
|
||||
if !ok {
|
||||
return errors.New("no configuration loaded")
|
||||
conf, err := opts.RunSetup(cmd, true, true)
|
||||
if err != nil {
|
||||
return fmt.Errorf("no configuration loaded (%w)", err)
|
||||
}
|
||||
|
||||
v, err := conf.ValueOf(args[0])
|
||||
@@ -57,9 +56,6 @@ func commandGet() *cobra.Command {
|
||||
|
||||
return nil
|
||||
},
|
||||
Annotations: map[string]string{
|
||||
"terminal_log": "1",
|
||||
},
|
||||
}
|
||||
return cmd
|
||||
}
|
||||
@@ -87,10 +87,6 @@ func commandInit() *cobra.Command {
|
||||
}
|
||||
return nil
|
||||
},
|
||||
Annotations: map[string]string{
|
||||
"no_config": "1",
|
||||
"terminal_log": "1",
|
||||
},
|
||||
}
|
||||
return cmd
|
||||
}
|
||||
@@ -29,7 +29,7 @@ import (
|
||||
"github.com/spf13/viper"
|
||||
)
|
||||
|
||||
func setConfig(conf config.JobSearchConfig, key string, value string) error {
|
||||
func setConfig(conf *config.JobSearchConfig, key string, value string) error {
|
||||
var confValue any = nil
|
||||
var confType reflect.Kind
|
||||
var err error
|
||||
@@ -65,7 +65,7 @@ func setConfig(conf config.JobSearchConfig, key string, value string) error {
|
||||
|
||||
return nil
|
||||
}
|
||||
func unsetConfig(conf config.JobSearchConfig, key string) error {
|
||||
func unsetConfig(conf *config.JobSearchConfig, key string) error {
|
||||
if _, err := conf.TypeOf(key); err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -88,7 +88,7 @@ func unsetConfig(conf config.JobSearchConfig, key string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func commandSet() *cobra.Command {
|
||||
func commandSet(opts *cli.Options) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "set [config_key] [config_value]",
|
||||
Args: cobra.MatchAll(cobra.MinimumNArgs(1), cobra.MaximumNArgs(2)),
|
||||
@@ -117,9 +117,9 @@ func commandSet() *cobra.Command {
|
||||
return err
|
||||
}
|
||||
|
||||
conf, ok := cli.ConfigFromContext(cmd.Context())
|
||||
if !ok {
|
||||
return errors.New("no configuration loaded")
|
||||
conf, err := opts.RunSetup(cmd, true, true)
|
||||
if err != nil {
|
||||
return fmt.Errorf("no configuration loaded (%w)", err)
|
||||
}
|
||||
|
||||
if viper.ConfigFileUsed() == "" {
|
||||
@@ -132,9 +132,6 @@ func commandSet() *cobra.Command {
|
||||
return setConfig(conf, args[0], args[1])
|
||||
}
|
||||
},
|
||||
Annotations: map[string]string{
|
||||
"terminal_log": "1",
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolP("unset", "x", false, "clear configuration setting")
|
||||
return cmd
|
||||
|
||||
@@ -17,14 +17,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/cli"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func commandShow() *cobra.Command {
|
||||
func commandShow(opts *cli.Options) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "show",
|
||||
Short: "Print config information",
|
||||
@@ -37,9 +37,9 @@ func commandShow() *cobra.Command {
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
slog.Debug("config.show.Run")
|
||||
|
||||
conf, ok := cli.ConfigFromContext(cmd.Context())
|
||||
if !ok {
|
||||
return errors.New("no configuration loaded")
|
||||
conf, err := opts.RunSetup(cmd, true, true)
|
||||
if err != nil {
|
||||
return fmt.Errorf("no configuration loaded (%w)", err)
|
||||
}
|
||||
|
||||
if yaml, _ := cmd.Flags().GetBool("yaml"); yaml {
|
||||
@@ -52,9 +52,6 @@ func commandShow() *cobra.Command {
|
||||
|
||||
return nil
|
||||
},
|
||||
Annotations: map[string]string{
|
||||
"terminal_log": "1",
|
||||
},
|
||||
}
|
||||
cmd.Flags().Bool("json", false, "format configuration as json")
|
||||
cmd.Flags().Bool("yaml", false, "format configuration as yaml")
|
||||
|
||||
@@ -17,27 +17,25 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/config"
|
||||
"git.avsdev.uk/Go/job-search/internal/log"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// Define a private key type to avoid collisions
|
||||
type configContextKey struct {
|
||||
name string
|
||||
}
|
||||
func SetupIntialLogging(cmd *cobra.Command) {
|
||||
// Start logging to terminal first - any commands that want to use file
|
||||
// logging should activate it themselves
|
||||
log.LogToTerminal()
|
||||
|
||||
// Define the key
|
||||
var configKey = &configContextKey{"config"}
|
||||
// Check for quiet flag
|
||||
if quiet, _ := cmd.Flags().GetBool("quiet"); quiet {
|
||||
log.SetLevel(slog.LevelError)
|
||||
}
|
||||
|
||||
// Public accessor to store a value to ctx
|
||||
func WithConfig(ctx context.Context, conf config.JobSearchConfig) context.Context {
|
||||
// No allocation here since userIDKey is a pointer to a struct
|
||||
return context.WithValue(ctx, configKey, conf)
|
||||
}
|
||||
|
||||
// Public accessor to fetch a value from ctx
|
||||
func ConfigFromContext(ctx context.Context) (config.JobSearchConfig, bool) {
|
||||
v, ok := ctx.Value(configKey).(config.JobSearchConfig)
|
||||
return v, ok
|
||||
// Check for debug logging enabled (overrides quiet flag)
|
||||
debugEnabled, _ := cmd.Flags().GetBool("debug")
|
||||
if debugEnabled {
|
||||
log.EnableDebug()
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
/*
|
||||
Copyright © 2026 Craig Williams <craig@avsdev.uk>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package cli
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
|
||||
"git.avsdev.uk/Go/job-search/internal/config"
|
||||
"git.avsdev.uk/Go/job-search/internal/log"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
type Options struct {
|
||||
configFile string
|
||||
debug bool
|
||||
quiet bool
|
||||
}
|
||||
|
||||
// Binds common options through the root command
|
||||
func (o *Options) Bind(cmd *cobra.Command) {
|
||||
pf := cmd.PersistentFlags()
|
||||
pf.StringVarP(&o.configFile, "config", "c", "", "configuration file")
|
||||
pf.BoolVarP(&o.debug, "debug", "d", false, "enable debug messages")
|
||||
pf.BoolVarP(
|
||||
&o.quiet, "quiet", "q", false, "don't report info or warning messages",
|
||||
)
|
||||
}
|
||||
|
||||
// Setup loads the config and ensure logging is switch to file if needed
|
||||
func (o *Options) RunSetup(
|
||||
cmd *cobra.Command, loadConfig bool, terminalLog bool,
|
||||
) (*config.JobSearchConfig, error) {
|
||||
// Check for debug level or quiet supression via args
|
||||
conf := &config.JobSearchConfig{
|
||||
Logging: config.JobSearchConfigLogging{},
|
||||
}
|
||||
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 && !log.IsDebugEnabled() {
|
||||
log.EnableDebug()
|
||||
}
|
||||
|
||||
// Check if the logging should be switched to file
|
||||
if !terminalLog {
|
||||
if len(conf.Logging.File) == 0 {
|
||||
slog.Warn("No log file configured, remaining in console logging mode!")
|
||||
} else {
|
||||
log.LogToFile(conf.Logging.File)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return conf, nil
|
||||
}
|
||||
|
||||
// Finish shuts down any open file logger
|
||||
func (o *Options) Finish() error {
|
||||
if log.IsFileLogger() {
|
||||
log.Shutdown()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -37,7 +37,7 @@ func NewCommand() *cobra.Command {
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
slog.Debug("version.Run")
|
||||
|
||||
fmt.Printf("PBCNinja - %s\n", version.Version)
|
||||
fmt.Printf("JobSearch - %s\n", version.Version)
|
||||
if version.BuildTime != "unknown" {
|
||||
fmt.Printf("Built: %s\n", version.BuildTime)
|
||||
}
|
||||
@@ -45,10 +45,6 @@ func NewCommand() *cobra.Command {
|
||||
fmt.Printf("Commit: %s\n", version.GitCommit)
|
||||
}
|
||||
},
|
||||
Annotations: map[string]string{
|
||||
"no_config": "1",
|
||||
"terminal_log": "1",
|
||||
},
|
||||
}
|
||||
return cmd
|
||||
}
|
||||
Reference in new issue
Block a user