Report shapes
the JSON document and the count per check that wiki check writes for another tool
wiki check says everything as sentences for a person, which is what wiki check
describes. One of these two shapes may be given, never both, and neither changes the exit
code.[1]
JSON
--json writes the page count, a record per problem, and the marked claims in a list of their
own.[2] A record names the file, the line where there is one, the check that refused it, and the
sentence carried unchanged, so a problem the fields do not fit still reads.[3] A marked claim
never joins the problems, because it fails nothing.[2] Nothing else is written, on either stream, and
two runs write the same bytes.[2]
{
"marks": [],
"pages": 3,
"problems": [
{
"file": "thing.md",
"line": 22,
"message": "thing.md:22: “It says nothing.” states something and cites nothing; give it a reference, or {missing} if there is none",
"rule": "uncited"
}
]
}
Each rule names the check that refused it; a marked claim is named missing.[4]
Count per check
--summary counts the problems by check, most first and by name where two tie.[5] A wiki of a
few hundred pages prints more lines than a build log holds, and a log that drops its oldest lines drops
the problems first.[5]
wiki: 292 family
wiki: 207 pointing
wiki: 186 uncited
wiki: 346 pages, 685 problems