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

Initial commit (not really ready for an initial commit)

Browse source
This commit is contained in:
Simon Brooke 2019-06-03 21:15:02 +01:00
parent 1afe9f71b0
commit 172b30b6ae
12 changed files with 356 additions and 230 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
CHANGELOG.md Normal file
View file

@ -0,0 +1,24 @@
# Change Log
All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
## [Unreleased]
### Changed
- Add a new arity to `make-widget-async` to provide a different widget shape.
## [0.1.1] - 2019-05-20
### Changed
- Documentation on how to make the widgets.
### Removed
- `make-widget-sync` - we're all async, all the time.
### Fixed
- Fixed widget maker to keep working when daylight savings switches over.
## 0.1.0 - 2019-05-20
### Added
- Files from the new template.
- Widget maker public API - `make-widget-sync`.
[Unreleased]: https://github.com/your-name/gusqt/compare/0.1.1...HEAD
[0.1.1]: https://github.com/your-name/gusqt/compare/0.1.0...0.1.1

393
LICENSE
View file

@ -1,277 +1,214 @@
Eclipse Public License - v 2.0 THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS 1. DEFINITIONS
"Contribution" means: "Contribution" means:
a) in the case of the initial Contributor, the initial content a) in the case of the initial Contributor, the initial code and
Distributed under this Agreement, and documentation distributed under this Agreement, and
b) in the case of each subsequent Contributor: b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from
and are Distributed by that particular Contributor. A Contribution
"originates" from a Contributor if it was added to the Program by
such Contributor itself or anyone acting on such Contributor's behalf.
Contributions do not include changes or additions to the Program that
are not Modified Works.
"Contributor" means any person or entity that Distributes the Program. i) changes to the Program, and
"Licensed Patents" mean patent claims licensable by a Contributor which ii) additions to the Program;
are necessarily infringed by the use or sale of its Contribution alone
or when combined with the Program.
"Program" means the Contributions Distributed in accordance with this where such changes and/or additions to the Program originate from and are
distributed by that particular Contributor. A Contribution 'originates' from
a Contributor if it was added to the Program by such Contributor itself or
anyone acting on such Contributor's behalf. Contributions do not include
additions to the Program which: (i) are separate modules of software
distributed in conjunction with the Program under their own license
agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which are
necessarily infringed by the use or sale of its Contribution alone or when
combined with the Program.
"Program" means the Contributions distributed in accordance with this
Agreement. Agreement.
"Recipient" means anyone who receives the Program under this Agreement "Recipient" means anyone who receives the Program under this Agreement,
or any Secondary License (as applicable), including Contributors. including all Contributors.
"Derivative Works" shall mean any work, whether in Source Code or other
form, that is based on (or derived from) the Program and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship.
"Modified Works" shall mean any work in Source Code or other form that
results from an addition to, deletion from, or modification of the
contents of the Program, including, for purposes of clarity any new file
in Source Code form that contains any contents of the Program. Modified
Works shall not include works that contain only declarations,
interfaces, types, classes, structures, or files of the Program solely
in each case in order to link to, bind by name, or subclass the Program
or Modified Works thereof.
"Distribute" means the acts of a) distributing or b) making available
in any manner that enables the transfer of a copy.
"Source Code" means the form of a Program preferred for making
modifications, including but not limited to software source code,
documentation source, and configuration files.
"Secondary License" means either the GNU General Public License,
Version 2.0, or any later versions of that license, including any
exceptions or additional permissions as identified by the initial
Contributor.
2. GRANT OF RIGHTS 2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby a) Subject to the terms of this Agreement, each Contributor hereby grants
grants Recipient a non-exclusive, worldwide, royalty-free copyright Recipient a non-exclusive, worldwide, royalty-free copyright license to
license to reproduce, prepare Derivative Works of, publicly display, reproduce, prepare derivative works of, publicly display, publicly perform,
publicly perform, Distribute and sublicense the Contribution of such distribute and sublicense the Contribution of such Contributor, if any, and
Contributor, if any, and such Derivative Works. such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby b) Subject to the terms of this Agreement, each Contributor hereby grants
grants Recipient a non-exclusive, worldwide, royalty-free patent Recipient a non-exclusive, worldwide, royalty-free patent license under
license under Licensed Patents to make, use, sell, offer to sell, Licensed Patents to make, use, sell, offer to sell, import and otherwise
import and otherwise transfer the Contribution of such Contributor, transfer the Contribution of such Contributor, if any, in source code and
if any, in Source Code or other form. This patent license shall object code form. This patent license shall apply to the combination of the
apply to the combination of the Contribution and the Program if, at Contribution and the Program if, at the time the Contribution is added by the
the time the Contribution is added by the Contributor, such addition Contributor, such addition of the Contribution causes such combination to be
of the Contribution causes such combination to be covered by the covered by the Licensed Patents. The patent license shall not apply to any
Licensed Patents. The patent license shall not apply to any other other combinations which include the Contribution. No hardware per se is
combinations which include the Contribution. No hardware per se is licensed hereunder.
licensed hereunder.
c) Recipient understands that although each Contributor grants the c) Recipient understands that although each Contributor grants the licenses
licenses to its Contributions set forth herein, no assurances are to its Contributions set forth herein, no assurances are provided by any
provided by any Contributor that the Program does not infringe the Contributor that the Program does not infringe the patent or other
patent or other intellectual property rights of any other entity. intellectual property rights of any other entity. Each Contributor disclaims
Each Contributor disclaims any liability to Recipient for claims any liability to Recipient for claims brought by any other entity based on
brought by any other entity based on infringement of intellectual infringement of intellectual property rights or otherwise. As a condition to
property rights or otherwise. As a condition to exercising the exercising the rights and licenses granted hereunder, each Recipient hereby
rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights
assumes sole responsibility to secure any other intellectual needed, if any. For example, if a third party patent license is required to
property rights needed, if any. For example, if a third party allow Recipient to distribute the Program, it is Recipient's responsibility
patent license is required to allow Recipient to Distribute the to acquire that license before distributing the Program.
Program, it is Recipient's responsibility to acquire that license
before distributing the Program.
d) Each Contributor represents that to its knowledge it has d) Each Contributor represents that to its knowledge it has sufficient
sufficient copyright rights in its Contribution, if any, to grant copyright rights in its Contribution, if any, to grant the copyright license
the copyright license set forth in this Agreement. set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no
Contributor makes additional grants to any Recipient (other than
those set forth in this Agreement) as a result of such Recipient's
receipt of the Program under the terms of a Secondary License
(if permitted under the terms of Section 3).
3. REQUIREMENTS 3. REQUIREMENTS
3.1 If a Contributor Distributes the Program in any form, then: A Contributor may choose to distribute the Program in object code form under
its own license agreement, provided that:
a) the Program must also be made available as Source Code, in a) it complies with the terms and conditions of this Agreement; and
accordance with section 3.2, and the Contributor must accompany
the Program with a statement that the Source Code for the Program
is available under this Agreement, and informs Recipients how to
obtain it in a reasonable manner on or through a medium customarily
used for software exchange; and
b) the Contributor may Distribute the Program under a license b) its license agreement:
different than this Agreement, provided that such license:
i) effectively disclaims on behalf of all other Contributors all
warranties and conditions, express and implied, including
warranties or conditions of title and non-infringement, and
implied warranties or conditions of merchantability and fitness
for a particular purpose;
ii) effectively excludes on behalf of all other Contributors all i) effectively disclaims on behalf of all Contributors all warranties and
liability for damages, including direct, indirect, special, conditions, express and implied, including warranties or conditions of title
incidental and consequential damages, such as lost profits; and non-infringement, and implied warranties or conditions of merchantability
and fitness for a particular purpose;
iii) does not attempt to limit or alter the recipients' rights ii) effectively excludes on behalf of all Contributors all liability for
in the Source Code under section 3.2; and damages, including direct, indirect, special, incidental and consequential
damages, such as lost profits;
iv) requires any subsequent distribution of the Program by any iii) states that any provisions which differ from this Agreement are offered
party to be under a license that satisfies the requirements by that Contributor alone and not by any other party; and
of this section 3.
3.2 When the Program is Distributed as Source Code: iv) states that source code for the Program is available from such
Contributor, and informs licensees how to obtain it in a reasonable manner on
or through a medium customarily used for software exchange.
a) it must be made available under this Agreement, or if the When the Program is made available in source code form:
Program (i) is combined with other material in a separate file or
files made available under a Secondary License, and (ii) the initial
Contributor attached to the Source Code the notice described in
Exhibit A of this Agreement, then the Program may be made available
under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of a) it must be made available under this Agreement; and
the Program.
3.3 Contributors may not remove or alter any copyright, patent, b) a copy of this Agreement must be included with each copy of the Program.
trademark, attribution notices, disclaimers of warranty, or limitations
of liability ("notices") contained within the Program from any copy of Contributors may not remove or alter any copyright notices contained within
the Program which they Distribute, provided that Contributors may add the Program.
their own appropriate notices.
Each Contributor must identify itself as the originator of its Contribution,
if any, in a manner that reasonably allows subsequent Recipients to identify
the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION 4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities Commercial distributors of software may accept certain responsibilities with
with respect to end users, business partners and the like. While this respect to end users, business partners and the like. While this license is
license is intended to facilitate the commercial use of the Program, intended to facilitate the commercial use of the Program, the Contributor who
the Contributor who includes the Program in a commercial product includes the Program in a commercial product offering should do so in a
offering should do so in a manner which does not create potential manner which does not create potential liability for other Contributors.
liability for other Contributors. Therefore, if a Contributor includes Therefore, if a Contributor includes the Program in a commercial product
the Program in a commercial product offering, such Contributor offering, such Contributor ("Commercial Contributor") hereby agrees to defend
("Commercial Contributor") hereby agrees to defend and indemnify every and indemnify every other Contributor ("Indemnified Contributor") against any
other Contributor ("Indemnified Contributor") against any losses, losses, damages and costs (collectively "Losses") arising from claims,
damages and costs (collectively "Losses") arising from claims, lawsuits lawsuits and other legal actions brought by a third party against the
and other legal actions brought by a third party against the Indemnified Indemnified Contributor to the extent caused by the acts or omissions of such
Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in
Commercial Contributor in connection with its distribution of the Program a commercial product offering. The obligations in this section do not apply
in a commercial product offering. The obligations in this section do not to any claims or Losses relating to any actual or alleged intellectual
apply to any claims or Losses relating to any actual or alleged property infringement. In order to qualify, an Indemnified Contributor must:
intellectual property infringement. In order to qualify, an Indemnified a) promptly notify the Commercial Contributor in writing of such claim, and
Contributor must: a) promptly notify the Commercial Contributor in b) allow the Commercial Contributor to control, and cooperate with the
writing of such claim, and b) allow the Commercial Contributor to control, Commercial Contributor in, the defense and any related settlement
and cooperate with the Commercial Contributor in, the defense and any negotiations. The Indemnified Contributor may participate in any such claim
related settlement negotiations. The Indemnified Contributor may at its own expense.
participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial For example, a Contributor might include the Program in a commercial product
product offering, Product X. That Contributor is then a Commercial offering, Product X. That Contributor is then a Commercial Contributor. If
Contributor. If that Commercial Contributor then makes performance that Commercial Contributor then makes performance claims, or offers
claims, or offers warranties related to Product X, those performance warranties related to Product X, those performance claims and warranties are
claims and warranties are such Commercial Contributor's responsibility such Commercial Contributor's responsibility alone. Under this section, the
alone. Under this section, the Commercial Contributor would have to Commercial Contributor would have to defend claims against the other
defend claims against the other Contributors related to those performance Contributors related to those performance claims and warranties, and if a
claims and warranties, and if a court requires any other Contributor to court requires any other Contributor to pay any damages as a result, the
pay any damages as a result, the Commercial Contributor must pay Commercial Contributor must pay those damages.
those damages.
5. NO WARRANTY 5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the
PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks
appropriateness of using and distributing the Program and assumes all associated with its exercise of rights under this Agreement , including but
risks associated with its exercise of rights under this Agreement, not limited to the risks and costs of program errors, compliance with
including but not limited to the risks and costs of program errors, applicable laws, damage to or loss of data, programs or equipment, and
compliance with applicable laws, damage to or loss of data, programs unavailability or interruption of operations.
or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY 6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
POSSIBILITY OF SUCH DAMAGES. OF SUCH DAMAGES.
7. GENERAL 7. GENERAL
If any provision of this Agreement is invalid or unenforceable under If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of applicable law, it shall not affect the validity or enforceability of the
the remainder of the terms of this Agreement, and without further remainder of the terms of this Agreement, and without further action by the
action by the parties hereto, such provision shall be reformed to the parties hereto, such provision shall be reformed to the minimum extent
minimum extent necessary to make such provision valid and enforceable. necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity If Recipient institutes patent litigation against any entity (including a
(including a cross-claim or counterclaim in a lawsuit) alleging that the cross-claim or counterclaim in a lawsuit) alleging that the Program itself
Program itself (excluding combinations of the Program with other software (excluding combinations of the Program with other software or hardware)
or hardware) infringes such Recipient's patent(s), then such Recipient's infringes such Recipient's patent(s), then such Recipient's rights granted
rights granted under Section 2(b) shall terminate as of the date such under Section 2(b) shall terminate as of the date such litigation is filed.
litigation is filed.
All Recipient's rights under this Agreement shall terminate if it All Recipient's rights under this Agreement shall terminate if it fails to
fails to comply with any of the material terms or conditions of this comply with any of the material terms or conditions of this Agreement and
Agreement and does not cure such failure in a reasonable period of does not cure such failure in a reasonable period of time after becoming
time after becoming aware of such noncompliance. If all Recipient's aware of such noncompliance. If all Recipient's rights under this Agreement
rights under this Agreement terminate, Recipient agrees to cease use terminate, Recipient agrees to cease use and distribution of the Program as
and distribution of the Program as soon as reasonably practicable. soon as reasonably practicable. However, Recipient's obligations under this
However, Recipient's obligations under this Agreement and any licenses Agreement and any licenses granted by Recipient relating to the Program shall
granted by Recipient relating to the Program shall continue and survive. continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, Everyone is permitted to copy and distribute copies of this Agreement, but in
but in order to avoid inconsistency the Agreement is copyrighted and order to avoid inconsistency the Agreement is copyrighted and may only be
may only be modified in the following manner. The Agreement Steward modified in the following manner. The Agreement Steward reserves the right to
reserves the right to publish new versions (including revisions) of publish new versions (including revisions) of this Agreement from time to
this Agreement from time to time. No one other than the Agreement time. No one other than the Agreement Steward has the right to modify this
Steward has the right to modify this Agreement. The Eclipse Foundation Agreement. The Eclipse Foundation is the initial Agreement Steward. The
is the initial Agreement Steward. The Eclipse Foundation may assign the Eclipse Foundation may assign the responsibility to serve as the Agreement
responsibility to serve as the Agreement Steward to a suitable separate Steward to a suitable separate entity. Each new version of the Agreement will
entity. Each new version of the Agreement will be given a distinguishing be given a distinguishing version number. The Program (including
version number. The Program (including Contributions) may always be Contributions) may always be distributed subject to the version of the
Distributed subject to the version of the Agreement under which it was Agreement under which it was received. In addition, after a new version of
received. In addition, after a new version of the Agreement is published, the Agreement is published, Contributor may elect to distribute the Program
Contributor may elect to Distribute the Program (including its (including its Contributions) under the new version. Except as expressly
Contributions) under the new version. stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
licenses to the intellectual property of any Contributor under this
Agreement, whether expressly, by implication, estoppel or otherwise. All
rights in the Program not expressly granted under this Agreement are
reserved.
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient This Agreement is governed by the laws of the State of New York and the
receives no rights or licenses to the intellectual property of any intellectual property laws of the United States of America. No party to this
Contributor under this Agreement, whether expressly, by implication, Agreement will bring a legal action under this Agreement more than one year
estoppel or otherwise. All rights in the Program not expressly granted after the cause of action arose. Each party waives its rights to a jury trial
under this Agreement are reserved. Nothing in this Agreement is intended in any resulting litigation.
to be enforceable by any entity that is not a Contributor or Recipient.
No third-party beneficiary rights are created under this Agreement.
Exhibit A - Form of Secondary Licenses Notice
"This Source Code may also be made available under the following
Secondary Licenses when the conditions for such availability set forth
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
version(s), and exceptions or additional permissions here}."
Simply including a copy of this Agreement, including this Exhibit A
is not sufficient to license the Source Code under Secondary Licenses.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to
look for such a notice.
You may add additional accurate notices of copyright ownership.

