🚚 Rename stdout.config.formatter to format

This commit is contained in:
Dan Jones 2024-03-10 21:08:34 -05:00
commit 8086029b03
6 changed files with 8 additions and 9 deletions

View file

@ -123,7 +123,7 @@ Each separate output has its own set of configuration. So, replace `which-one` w
*This section may change in the near future. We're considering supporting multiple formats.*
- `formatter`: Which formatter to use when outputting data. This value is used by `my-log drop` to output the new entry.
- `format`: Which formatter to use when outputting data. This value is also used by `my-log drop` to output the new entry.
### `[formatters]`

View file

@ -50,7 +50,7 @@ func init() {
// will be global for your application.
rootCmd.PersistentFlags().StringVarP(&config.ConfigPath, "config", "c", config.ConfigPath, "config file")
rootCmd.PersistentFlags().StringToStringVarP(&config.Overrides, "config-value", "v", config.Overrides, "Override config values. Use dot syntax to specify key. E.g. -v output.stdout.config.formatter=json")
rootCmd.PersistentFlags().StringToStringVarP(&config.Overrides, "config-value", "v", config.Overrides, "Override config values. Use dot syntax to specify key. E.g. -v output.stdout.config.format=json")
// Cobra also supports local flags, which will only run
// when this action is called directly.

View file

@ -28,7 +28,7 @@ dotFolder = true
enabled = true
[output.stdout.config]
# Formatter to use when outputting to stdout
formatter = "plain"
format = "plain"
[formatters]

View file

@ -70,14 +70,14 @@ func TestStdoutMissing(t *testing.T) {
}
func TestStdoutLoad(t *testing.T) {
os.Setenv("LOG_STDOUT_FORMATTER", "json")
defer os.Unsetenv("LOG_STDOUT_FORMATTER")
os.Setenv("LOG_STDOUT_FORMAT", "json")
defer os.Unsetenv("LOG_STDOUT_FORMAT")
os.Setenv("LOG_STDOUT_ENABLED", "true")
defer os.Unsetenv("LOG_STDOUT_ENABLED")
c, _ := Load()
std, en := c.Outputs.Stdout()
assert.True(t, en)
assert.Equal(t, "json", std.Formatter)
assert.Equal(t, "json", std.Format)
}
func TestFormatJson(t *testing.T) {

View file

@ -21,7 +21,7 @@ type Output struct {
}
type Stdout struct {
Formatter string `env:"LOG_STDOUT_FORMATTER" mapstructure:"formatter"`
Format string `env:"LOG_STDOUT_FORMAT" mapstructure:"format"`
}
type stdoutEnabled struct {

View file

@ -19,8 +19,7 @@ func Preferred() (f Formatter, err error) {
return
}
std, _ := conf.Outputs.Stdout()
kind := std.Formatter
return New(kind)
return New(std.Format)
}
func New(kind string) (f Formatter, err error) {