vfile-reporter-json
vfile utility to create a report in machine readable JSON.
Contents
What is this?
This package is like vfile-reporter
but it outputs machine
readable JSON.
When should I use this?
You can use this when you need to serialize lint results for machines, use
vfile-reporter
itself for humans.
Install
This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:
npm install vfile-reporter-json
In Deno with esm.sh
:
import {reporterJson} from 'https://esm.sh/vfile-reporter-json@3'
In browsers with esm.sh
:
<script type="module">
import {reporterJson} from 'https://esm.sh/vfile-reporter-json@3?bundle'
</script>
Use
import {VFile} from 'vfile'
import {reporterJson} from 'vfile-reporter-json'
const one = new VFile({path: 'test/fixture/1.js'})
const two = new VFile({path: 'test/fixture/2.js'})
one.message('Warning!', {line: 2, column: 4})
console.log(reporterJson([one, two]))
Yields:
[{"path":"test/fixture/1.js","cwd":"/Users/tilde/projects/oss/vfile-reporter-json","history":["test/fixture/1.js"],"messages":[{"reason":"Warning!","line":2,"column":4,"position":{"start":{"line":2,"column":4},"end":{"line":null,"column":null}},"ruleId":null,"source":null,"fatal":false,"stack":null}]},{"path":"test/fixture/2.js","cwd":"/Users/tilde/projects/oss/vfile-reporter-json","history":["test/fixture/2.js"],"messages":[]}]
API
This package exports the identifier reporterJson
.
That identifier is also the default export.
reporterJson(files[, options])
Create a serialized JSON report from one file or multiple files.
Parameters
Returns
Report as serialized JSON (string
).
Reporters must return strings, which is why serialized JSON is exposed.
You can parse the result with JSON.parse
, in which case you will get
Array<JsonFile>
.
JsonFile
JSON file (TypeScript type).
Fields
-
path
(string
) — full path (example:'~/index.min.js'
) -
cwd
(string
) — base ofpath
-
history
(Array<string>
) — list of filepaths the file moved between; the first is the original path and the last is the current path -
messages
(Array<JsonMessage>
) — list of filepaths the file moved between; the first is the original path and the last is the current path
JsonMessage
JSON message (TypeScript type).
Fields
-
stack
(string | null
) — stack of message; this is used by normal errors to show where something happened in programming code -
reason
(string
) — reason for message; you should use markdown -
fatal
(boolean | null | undefined
) — state of problem;true
marks associated file as no longer processable (error);false
necessitates a (potential) change (warning);null | undefined
for things that might not need changing (info) -
line
(number | null
) — starting line of error -
column
(number | null
) — starting column of error -
position
(Position | null
) — full unist position -
source
(string | null
) — namespace of message (example:'my-package'
) -
ruleId
(string | null
) — category of message (example:'my-rule'
) -
actual
(string | null | undefined
) — specify the source value that’s being reported, which is deemed incorrect -
expected
(Array<string> | null | undefined
) — suggest acceptable values that can be used instead ofactual
-
url
(string | null | undefined
) — link to docs for the message; this must be an absolute URL that can be passed asx
tonew URL(x)
-
note
(string | null | undefined
) — long form description of the message (should use markdown)
Options
Configuration (TypeScript type).
Fields
-
pretty
(number | string | boolean
, default:0
) — value ofspace
ofJSON.stringify(x, undefined, space)
-
quiet
(boolean
, default:false
) — do not show files without messages -
silent
(boolean
, default:false
) — show errors only; this does not show info and warning messages; also setsquiet
totrue
Types
This package is fully typed with TypeScript.
It exports the additional types JsonFile
,
JsonMessage
, and Options
.
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Contribute
See contributing.md
in vfile/.github
for ways to
get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.