jshint-md-reporter

This reporter is to be used with JSHint to log errors out to a file in markdown. This is useful for creating error files that are easy to view in any markdown viewer.

Example Output

Installation

$ npm install jshint-md-reporter --save-dev

Usage

Using it with:

JSHint CLI

jshint --reporter node_modules/jshint-md-reporter/lib/reporter.js file.js

Gulp:

Coming soon...

Grunt:

grunt.initConfig({
	jshint: {
		options: {
			reporter: require('jshint-md-reporter'),
			reporterOutput: 'jshint-report.md'
		},
		target: ['file.js']
	}
});

grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.registerTask('default', ['jshint']);

Testing

To run the tests, you have to first make sure the dependencies are installed on your system by running:

$ npm install

Then run npm test from the command line:

$ npm test

Legal Stuff

jshint-md-reporter is Copyright 2015 Justin Chmura. All Rights Reserved.

Distributed under MIT License.