feat: rename CustomCallerPrettyfier option to CustomCallerFormatter

tim-ywliu · May 2, 2020 · 28a283d · 28a283d
1 parent fea031b
commit 28a283d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -36,8 +36,8 @@ type Formatter struct {
 	// CallerFirst - print caller info first
 	CallerFirst bool
 
-	// CustomCallerPrettyfier - set custom formatter for caller info
-	CustomCallerPrettyfier func(*runtime.Frame) string
+	// CustomCallerFormatter - set custom formatter for caller info
+	CustomCallerFormatter func(*runtime.Frame) string
 }
 ```
 

diff --git a/formatter.go b/formatter.go
@@ -37,8 +37,8 @@ type Formatter struct {
 	// CallerFirst - print caller info first
 	CallerFirst bool
 
-	// CustomCallerPrettyfier - set custom formatter for caller info
-	CustomCallerPrettyfier func(*runtime.Frame) string
+	// CustomCallerFormatter - set custom formatter for caller info
+	CustomCallerFormatter func(*runtime.Frame) string
 }
 
 // Format an log entry
@@ -108,8 +108,8 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 
 func (f *Formatter) writeCaller(b *bytes.Buffer, entry *logrus.Entry) {
 	if entry.HasCaller() {
-		if f.CustomCallerPrettyfier != nil {
-			fmt.Fprintf(b, f.CustomCallerPrettyfier(entry.Caller))
+		if f.CustomCallerFormatter != nil {
+			fmt.Fprintf(b, f.CustomCallerFormatter(entry.Caller))
 		} else {
 			fmt.Fprintf(
 				b,

diff --git a/tests/formatter_test.go b/tests/formatter_test.go
@@ -237,7 +237,7 @@ func TestFormatter_Format_with_report_caller_and_CallerFirst_true(t *testing.T)
 	}
 }
 
-func TestFormatter_Format_with_report_caller_and_CustomCallerPrettyfier(t *testing.T) {
+func TestFormatter_Format_with_report_caller_and_CustomCallerFormatter(t *testing.T) {
 	output := bytes.NewBuffer([]byte{})
 
 	l := logrus.New()
@@ -247,7 +247,7 @@ func TestFormatter_Format_with_report_caller_and_CustomCallerPrettyfier(t *testi
 		NoColors:        true,
 		TimestampFormat: "-",
 		CallerFirst:     true,
-		CustomCallerPrettyfier: func(f *runtime.Frame) string {
+		CustomCallerFormatter: func(f *runtime.Frame) string {
 			s := strings.Split(f.Function, ".")
 			funcName := s[len(s)-1]
 			return fmt.Sprintf(" [%s:%d][%s()]", path.Base(f.File), f.Line, funcName)