Skip to content

Commit

Permalink
Add file (line/col) info to ref/relref errors
Browse files Browse the repository at this point in the history 
See gohugoio#5371
  • Loading branch information
@bep
bep committed Nov 1, 2018
1 parent 234e73a commit 29e0d1a
Show file tree
Hide file tree
Showing 22 changed files with 412 additions and 296 deletions.
2 changes: 1 addition & 1 deletion commands/server_errors.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ var buildErrorTemplate = `<!doctype html>
<main>
{{ highlight .Error "apl" "noclasses=true,style=monokai" }}
{{ with .File }}
{{ $params := printf "noclasses=true,style=monokai,linenos=table,hl_lines=%d,linenostart=%d" (add .Pos 1) (sub .LineNumber .Pos) }}
{{ $params := printf "noclasses=true,style=monokai,linenos=table,hl_lines=%d,linenostart=%d" (add .LinesPos 1) (sub .LineNumber .LinesPos) }}
{{ $lexer := .ChromaLexer | default "go-html-template" }}
{{ highlight (delimit .Lines "\n") $lexer $params }}
{{ end }}
Expand Down
129 changes: 45 additions & 84 deletions common/herrors/error_locator.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,72 +15,21 @@
package herrors

import (
"fmt"
"io"
"io/ioutil"
"os"
"strings"

"github.com/gohugoio/hugo/common/terminal"
"github.com/gohugoio/hugo/common/text"
"github.com/gohugoio/hugo/helpers"

"github.com/spf13/afero"
)

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() {
fileErrorFormatFunc = createFileLogFormatter(os.Getenv("HUGO_FILE_LOG_FORMAT"))
}

// LineMatcher contains the elements used to match an error to a line
type LineMatcher struct {
FileError FileError
Position text.Position
Error error

LineNumber int
Offset int
Line string
Expand All @@ -91,33 +40,34 @@ type LineMatcherFn func(m LineMatcher) bool

// SimpleLineMatcher simply matches by line number.
var SimpleLineMatcher = func(m LineMatcher) bool {
return m.FileError.LineNumber() == m.LineNumber
return m.Position.LineNumber == m.LineNumber
}

var _ text.Positioner = ErrorContext{}

// ErrorContext contains contextual information about an error. This will
// typically be the lines surrounding some problem in a file.
type ErrorContext struct {
// The source filename.
Filename string

// If a match will contain the matched line and up to 2 lines before and after.
// Will be empty if no match.
Lines []string

// The position of the error in the Lines above. 0 based.
Pos int

// The linenumber in the source file from where the Lines start. Starting at 1.
LineNumber int
LinesPos int

// The column number in the source file. Starting at 1.
ColumnNumber int
position text.Position

// The lexer to use for syntax highlighting.
// https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages
ChromaLexer string
}

// Position returns the text position of this error.
func (e ErrorContext) Position() text.Position {
return e.position
}

var _ causer = (*ErrorWithFileContext)(nil)

// ErrorWithFileContext is an error with some additional file context related
Expand All @@ -128,7 +78,11 @@ type ErrorWithFileContext struct {
}

func (e *ErrorWithFileContext) Error() string {
return fileErrorFormatFunc(e.ErrorContext) + ": " + e.cause.Error()
pos := e.Position()
if pos.IsValid() {
return pos.String() + ": " + e.cause.Error()
}
return e.cause.Error()
}

func (e *ErrorWithFileContext) Cause() error {
Expand Down Expand Up @@ -163,24 +117,27 @@ func WithFileContext(e error, realFilename string, r io.Reader, matcher LineMatc

var errCtx ErrorContext

if le.Offset() != -1 {
posle := le.Position()

if posle.Offset != -1 {
errCtx = locateError(r, le, func(m LineMatcher) bool {
if le.Offset() >= m.Offset && le.Offset() < m.Offset+len(m.Line) {
fe := m.FileError
m.FileError = ToFileErrorWithOffset(fe, -fe.LineNumber()+m.LineNumber)
if posle.Offset >= m.Offset && posle.Offset < m.Offset+len(m.Line) {
lno := posle.LineNumber - m.Position.LineNumber + m.LineNumber
m.Position = text.Position{LineNumber: lno}
}
return matcher(m)
})

} else {
errCtx = locateError(r, le, matcher)
}

if errCtx.LineNumber == -1 {
pos := &errCtx.position

if pos.LineNumber == -1 {
return e, false
}

errCtx.Filename = realFilename
pos.Filename = realFilename

if le.Type() != "" {
errCtx.ChromaLexer = chromaLexerFromType(le.Type())
Expand Down Expand Up @@ -233,17 +190,20 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) ErrorContext
panic("must provide an error")
}

errCtx := ErrorContext{LineNumber: -1, ColumnNumber: 1, Pos: -1}
errCtx := ErrorContext{position: text.Position{LineNumber: -1, ColumnNumber: 1, Offset: -1}, LinesPos: -1}

b, err := ioutil.ReadAll(r)
if err != nil {
return errCtx
}

pos := &errCtx.position
lepos := le.Position()

lines := strings.Split(string(b), "\n")

if le != nil && le.ColumnNumber() >= 0 {
errCtx.ColumnNumber = le.ColumnNumber()
if le != nil && lepos.ColumnNumber >= 0 {
pos.ColumnNumber = lepos.ColumnNumber
}

lineNo := 0
Expand All @@ -252,32 +212,33 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) ErrorContext
for li, line := range lines {
lineNo = li + 1
m := LineMatcher{
FileError: le,
Position: le.Position(),
Error: le,
LineNumber: lineNo,
Offset: posBytes,
Line: line,
}
if errCtx.Pos == -1 && matches(m) {
errCtx.LineNumber = lineNo
if errCtx.LinesPos == -1 && matches(m) {
pos.LineNumber = lineNo
break
}

posBytes += len(line)
}

if errCtx.LineNumber != -1 {
low := errCtx.LineNumber - 3
if pos.LineNumber != -1 {
low := pos.LineNumber - 3
if low < 0 {
low = 0
}

if errCtx.LineNumber > 2 {
errCtx.Pos = 2
if pos.LineNumber > 2 {
errCtx.LinesPos = 2
} else {
errCtx.Pos = errCtx.LineNumber - 1
errCtx.LinesPos = pos.LineNumber - 1
}

high := errCtx.LineNumber + 2
high := pos.LineNumber + 2
if high > len(lines) {
high = len(lines)
}
Expand Down
43 changes: 16 additions & 27 deletions common/herrors/error_locator_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,6 @@ import (
"github.com/stretchr/testify/require"
)

func TestCreateFileLogFormatter(t *testing.T) {
assert := require.New(t)

ctx := ErrorContext{Filename: "/my/file.txt", LineNumber: 12, ColumnNumber: 13}

assert.Equal("/my/file.txt|13|12", createFileLogFormatter(":file|:col|:line")(ctx))
assert.Equal("13|/my/file.txt|12", createFileLogFormatter(":col|:file|:line")(ctx))
assert.Equal("好:13", createFileLogFormatter("好::col")(ctx))
assert.Equal("\"/my/file.txt:12:13\"", createFileLogFormatter("")(ctx))

}

func TestErrorLocator(t *testing.T) {
assert := require.New(t)

Expand All @@ -53,41 +41,42 @@ LINE 8
location := locateErrorInString(lines, lineMatcher)
assert.Equal([]string{"LINE 3", "LINE 4", "This is THEONE", "LINE 6", "LINE 7"}, location.Lines)

assert.Equal(5, location.LineNumber)
assert.Equal(2, location.Pos)
pos := location.Position()
assert.Equal(5, pos.LineNumber)
assert.Equal(2, location.LinesPos)

assert.Equal([]string{"This is THEONE"}, locateErrorInString(`This is THEONE`, lineMatcher).Lines)

location = locateErrorInString(`L1
This is THEONE
L2
`, lineMatcher)
assert.Equal(2, location.LineNumber)
assert.Equal(1, location.Pos)
assert.Equal(2, location.Position().LineNumber)
assert.Equal(1, location.LinesPos)
assert.Equal([]string{"L1", "This is THEONE", "L2", ""}, location.Lines)

location = locateErrorInString(`This is THEONE
L2
`, lineMatcher)
assert.Equal(0, location.Pos)
assert.Equal(0, location.LinesPos)
assert.Equal([]string{"This is THEONE", "L2", ""}, location.Lines)

location = locateErrorInString(`L1
This THEONE
`, lineMatcher)
assert.Equal([]string{"L1", "This THEONE", ""}, location.Lines)
assert.Equal(1, location.Pos)
assert.Equal(1, location.LinesPos)

location = locateErrorInString(`L1
L2
This THEONE
`, lineMatcher)
assert.Equal([]string{"L1", "L2", "This THEONE", ""}, location.Lines)
assert.Equal(2, location.Pos)
assert.Equal(2, location.LinesPos)

location = locateErrorInString("NO MATCH", lineMatcher)
assert.Equal(-1, location.LineNumber)
assert.Equal(-1, location.Pos)
assert.Equal(-1, location.Position().LineNumber)
assert.Equal(-1, location.LinesPos)
assert.Equal(0, len(location.Lines))

lineMatcher = func(m LineMatcher) bool {
Expand All @@ -106,8 +95,8 @@ I
J`, lineMatcher)

assert.Equal([]string{"D", "E", "F", "G", "H"}, location.Lines)
assert.Equal(6, location.LineNumber)
assert.Equal(2, location.Pos)
assert.Equal(6, location.Position().LineNumber)
assert.Equal(2, location.LinesPos)

// Test match EOF
lineMatcher = func(m LineMatcher) bool {
Expand All @@ -120,8 +109,8 @@ C
`, lineMatcher)

assert.Equal([]string{"B", "C", ""}, location.Lines)
assert.Equal(4, location.LineNumber)
assert.Equal(2, location.Pos)
assert.Equal(4, location.Position().LineNumber)
assert.Equal(2, location.LinesPos)

offsetMatcher := func(m LineMatcher) bool {
return m.Offset == 1
Expand All @@ -134,7 +123,7 @@ D
E`, offsetMatcher)

assert.Equal([]string{"A", "B", "C", "D"}, location.Lines)
assert.Equal(2, location.LineNumber)
assert.Equal(1, location.Pos)
assert.Equal(2, location.Position().LineNumber)
assert.Equal(1, location.LinesPos)

}
Loading

0 comments on commit 29e0d1a

Please sign in to comment.