leasot/bin/leasot-reporter.js

#!/usr/bin/env node

const program = require('commander');
const cli = require('../lib/cli-reporter');
const pkg = require('../package.json');

function list(val) {
    return val.split(',');
}

/* eslint-disable no-console */
program
    .description('Report todos and fixmes from json files or stream')
    .version(pkg.version)
    .usage('[options] <file ...>')
    .option('-i, --ignore <patterns>', 'add ignore patterns', list, [])
    .option('-r, --reporter [reporter]', 'use reporter (table|json|xml|markdown|vscode|raw) (default: table)', 'table')
    .option('-x, --exit-nicely', 'exit with exit code 0 even if todos/fixmes are found', false)
    .on('--help', function() {
        console.log('  Examples:');
        console.log('');
        console.log('    # Report todos from a specific file');
        console.log('    $ leasot-reporter index.json');
        console.log('');
        console.log('    # Report todos from a glob pattern');
        console.log('    $ leasot-reporter **/*.json');
        console.log('');
        console.log('    # Use the json reporter');
        console.log('    $ leasot-reporter --reporter json index.json');
        console.log('');
        console.log('    # Report from a json stream');
        console.log('    $ cat index.json | leasot-reporter --reporter xml');
        console.log('');
        console.log('    # Report from leasot parsing and filter todos using `jq`');
        console.log(
            '    $ leasot tests/**/*.styl --reporter json | jq \'map(select(.kind == "TODO"))\' | leasot-reporter'
        );
        console.log('');
    })
    .parse(process.argv);

cli(program);