41
README.md
View file

@ -1,2 +1,39 @@
# gusqt # Grand Unified Software Quality Tool
Grand Unified Software Quality Tool
Intended to be a wrapper into which many software quality tools can be plugged, and which will produce two separate outputs:
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
## License
Copyright © 2019 Simon Brooke
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.

3
doc/intro.md Normal file
View file

@ -0,0 +1,3 @@
# Introduction to gusqt
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)

13
project.clj Normal file
View file

@ -0,0 +1,13 @@
(defproject gusqt "0.1.0-SNAPSHOT"
:description "Grand Unified Software Quality Tool"
:url "http://example.com/FIXME"
:license {:name "Eclipse Public License"
:url "http://www.eclipse.org/legal/epl-v10.html"}
:dependencies [[org.clojure/clojure "1.8.0"]
[cloverage "1.1.1"]
[clj-tagsoup "0.3.0"]
[codox "0.10.7"]
[enlive "1.1.6"]]
:main ^:skip-aot gusqt.core
:target-path "target/%s"
:profiles {:uberjar {:aot :all}})

7
src/gusqt/core.clj Normal file
View file

@ -0,0 +1,7 @@
(ns gusqt.core
(:gen-class))
(defn -main
"I don't do a whole lot ... yet."
[& args]
(println "Hello, World!"))

