vfile-reporter
    TypeScript icon, indicating that this package has built-in type declarations

    7.0.4 • Public • Published

    vfile-reporter

    Build Coverage Downloads Sponsors Backers Chat

    vfile utility to create a report from a file.

    Example screenshot of vfile-reporter

    Contents

    What is this?

    This package create a textual report from a file showing the warnings that occurred while processing. Many CLIs of tools that process files, whether linters (such as ESLint) or bundlers (such as esbuild), have similar functionality.

    When should I use this?

    You can use this package whenever you want to display a report about what occurred while processing to a human.

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

    npm install vfile-reporter

    In Deno with esm.sh:

    import {reporter} from 'https://esm.sh/vfile-reporter@7'

    In browsers with esm.sh:

    <script type="module">
      import {reporter} from 'https://esm.sh/vfile-reporter@7?bundle'
    </script>

    Use

    Say example.js contains:

    import {VFile} from 'vfile'
    import {reporter} from 'vfile-reporter'
    
    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.error(reporter([one, two]))

    Now, running node example yields:

    test/fixture/1.js
      2:4  warning  Warning!
    
    test/fixture/2.js: no issues found
    
    ⚠ 1 warning
    

    API

    This package exports the identifier reporter. That value is also the default export.

    reporter(files[, options])

    Create a report from an error, on file, or multiple files.

    options

    Configuration (optional).

    options.color

    Use ANSI colors in report (boolean, default: depends). The default behavior is the check if color is supported.

    options.verbose

    Show message notes (boolean, default: false). Notes are optional, additional, long descriptions.

    options.quiet

    Do not show files without messages (boolean, default: false).

    options.silent

    Show errors only (boolean, default: false). This does not show info and warning messages. Also sets quiet to true.

    options.defaultName

    Label to use for files without file path (string, default: '<stdin>'). If one file and no defaultName is given, no name will show up in the report.

    Returns

    string.

    Types

    This package is fully typed with TypeScript. It exports the additional type Options.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Security

    Use of vfile-reporter is safe.

    Related

    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, organisation, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Forked from ESLint’s stylish reporter (originally created by Sindre Sorhus), which is Copyright (c) 2013 Nicholas C. Zakas, and licensed under MIT.

    Install

    npm i vfile-reporter

    DownloadsWeekly Downloads

    229,784

    Version

    7.0.4

    License

    MIT

    Unpacked Size

    18.5 kB

    Total Files

    15

    Last publish

    Collaborators

    • wooorm