diff --git a/README.md b/README.md index 3b770b0..41028d7 100644 --- a/README.md +++ b/README.md @@ -5,35 +5,13 @@ Intended to be a wrapper into which many software quality tools can be plugged, 1. an EDN map, integrating all the issues found be any of the tools, which can be parsed by an IDE to provide located notfications; 2. A directory of human-readable, Markdown or HTML, documentation, including not only docstrings culled from the source but also test output, coverage, linter warnings, etc. -## Installation - -Download from http://example.com/FIXME. - ## Usage -FIXME: explanation - - $ java -jar gusqt-0.1.0-standalone.jar [args] - -## Options - -FIXME: listing of options this app accepts. - -## Examples - -... - -### Bugs - -... - -### Any Other Sections -### That You Think -### Might be Useful +Doesn't work yet ## License Copyright © 2019 Simon Brooke -Distributed under the Eclipse Public License either version 1.0 or (at +Distributed under the Eclipse Public License either version 2.0 or (at your option) any later version. diff --git a/src/gusqt/wrappers/README.md b/src/gusqt/wrappers/README.md index 0421fb5..5e1efff 100644 --- a/src/gusqt/wrappers/README.md +++ b/src/gusqt/wrappers/README.md @@ -3,10 +3,32 @@ Wrappers are intended to produce unifiable output from the specific tools they wrap. This unifiable output as follows: 1. `as-edn` output in the form of a sequence of maps, with keys as follows: -# `column` (optional) the locus of the report within the line -# `file` the name of the source file analysed -# `line` the locus of the report -# `severity` one of `:fail :error :warn :info` -# `tool` (as a keyword) the name of the tool producing the report -# `text` Human readable (optionally markdown formatted) text of the report +* `column` (optional) the locus of the report within the line +* `file` the name of the source file analysed +* `line` the locus of the report +* `severity` one of `:fail :error :warn :info` +* `tool` (as a keyword) the name of the tool producing the report +* `text` Human readable (optionally markdown formatted) text of the report 2. `as-markdown` output in the form of human-readable markdown + + +The full EDN structure is something like this, so that EDNs generated by separate tools can be read and deep-merged. + +```clojure +{:file "pathname/of/file.clj" + :lines + {147 + {:cloverage + (:line 147 + :column 0 + :severity :info + :tool :cloverage + :text "9 out of 10 forms covered"} + :kibit + {:line 147 + :column 37 + :severity :warn + :tool :kibit + :text "Consider using: `(pos? q)` instead of: `(> q 0)`"}}} + +```