UNPKG

vfile-reporter-shiny

Version:

Shiny reporter for vfile

github.com/vweevers/vfile-reporter-shiny

vweevers/vfile-reporter-shiny

48 lines (31 loc) • 2.18 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# vfile-reporter-shiny **Shiny reporter for [`vfile`](https://github.com/vfile/vfile).** Visually similar to [`vfile-reporter-pretty`](https://github.com/vfile/vfile-reporter-pretty) but avoids a transformation to eslint messages which allows us to support info messages. In addition, it adds hyperlinks to [`remark`](https://remark.js.org/) and [`attend`](https://github.com/vweevers/attend) rules and enables unicode output and hyperlinks in Windows Terminal. [![npm](http://img.shields.io/npm/v/vfile-reporter-shiny.svg)](https://www.npmjs.org/package/vfile-reporter-shiny) [![Node version](https://img.shields.io/node/v/vfile-reporter-shiny.svg)](https://www.npmjs.org/package/vfile-reporter-shiny) [![Test](https://img.shields.io/github/workflow/status/vweevers/vfile-reporter-shiny/Test?label=test)](https://github.com/vweevers/vfile-reporter-shiny/actions/workflows/test.yml) [![Standard](https://img.shields.io/badge/standard-informational?logo=javascript&logoColor=fff)](https://standardjs.com) [![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org) ![screenshot](screenshot.png) ## Highlights - Sorts results by severity. - Stylizes inline codeblocks in messages. - In [terminals that support hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps): - Rules are linked to their docs. This works for [`eslint`](https://eslint.org/), [`remark`](https://remark.js.org/) and [`attend`](https://github.com/vweevers/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](https://github.com/vweevers/attend) Nothing to do. It's the default reporter. ### [Unified](https://unifiedjs.com/) ``` remark --report vfile-reporter-shiny . ``` ### [Hallmark](https://github.com/vweevers/hallmark) Nothing to do. It's the default reporter. ## License [MIT](LICENSE). Forked from [`eslint-formatter-pretty`](https://github.com/sindresorhus/eslint-formatter-pretty).