grunt-todofinder v0.1.0-e

grunt-todofinder

Grunt task for finding TODOs or FIXMEs in diff between current git working dir and a specified commit.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-todofinder --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-todofinder');

The "todofinder" task

Overview

In your project's Gruntfile, add a section named todofinder to the data object passed into grunt.initConfig().

grunt.initConfig({
  todofinder: {
    default_options: {
      options: {
        // Task-specific options go here.
      }
    }
  },
});

Options

options.commit

Type: String Default value: 'HEAD~1'

TODOs will be looked for in diff between your current working directory and the specified commit. Accepts any git path, so you can use a commit's SHA-1, branch, tag...

options.gitTopLevel

Type: String Default value: ''

Path from your Grunt working directory to git top level directory. Only necessary in cases when your Grunt working directory is different from your project's git top level directory

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  todofinder: {
    options: {
      commit: 'master',
      gitTopLevel: '../../'
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1: Feb 29 2016

Goals for 0.2

• Show a summary of found TODOs at the end of output (e.g. 'Found M TODOs in N files.').
• Use colours to make the output easier to read
• Add tests
• Include FIXMEs and NOTEs

Longer term goals

• Make the search term configurable (probably should be limited to TODO/FIXME/NOTE in order to keep focus on this plugin's main goal).
• use git rev-parse --show-toplevel command to avoid the need for gitTopLevelParameter.