grunt-todo/Gruntfile.js

Find TODO, FIXME and NOTE inside project files

/*
 * grunt-todo
 * https://github.com/Leny/grunt-todo
 *
 * Copyright (c) 2013 Leny
 * Licensed under the MIT license.
 */

'use strict';

module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    coffee: {
      options: {
        bare: true
      },
      task: {
        files: {
          "tasks/todo.js": "src/todo.coffee"
        }
      }
    },

    jshint: {
      all: [
        'Gruntfile.js',
        'tasks/*.js',
      ],
      options: {
        jshintrc: '.jshintrc',
      }
    },

    // Configuration to be run.
    todo: {
      default_options: {
        options: {},
        src: [
          'test/*'
        ]
      },
      custom_options: {
        options: {
          marks: [
            {
              pattern: "BURP",
              color: "pink"
            },
            {
              name: "TODO",
              pattern: /TODO/,
              color: "yellow"
            }
          ],
          file: "report.md",
          githubBoxes: true,
          colophon: true,
          usePackage: true
        },
        src: [
          'test/*'
        ],
      },
      custom_options_no_logging: {
        options: {
          marks: [
            {
              pattern: "BURP",
              color: "pink"
            },
            {
              name: "TODO",
              pattern: /TODO/,
              color: "yellow"
            }
          ],
          file: "report-2.md",
          githubBoxes: true,
          colophon: true,
          usePackage: true,
          logOutput: false
        },
        src: [
          'test/*'
        ],
      },
    },

  });

  // Actually load this plugin's task(s).
  grunt.loadTasks('tasks');

  // These plugins provide necessary tasks.
  grunt.loadNpmTasks('grunt-contrib-coffee');
  grunt.loadNpmTasks('grunt-contrib-jshint');

  // By default, lint and run todo.
  grunt.registerTask('default', ['coffee', 'jshint', 'todo']);

};