Nitrogenous Polymorphic Molecule
    Have ideas to improve npm?Join in the discussion! »

    vfile-reporter-json

    2.0.2 • Public • Published

    vfile-reporter-json

    Build Coverage Downloads Sponsors Backers Chat

    Format vfiles as stringified JSON.

    Install

    npm:

    npm install vfile-reporter-json

    Use

    var vfile = require('vfile')
    var reporter = require('vfile-reporter-json')
    
    var one = vfile({path: 'test/fixture/1.js'})
    var two = vfile({path: 'test/fixture/2.js'})
    
    one.message('Warning!', {line: 2, column: 4})
    
    console.log(reporter([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,"location":{"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

    reporter(files[, options])

    Generate stringified JSON for files (VFile or Array.<VFile>).

    options.quiet

    Do not output anything for a file which has no warnings or errors (boolean, default: false). The default behavior is to show a success message.

    options.silent

    Do not output messages without fatal set to true (boolean, default: false). Also sets quiet to true.

    options.pretty

    Given as space to JSON.stringify() (boolean, number, or string, default: 0). When true, defaults to 2.

    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

    Install

    npm i vfile-reporter-json

    DownloadsWeekly Downloads

    50

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    7.71 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar