coffeelint-reporter

A Reporter for Coffeelint

Usage no npm install needed!

<script type="module">
  import coffeelintReporter from 'https://cdn.skypack.dev/coffeelint-reporter';
</script>

README

coffeelint-reporter

NPM Version License Tests

A Reporter for Coffeelint

Sample

Install

npm install coffeelint-reporter --save-dev

Usage with cli

coffeelint index.coffee --reporter coffeelint-reporter

Refer coffelint usage with cli here

Usage with Runtime API

const reporter = require('coffeelint-reporter/reporter');

const options = {
  log: false
};

const log = reporter(fileName, lintResults, options);
console.log(log); // formatted log {string}
  • fileName {string} - Headlint for the report
  • lintResults {Array<object>} - Results provided by coffeelint.lint, refer coffeelint api
  • options {object} - Options for reporter
    • log {boolean} - enable or disable logging to console