diff --git a/AGENTS.md b/AGENTS.md index 8ea2d6e..74f23bc 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -22,7 +22,7 @@ ## Config System - Viper instance is stored in context using a custom key type (`confKeyType`) -- Use `config.New(ctx, path)` to create a new viper instance +- Use `config.New(path, overrides)` to create a new viper instance - Use `config.RetrieveFromContext(ctx)` to get both viper and the unmarshaled Config struct - Formatters can use `v.Sub("formatters." + kind)` to get their own sub-config and unmarshal into their specific config struct - Test files must create viper instances and add them to context using `config.AddToContext` diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ed9019..3e48feb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -## [0.3.1] - 2026-03-09 - -- Add AddFormatter function to allow custom builds to register new formatters -- Add option to print config from config command -- Allow MYLOG_CONFIG_PATH to override the config path - ## [0.3.0] - 2026-03-09 - Refactor configuration to use viper with context propagation instead of global variables diff --git a/cli/config.go b/cli/config.go index 99d4414..0512bb4 100644 --- a/cli/config.go +++ b/cli/config.go @@ -22,13 +22,12 @@ import ( fp "path/filepath" "codeberg.org/danjones000/my-log/config" - "github.com/pelletier/go-toml/v2" "github.com/spf13/cobra" ) var ConfigCmd = &cobra.Command{ Use: "config", - Short: "Save default config to file, or print the current config value", + Short: "Save default config to file", SilenceUsage: true, RunE: func(cmd *cobra.Command, args []string) (err error) { print, _ := cmd.Flags().GetBool("print") @@ -36,24 +35,6 @@ var ConfigCmd = &cobra.Command{ fmt.Fprintln(cmd.OutOrStdout(), config.DefaultPath()) return nil } - - if len(args) > 0 { - v, _ := config.RetrieveFromContext(cmd.Context()) - val := v.Get(args[0]) - var out []byte - if val == nil { - out = []byte("") - } else { - var err error - out, err = toml.Marshal(val) - if err != nil { - return err - } - } - fmt.Fprintln(cmd.OutOrStdout(), string(out)) - return nil - } - force, _ := cmd.Flags().GetBool("force") configPath := config.DefaultPath() if !force { diff --git a/cli/root.go b/cli/root.go index 9b32959..ddaca3b 100644 --- a/cli/root.go +++ b/cli/root.go @@ -28,12 +28,19 @@ var RootCmd = &cobra.Command{ Use: "my-log", Short: "A brief description of your application", PersistentPreRunE: func(cmd *cobra.Command, args []string) error { - - ctx, v, err := config.New(cmd.Context(), configPath) + ctx, v, err := config.New(cmd.Context()) if err != nil { return err } + if configPath != "" { + v.SetConfigFile(configPath) + err := v.ReadInConfig() + if err != nil { + return err + } + } + for k, val := range configValues { v.Set(k, val) } @@ -55,10 +62,6 @@ var configPath string var configValues map[string]string func init() { - path := os.Getenv("MYLOG_CONFIG_PATH") - if path == "" { - path = config.DefaultPath() - } - RootCmd.PersistentFlags().StringVarP(&configPath, "config", "c", path, "config file") + RootCmd.PersistentFlags().StringVarP(&configPath, "config", "c", config.DefaultPath(), "config file") RootCmd.PersistentFlags().StringToStringVarP(&configValues, "config-value", "v", nil, "Override config values. Use dot syntax to specify key. E.g. -v formatters.preferred=json") } diff --git a/config/load.go b/config/load.go index 09726d2..fd20cae 100644 --- a/config/load.go +++ b/config/load.go @@ -32,7 +32,7 @@ func AddToContext(ctx context.Context, v *viper.Viper) context.Context { return context.WithValue(ctx, viperKey, v) } -func New(ctx context.Context, path string) (context.Context, *viper.Viper, error) { +func New(ctx context.Context) (context.Context, *viper.Viper, error) { v := viper.New() v.SetConfigType("toml") @@ -40,16 +40,12 @@ func New(ctx context.Context, path string) (context.Context, *viper.Viper, error return ctx, nil, err } - if path == "" { - path = DefaultPath() - } - - v.SetConfigFile(path) + v.SetConfigFile(DefaultPath()) v.SetEnvPrefix("MYLOG") v.AutomaticEnv() v.SetEnvKeyReplacer(strings.NewReplacer(".", "_", "-", "_")) - if err := v.MergeInConfig(); err != nil { + if err := v.ReadInConfig(); err != nil { return ctx, nil, err } diff --git a/config/load_test.go b/config/load_test.go index af885b0..71dbb0c 100644 --- a/config/load_test.go +++ b/config/load_test.go @@ -9,7 +9,7 @@ import ( ) func TestNew(t *testing.T) { - _, v, err := New(t.Context(), "") + _, v, err := New(t.Context()) be.Err(t, err, nil) be.True(t, v != nil) } @@ -18,7 +18,7 @@ func TestNewWithEnvOverrides(t *testing.T) { os.Setenv("MYLOG_INPUT_PATH", "/test/path") defer os.Unsetenv("MYLOG_INPUT_PATH") - _, v, err := New(t.Context(), "") + _, v, err := New(t.Context()) be.Err(t, err, nil) be.Equal(t, v.GetString("input.path"), "/test/path") } @@ -32,9 +32,12 @@ path = "/file/path" ext = "log"`) f.Close() - _, v, err := New(t.Context(), f.Name()) + _, v, err := New(t.Context()) be.Err(t, err, nil) + v.SetConfigFile(f.Name()) + v.SetConfigType("toml") + err = v.ReadInConfig() be.Err(t, err, nil) be.Equal(t, v.GetString("input.path"), "/file/path") be.Equal(t, v.GetString("input.ext"), "log") diff --git a/formatters/json.go b/formatters/json.go index 0edfda3..e79acab 100644 --- a/formatters/json.go +++ b/formatters/json.go @@ -10,8 +10,6 @@ import ( "github.com/spf13/viper" ) -const FormatJSON string = "json" - func newJson(ff *viper.Viper) (Formatter, error) { js := new(Json) err := ff.Unmarshal(js) @@ -26,7 +24,7 @@ type Json struct { } func (js *Json) Name() string { - return FormatJSON + return "json" } func (js *Json) marshal(v any) (o []byte, err error) { diff --git a/formatters/new.go b/formatters/new.go index bd063fa..ff9610d 100644 --- a/formatters/new.go +++ b/formatters/new.go @@ -2,22 +2,18 @@ package formatters import ( "context" - "errors" "fmt" - "sync" "codeberg.org/danjones000/my-log/config" "github.com/spf13/viper" ) -var mut sync.RWMutex +type formatMaker func(config *viper.Viper) (Formatter, error) -type FormatInit func(config *viper.Viper) (Formatter, error) - -var formatterMap = map[string]FormatInit{ - FormatPlain: newPlain, - FormatJSON: newJson, - FormatNull: newNull, +var formatterMap = map[string]formatMaker{ + "plain": newPlain, + "json": newJson, + "zero": newNull, } func Preferred(ctx context.Context) (f Formatter, err error) { @@ -29,8 +25,6 @@ func New(ctx context.Context, kind string) (f Formatter, err error) { v, _ := config.RetrieveFromContext(ctx) formatterConf := v.Sub("formatters." + kind) - mut.RLock() - defer mut.RUnlock() if maker, ok := formatterMap[kind]; ok { return maker(formatterConf) } @@ -40,24 +34,8 @@ func New(ctx context.Context, kind string) (f Formatter, err error) { func Kinds() []string { r := []string{} - - mut.RLock() - defer mut.RUnlock() for kind, _ := range formatterMap { r = append(r, kind) } return r } - -var ErrAlreadyAdded = errors.New("formatter already present") - -func AddFormatter(key string, f FormatInit) error { - mut.Lock() - defer mut.Unlock() - if _, present := formatterMap[key]; present { - return fmt.Errorf("%w: %s", ErrAlreadyAdded, key) - } - - formatterMap[key] = f - return nil -} diff --git a/formatters/new_test.go b/formatters/new_test.go index df51a0a..d680709 100644 --- a/formatters/new_test.go +++ b/formatters/new_test.go @@ -39,17 +39,3 @@ func TestPreferred(t *testing.T) { be.Err(t, err, nil) be.True(t, form != nil) } - -type dummyFormatter struct{ Null } - -func (dummyFormatter) Name() string { return "dummy" } - -func TestAddFormatter(t *testing.T) { - var df dummyFormatter - dummyInit := func(*viper.Viper) (Formatter, error) { return df, nil } - err := AddFormatter(df.Name(), dummyInit) - be.Err(t, err, nil) - - err = AddFormatter(df.Name(), dummyInit) - be.Err(t, err, ErrAlreadyAdded) -} diff --git a/formatters/null.go b/formatters/null.go index 8851e04..f83cbde 100644 --- a/formatters/null.go +++ b/formatters/null.go @@ -5,19 +5,28 @@ import ( "github.com/spf13/viper" ) -const FormatNull = "zero" - -func newNull(*viper.Viper) (Formatter, error) { - return Null{}, nil +func newNull(ff *viper.Viper) (Formatter, error) { + return &Null{}, nil } type Null struct{} -func (Null) Name() string { - return FormatNull +func (n *Null) Name() string { + return "zero" } -func (Null) Meta(m models.Meta) (o []byte, err error) { return } -func (Null) Entry(e models.Entry) (o []byte, err error) { return } -func (Null) Log(l models.Log) (o []byte, err error) { return } -func (Null) Logs(logs []models.Log) (out []byte, err error) { return } +func (n *Null) Meta(m models.Meta) (o []byte, err error) { + return +} + +func (n *Null) Entry(e models.Entry) (o []byte, err error) { + return +} + +func (n *Null) Log(l models.Log) (o []byte, err error) { + return +} + +func (n *Null) Logs(logs []models.Log) (out []byte, err error) { + return +} diff --git a/formatters/plain.go b/formatters/plain.go index 6bf5c4f..0a94f81 100644 --- a/formatters/plain.go +++ b/formatters/plain.go @@ -8,16 +8,16 @@ import ( "github.com/spf13/viper" ) -const FormatPlain string = "plain" - -func newPlain(*viper.Viper) (Formatter, error) { +func newPlain(ff *viper.Viper) (Formatter, error) { return &PlainText{}, nil } -type PlainText struct{} +type PlainText struct { + // config might go here some day +} -func (*PlainText) Name() string { - return FormatPlain +func (pt *PlainText) Name() string { + return "plain" } func (pt *PlainText) Logs(logs []models.Log) (out []byte, err error) {