Merge pull request #5 from heppu/support-comments

Support commented lines

README.md

@@ -4,4 +4,47 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/heppu/go-review)](https://goreportcard.com/report/github.com/heppu/go-review)
 
 # Go Review
-Publish reports from different Go linters as gerrit reviews
+Publish reports from different Go linters as gerrit review comments.
+
+## Install
+
+Specific release can be installed by downloading from [releases page](https://github.com/heppu/go-review/releases).
+
+Latest version from master can be installed by running: `go get github.com/heppu/go-review/...`
+
+## Usage
+
+go-review uses following environment variables to access gerrit review server:
+
+- `GERRIT_REVIEW_URL`: required
+- `GERRIT_CHANGE_ID`: required
+- `GERRIT_PATCHSET_REVISION`: required
+- `GERRIT_USERNAME`: optional
+- `GERRIT_PASSWORD`: optional
+
+Behavior can be controlled with following flags:
+
+ - `-version`: print versions details and exit
+ - `-dry`: parse env vars and input but do not publish review
+ - `-show`: print lines while parsing
+
+## Examples
+Every linter that is able to produce similar output as go vet can be used as an input.
+
+### go vet
+
+```sh
+go vet ./... 2>&1 | go-review
+```
+
+### golangci-lint
+
+```sh
+ golangci-lint run --out-format=line-number --print-issued-lines=false | go-review
+```
+
+### staticcheck
+
+```sh
+staticcheck ./... | go-review
+```

review.go

@@ -49,6 +49,11 @@ func LinesToReviewComments(r io.Reader) (comments map[string][]gerrit.CommentInp
 	for scanner.Scan() {
 		lineNumber++
 		line := scanner.Text()
+
+		if strings.HasPrefix(line, "#") {
+			continue
+		}
+
 		problem, err := parseLine(line)
 		if err != nil {
 			return nil, &ParseError{LineNumber: lineNumber, Err: err}

review_test.go

@@ -68,6 +68,13 @@ file_2.go:3:5: problem`),
 		comments: map[string][]gerrit.CommentInput{
 			"some.go/file.go": {{Line: 1, Message: "problem"}},
 		},
+	}, {
+		name: "CommentLine",
+		input: strings.NewReader(`# some/pkg
+file.go:1:2: some problem`),
+		comments: map[string][]gerrit.CommentInput{
+			"file.go": {{Line: 1, Message: "some problem"}},
+		},
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {