simon/gusqt
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Made documentation a bit more readable for other folk

Browse source
This commit is contained in:
Simon Brooke 2019-06-03 21:31:13 +01:00
parent 172b30b6ae
commit b38f65ecb3
2 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -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; 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. 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 ## Usage
FIXME: explanation Doesn't work yet
$ 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
## License ## License
Copyright © 2019 Simon Brooke 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. your option) any later version.

34
src/gusqt/wrappers/README.md
View file

@ -3,10 +3,32 @@
Wrappers are intended to produce unifiable output from the specific tools they wrap. This unifiable output as follows: 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: 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 * `column` (optional) the locus of the report within the line
# `file` the name of the source file analysed * `file` the name of the source file analysed
# `line` the locus of the report * `line` the locus of the report
# `severity` one of `:fail :error :warn :info` * `severity` one of `:fail :error :warn :info`
# `tool` (as a keyword) the name of the tool producing the report * `tool` (as a keyword) the name of the tool producing the report
# `text` Human readable (optionally markdown formatted) text of the report * `text` Human readable (optionally markdown formatted) text of the report
2. `as-markdown` output in the form of human-readable markdown 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)`"}}}
```