Package detail

vfile-reporter-shiny

vweevers1.8kMIT1.0.1

Shiny reporter for vfile

vfile, vfile-reporter, formatter, reporter

readme

vfile-reporter-shiny

Shiny reporter for vfile. Visually similar to vfile-reporter-pretty but avoids a transformation to eslint messages which allows us to support info messages. In addition, it adds hyperlinks to remark and attend rules and enables unicode output and hyperlinks in Windows Terminal.

npm Node version Test Standard Common Changelog

screenshot

Highlights

  • Sorts results by severity.
  • Stylizes inline codeblocks in messages.
  • In terminals that support hyperlinks:
    • Rules are linked to their docs. This works for eslint, remark and attend rules.
    • Literal urls in messages become links
    • Literal GitHub urls are displayed as e.g. vweevers/vfile-reporter-shiny#1
  • In iTerm and ConEmu, click a filename to open it in your editor.

Install

npm install vfile-reporter-shiny

Usage

Attend

Nothing to do. It's the default reporter.

Unified

remark --report vfile-reporter-shiny .

Hallmark

Nothing to do. It's the default reporter.

License

MIT. Forked from eslint-formatter-pretty.

changelog

Changelog

1.0.1 - 2021-11-14

Changed

1.0.0 - 2021-11-13

Changed

  • Breaking: use ESM and drop Node.js < 12.20 (2f283a3)
  • Bump unist-util-stringify-position (da07de7)
  • Bump string-width (b692c6f)
  • Bump plur (648c8bb)
  • Bump ansi-escapes (d30ac35)

0.1.2 - 2020-11-23

Added

  • Link and shorten literal & markdown urls (8e7dca2)

Fixed

  • Fix color & hyperlink support checks (32fb165)
  • Fix formatting of empty ruleId (ab6fa5a)

0.1.1 - 2020-11-22

Changed

  • Stylize code blocks with cyan instead of bold (94e1ccf)

0.1.0 - 2020-11-20

:seedling: Initial release.