https://github.com/aj-dev/jscs-json-reporter

Saves JSCS results to a JSON file
https://github.com/aj-dev/jscs-json-reporter

grunt-jscs javascript json-report node-jscs

Last synced: 11 months ago
JSON representation

Saves JSCS results to a JSON file

• Host: GitHub
• URL: https://github.com/aj-dev/jscs-json-reporter
• Owner: aj-dev
• License: mit
• Created: 2015-03-09T18:43:34.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-11-28T10:56:58.000Z (over 9 years ago)
• Last Synced: 2025-07-08T23:02:34.893Z (11 months ago)
• Topics: grunt-jscs, javascript, json-report, node-jscs
• Language: JavaScript
• Size: 91.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# jscs-json-reporter [![npmVersion](http://img.shields.io/npm/v/jscs-json-reporter.svg)](https://www.npmjs.org/package/jscs-json-reporter)

[![Build Status](https://travis-ci.org/aj-dev/jscs-json-reporter.svg?branch=master)](https://travis-ci.org/aj-dev/jscs-json-reporter)

[![Dependencies](https://david-dm.org/aj-dev/jscs-json-reporter.svg)](https://david-dm.org/aj-dev/jscs-json-reporter#info=dependencies&view=table)

[![DevDependencies](https://david-dm.org/aj-dev/jscs-json-reporter/dev-status.svg)](https://david-dm.org/aj-dev/jscs-json-reporter#info=devDependencies&view=table) [![npm](https://img.shields.io/npm/dm/jscs-json-reporter.svg)](https://www.npmjs.com/package/jscs-json-reporter)

A JSON reporter for [node-jscs](https://github.com/mdevils/node-jscs) and [grunt-jscs](https://github.com/jscs-dev/grunt-jscs).

## Getting started

Install using npm:

`npm install jscs-json-reporter --save-dev`

## Usage

#### When using with [node-jscs](https://github.com/mdevils/node-jscs)

Set the path to `jscs-json-reporter`. Command line example:

`jscs app.js --reporter node_modules/jscs-json-reporter/jscs-json-reporter.js`

Report will be written to `jscs-report.json` in current working directory.

#### When using with [grunt-jscs](https://github.com/jscs-dev/grunt-jscs)

Configure `jscs` in `Gruntfile.js` so that `reporter` points to `jscs-json-reporter.js` and `reporterOutput` points to some JSON file.

```javascript

jscs: {

    src: [

    	'path/to/files/*.js',

    	'another/path/to/files/**/*.js'

    ],

    options: {

    	maxErrors: null,

        reporter: require('jscs-json-reporter').path,

        reporterOutput: path.resolve('/path/to/jscs-report.json')

    }

}

```

## Example

![alt text](https://raw.githubusercontent.com/aj-dev/jscs-json-reporter/master/jscs-json-reporter.png 'JSCS JSON Reporter example')

`"explainedError"` key contains a preformatted string with detailed error info.

When used inside HTML `
` tags it is displayed like this:

![alt text](https://raw.githubusercontent.com/aj-dev/jscs-json-reporter/master/explained-error-preformatted.png 'Explained error property preformatted example')


## Important!

Generated JSON file size might be very large depending on the number of errors. For instance, a file containing 4500 errors is around 2.85 MB.

## License

Licensed under the MIT license. Copyright (c) 2015 - 2016 Audrius Jakumavicius