aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/phayes/checkstyle/README.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2020-09-15 18:05:35 +0200
committerDmitry Vyukov <dvyukov@google.com>2020-09-15 19:34:30 +0200
commit712de1c63d9db97c81af68cd0dc4372c53d2e57a (patch)
treeae1761fec52c3ae4ddd003a4130ddbda8d0a2d69 /vendor/github.com/phayes/checkstyle/README.md
parent298a69c38dd5c8a9bbd7a022e88f4ddbcf885e16 (diff)
vendor/github.com/golangci/golangci-lint: update to v1.31
Diffstat (limited to 'vendor/github.com/phayes/checkstyle/README.md')
-rw-r--r--vendor/github.com/phayes/checkstyle/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/vendor/github.com/phayes/checkstyle/README.md b/vendor/github.com/phayes/checkstyle/README.md
new file mode 100644
index 000000000..358cf6752
--- /dev/null
+++ b/vendor/github.com/phayes/checkstyle/README.md
@@ -0,0 +1,44 @@
+# checkstyle
+[![GoDoc](https://godoc.org/github.com/phayes/checkstyle?status.svg)](https://godoc.org/github.com/phayes/checkstyle)
+[![Go Report Card](https://goreportcard.com/badge/github.com/phayes/checkstyle)](https://goreportcard.com/report/github.com/phayes/checkstyle)
+[![Build Status](https://scrutinizer-ci.com/g/phayes/checkstyle/badges/build.png?b=master)](https://scrutinizer-ci.com/g/phayes/checkstyle/build-status/master)
+
+Read and write checksyle_report.xml files with golang
+
+Checkstyle XML files are a standard file format for reporting errors in source code, and is often generated by static analysis tools.
+
+Example usage:
+
+```go
+
+import "github.com/phayes/checkstyle"
+
+// Print XML into human readable format
+checkSyle, err := checkstyle.ReadFile("checkstyle_report.xml")
+if err != nil {
+ log.Fatal(err)
+}
+for _, file := range checkStyle.File {
+ fmt.Println(File.Name)
+ for _, codingError := range file.Error {
+ fmt.Println("\t", codingError.Line, codingError.Message)
+ }
+}
+
+// Create a new XML file from scratch
+check := checkstyle.New()
+
+// Ensure that a file has been added
+file := check.EnsureFile("/path/to/file")
+
+// Create an error on line 10
+codingError := checkstyle.NewError(10, "format", "line must end with a full stop")
+
+// Add the error to the file
+file.AddError(codingError)
+
+// Output XML
+fmt.Print(check)
+```
+
+For more information on checkstyle XML see: http://checkstyle.sourceforge.net/checks.html