Skip to content

Commit

Permalink
Update REAME to mension the errorformat playground
Browse files Browse the repository at this point in the history
  • Loading branch information
haya14busa committed Sep 22, 2019
1 parent 28b0006 commit 54b2cfd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -103,7 +103,7 @@ $ brew upgrade reviewdog/tap/reviewdog

reviewdog accepts any compiler or linter result from stdin and parses it with
scan-f like [**'errorformat'**](https://github.com/reviewdog/errorformat),
which is the port of Vim's [errorformat](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#errorformat)
which is the port of Vim's [errorformat](https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format)
feature.

For example, if the result format is `{file}:{line number}:{column number}: {message}`,
Expand All @@ -125,10 +125,12 @@ $ golint ./... | reviewdog -efm="%f:%l:%c: %m" -diff="git diff master"
| ... | ... |

Please see [reviewdog/errorformat](https://github.com/reviewdog/errorformat)
and [:h errorformat](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#errorformat)
and [:h errorformat](https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format)
if you want to deal with a more complex output. 'errorformat' can handle more
complex output like a multi-line error message.

You can also try errorformat on [the Playground](https://reviewdog.github.io/errorformat-playground/)!

By this 'errorformat' feature, reviewdog can support any tools output with ease.

### Available pre-defined 'errorformat'
Expand Down

0 comments on commit 54b2cfd

Please sign in to comment.