npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vfile-reporter-json

v4.0.0

Published

vfile utility to create a JSON report for a file

Downloads

8,132

Readme

vfile-reporter-json

Build Coverage Downloads Size Sponsors Backers Chat

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 16+), install with npm:

npm install vfile-reporter-json

In Deno with esm.sh:

import {reporterJson} from 'https://esm.sh/vfile-reporter-json@4'

In browsers with esm.sh:

<script type="module">
  import {reporterJson} from 'https://esm.sh/vfile-reporter-json@4?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":[{"column":4,"fatal":false,"line":2,"place":{"line":2,"column":4},"reason":"Warning!"}]},{"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
  • files (Array<VFile> or VFile) — file or files to report
  • options (Options, default: {}) — configuration
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
  • cwd (string) — base of path
  • 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
  • path (string) — full path (example: '~/index.min.js')

JsonMessage

JSON message (TypeScript type).

Fields
  • ancestors (Array<Node> or undefined) — stack of ancestor nodes surrounding the message
  • column (number or undefined) — starting column of message
  • fatal (boolean or undefined) — state of problem; true: error, file not usable; false: warning, change may be needed; undefined: change likely not needed
  • line (number or undefined) — starting line of message
  • place (Point, Position, or undefined) — place of message
  • reason (string) — reason for message, should use markdown
  • ruleId (string | null) — category of message (example: 'my-rule')
  • source (string | null) — namespace of message (example: 'my-package')
  • 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 of actual
  • note (string | null | undefined) — long form description of the message, should use markdown
  • url (string | null | undefined) — link to docs for the message; this must be an absolute URL that can be passed as x to new URL(x)

Options

Configuration (TypeScript type).

Fields
  • pretty (boolean, number, or string, default: 0) — value of space of JSON.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 sets quiet to true

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 maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, vfile-reporter-json@^4, compatible with Node.js 16.

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.

License

MIT © Titus Wormer