feat: add NoFieldsSpace option (antonfisher#5)

* Add option NoFieldsSpace * tests: add tests for NoFieldsSpace option
tim-ywliu · Sep 3, 2020 · b001633 · b001633
1 parent 28a283d
commit b001633
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,9 @@ type Formatter struct {
 	// NoFieldsColors - apply colors only to the level, default is level + fields
 	NoFieldsColors bool
 
+	// NoFieldsSpace - no space between fields
+	NoFieldsSpace bool
+
 	// ShowFullLevel - show a full level [WARNING] instead of [WARN]
 	ShowFullLevel bool
 

diff --git a/formatter.go b/formatter.go
@@ -28,6 +28,9 @@ type Formatter struct {
 	// NoFieldsColors - apply colors only to the level, default is level + fields
 	NoFieldsColors bool
 
+	// NoFieldsSpace - no space between fields
+	NoFieldsSpace bool
+
 	// ShowFullLevel - show a full level [WARNING] instead of [WARN]
 	ShowFullLevel bool
 
@@ -73,7 +76,11 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 	} else {
 		b.WriteString(level[:4])
 	}
-	b.WriteString("] ")
+	b.WriteString("]")
+
+	if !f.NoFieldsSpace {
+		b.WriteString(" ")
+	}
 
 	if !f.NoColors && f.NoFieldsColors {
 		b.WriteString("\x1b[0m")
@@ -86,6 +93,10 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 		f.writeOrderedFields(b, entry)
 	}
 
+	if f.NoFieldsSpace {
+		b.WriteString(" ")
+	}
+
 	if !f.NoColors && !f.NoFieldsColors {
 		b.WriteString("\x1b[0m")
 	}
@@ -166,9 +177,13 @@ func (f *Formatter) writeOrderedFields(b *bytes.Buffer, entry *logrus.Entry) {
 
 func (f *Formatter) writeField(b *bytes.Buffer, entry *logrus.Entry, field string) {
 	if f.HideKeys {
-		fmt.Fprintf(b, "[%v] ", entry.Data[field])
+		fmt.Fprintf(b, "[%v]", entry.Data[field])
 	} else {
-		fmt.Fprintf(b, "[%s:%v] ", field, entry.Data[field])
+		fmt.Fprintf(b, "[%s:%v]", field, entry.Data[field])
+	}
+
+	if !f.NoFieldsSpace {
+		b.WriteString(" ")
 	}
 }
 

diff --git a/tests/formatter_test.go b/tests/formatter_test.go
@@ -143,6 +143,31 @@ func ExampleFormatter_Format_field_order() {
 	// - [INFO] [component:main] [category:rest] test3
 }
 
+func ExampleFormatter_Format_no_fields_space() {
+	l := logrus.New()
+	l.SetOutput(os.Stdout)
+	l.SetLevel(logrus.DebugLevel)
+	l.SetFormatter(&formatter.Formatter{
+		NoColors:        true,
+		TimestampFormat: "-",
+		FieldsOrder:     []string{"component", "category"},
+		HideKeys:        false,
+		NoFieldsSpace:   true,
+	})
+
+	ll := l.WithField("component", "main")
+	lll := ll.WithField("category", "rest")
+
+	l.Info("test1")
+	ll.Info("test2")
+	lll.Info("test3")
+
+	// Output:
+	// - [INFO] test1
+	// - [INFO][component:main] test2
+	// - [INFO][component:main][category:rest] test3
+}
+
 func ExampleFormatter_Format_trim_message() {
 	l := logrus.New()
 	l.SetOutput(os.Stdout)