46
src/gusqt/docgen/README.md Normal file
View file

@ -0,0 +1,46 @@
# Grand Unified Software Quality Tool: Documentation generation
The general idea here is to run each client tool to generate documentation, then read that documentation (if in HTML, via `clj-tagsoup`), integrate it, and emit the integrated documentation as HTML (via `enlive`).
## Broad structure of the final HTML
### Annotated source files
For each source (.clj, .cljc, .cljs) file in the project, a single HTML formatted 'annotated source' file will be output showing issues detected by all of the various tools.
Most of the tools we're working with are file oriented and line oriented, rather than structure oriented. While I am utterly convinced this is a wrong choice for any Lisp tool, converting it all to structure oriented is a job outwith the scope of this exercise, so we'll go with two essential levels of structure, as follows
```html
<div class="top-level-form">
<div class="line warn" id="line-147">
<code class="src">147 (and (number? q) (> q 0)))</code>
<dl>
<dt class="cloverage"><a href="">Cloverage</a></dt>
<dd class="cloverage info">9 out of 10 forms covered</dd>
<dt class="kibit"><a href="https://github.com/jonase/kibit">Kibit</a></dt>
<dd class="kibit warn">Consider using: <code>(pos? q)</code> instead of: <code>(> q 0)</code></dd>
</dl>
</div>
</div>
```
That is to say,
1. for each top level form we'll have a div with the class `top-level-form`, and, ideally, an id that reflects its content where possible;
2. for each line we'll have a div within the div for the relevant top level form, having the class `line` and the id `line-xxx`, where `xxx` is the serial number of the line within the file.
The line div may also have a class indicating the **seriousness** of any issues found by any tool within the line, taken from:
* `info`
* `warn`
* `error`
* `fail`
It's possible that another level of seriousness is needed between `info` and `error` - not all warnings are as strong as one another. Where two or more tools report an issue, the greatest seriousness will be used in the class of the line div.
Within the line div, we'll have
1. a `code` element containing the source line copied from the source file, with the line number prepended;
2. a `dl` element containing one `dt`/`dd` pair for each tool reporting an issue with that line, where:
3. the `dt` element shall have a class derived from the name of the tool, and shall contain as text the name of the tool, and probably a link to its documentation;
4. the `dd` element shall have the same class derived from the name of the tool, and an additional class derived from the **seriousness** list above

