mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-26 22:04:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

common/herrors: Make the file error log format configurable

Browse Source 
Will check for an OS environment variable named `HUGO_FILE_LOG_FORMAT`.

The tokens available are `:file` (absolute filename), `:line` (line number) and `:col` (column number).

The default format is: \":file::line::col\"`

How to set OS environment variables is OS specific, but an example on Unix setting an alternative format when running Hugo:

```bash
env HUGO_FILE_LOG_FORMAT="\":file::line\"" hugo
```

The above will include filename and line number quoted.

Fixes #5352
This commit is contained in:
Bjørn Erik Pedersen
2018-10-27 17:19:36 +02:00
parent dac7092a9c
commit 1ad117cbe2
2 changed files with 60 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
common/herrors/error_locator.go
View File

@@ -27,12 +27,55 @@ import (
"github.com/spf13/afero"
)
var fileErrorFormat = "\"%s:%d:%d\": %s"
var fileErrorFormatFunc func(e ErrorContext) string
func createFileLogFormatter(formatStr string) func(e ErrorContext) string {
if formatStr == "" {
formatStr = "\":file::line::col\""
}
var identifiers = []string{":file", ":line", ":col"}
var identifiersFound []string
for i := range formatStr {
for _, id := range identifiers {
if strings.HasPrefix(formatStr[i:], id) {
identifiersFound = append(identifiersFound, id)
}
}
}
replacer := strings.NewReplacer(":file", "%s", ":line", "%d", ":col", "%d")
format := replacer.Replace(formatStr)
f := func(e ErrorContext) string {
args := make([]interface{}, len(identifiersFound))
for i, id := range identifiersFound {
switch id {
case ":file":
args[i] = e.Filename
case ":line":
args[i] = e.LineNumber
case ":col":
args[i] = e.ColumnNumber
}
}
msg := fmt.Sprintf(format, args...)
if terminal.IsTerminal(os.Stdout) {
return terminal.Notice(msg)
}
return msg
}
return f
}
func init() {
if terminal.IsTerminal(os.Stdout) {
fileErrorFormat = terminal.Notice("\"%s:%d:%d\"") + ": %s"
}
fileErrorFormatFunc = createFileLogFormatter(os.Getenv("HUGO_FILE_LOG_FORMAT"))
}
// LineMatcher contains the elements used to match an error to a line
@@ -85,7 +128,7 @@ type ErrorWithFileContext struct {
}
func (e *ErrorWithFileContext) Error() string {
return fmt.Sprintf(fileErrorFormat, e.Filename, e.LineNumber, e.ColumnNumber, e.cause.Error())
return fileErrorFormatFunc(e.ErrorContext) + ": " + e.cause.Error()
}
func (e *ErrorWithFileContext) Cause() error {