eslint-formatter-markdown

Markdown ESLint formatter (reporter)

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install eslint-formatter-markdown --save-dev

Getting started

Use it with:

ESLint CLI

eslint --format node_modules/eslint-formatter-markdown/markdown.js file.js

grunt-eslint

grunt.initConfig({
	eslint: {
		options: {
			format: require('eslint-formatter-markdown')
		},
		target: ['file.js']
	}
});

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

Example Output (rendered by github)

Tests

npm install
npm test

Tested with ESLint@2 under node 0.12 - 6.3.* .

After changing to ESLint@3 tests with node 0.12 are failing because of lambda functions.

Dependencies

lodash: Lodash modular utilities.

Dev Dependencies

chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
coveralls: takes json-cov output into stdin and POSTs to coveralls.io.
eslint: An AST-based pattern checker for JavaScript.
istanbul: Yet another JS code coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. Supports all JS coverage use cases including unit tests, server side functional tests.
mocha: simple, flexible, fun test framework
mocha-lcov-reporter: LCOV reporter for Mocha

Contributing

Feel free to contribute!

Release History

1.0.4 Updated Readme and DevDependencies
1.0.3 Updated Readme and DevDependencies
1.0.2 Updated Readme and DevDependencies
1.0.0 Release with Stats in Summary
0.11.0 Added Sorting
0.10.0 Added Tests
0.9.1 Improvements in Documentation, Issue #2
0.9.0 Initial release

sven-piller/eslint-formatter-markdown