12
src/gusqt/wrappers/README.md Normal file
View file

@ -0,0 +1,12 @@
# Grand Unified Software Quality Tool: Wrappers
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
2. `as-markdown` output in the form of human-readable markdown

0
src/gusqt/wrappers/cloverage.clj Normal file
View file

4
src/gusqt/wrappers/codox.clj Normal file
View file

@ -0,0 +1,4 @@
(ns gusqt.wrappers.codox
"Wrapper for `codox`"
(:require [gusqt.wrappers.utils :as u]
)

36
src/gusqt/wrappers/utils.clj Normal file
View file

@ -0,0 +1,36 @@
(ns gusqt.wrappers.utils
"Utility functions useful to wrappers"
(:require [clojure.string :as s]))
(defn reads-as-number?
"if `x` is a number or is a string representation of a number,
returns the numerical value of `x`; else false."
[x]
(let [v (try (read-string x) (catch Exception any))]
(cond
(number? x) x
(number? v) v
:else false)))
(reads-as-number? :foo)
(defn c-error-to-map
([text]
(c-error-to-map text :unknown))
([text tool]
(map
#(let [lines (s/split % #"\n")
[_ file line column severity message] (re-matches #"(.+):(\d+):(\d+): (\w+): (.*)" (first lines))]
{:tool tool
:file file
:line line
:column column
:severity severity
:message (s/trim (s/join "\n" (cons message (rest lines))))})
(s/split text #"[\r\n|\n]+"))))
(c-error-to-map (slurp "../smeagol/kondo.txt") :kondo)

7
test/gusqt/core_test.clj Normal file
View file

@ -0,0 +1,7 @@
(ns gusqt.core-test
(:require [clojure.test :refer :all]
[gusqt.core :refer :all]))
(deftest a-test
(testing "FIXME, I fail."
(is (= 0 1))))