grunt-jira-todo 0.3.0

Check your JavaScript source files for comments containing TODOs that reference Jira issues. Causes warnings if the status of a referenced issue is "Open" (or any other number of configurable statuses).

Example Output

Getting Started

This plugin requires Grunt ~0.4.0

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-jira-todo --save-dev

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

grunt.loadNpmTasks('grunt-jira-todo');

The "jira-todo" task

Overview

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

grunt.initConfig({
  'jira-todo': {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.projects

Type: Array
Default value: []

An array of strings specifying the keys of Jira projects you want to check against. For example, if your application is referencing the issues MA-123 and PT-99, set this to ['MA', 'PT']. Any other issue keys (e.g. ABC-42) will be ignored.

options.allowedStatuses

Type: Array
Default value: [1]

An array of ids that specifies which statuses are allowed for issues that are referenced from a todo. The default 1 corresponds to the standard Jira issue status Open.

options.allowedIssueTypes

Type: Array
Default value: [1, 3, 4, 5]

An array of ids that specifies which issue types are allowed to be referenced from a todo. The default corresponds to the standard Jira issue types Bug, Task, Improvement and Sub-task.

options.issueRequired

Type: boolean Default value: false

If enabled, all comments that match opts.todoRegex must contain at least one issue key matching the specified project(s).

options.issueRegex

Type: String
Default value: '(?<key>(?<project>[A-Z][_A-Z0-9]*)-(?<number>\\d+))'

The regular expression used to identify issue keys. By default this plugin matches strings that starts with a letter, followed by any number of alphanumeric characters, a dash and at least one digit (ignoring case). You can tweak this expression as needed, as long as you keep the named groups key, project and number. The flags g (global) and i (ignore case) are added automatically. Please refer to the XRegExp documentation for further details.

options.todoRegex

Type: String
Default value: '(?:\\*|\\s)(todo|fixme)(?:!|:|\\s)(?<text>.+)'

The regular expression used to find lines that potentially contain issue keys to check. By default this plugin matches anything that is preceded by either "todo" or "fixme" (ignoring case) followed by a colon, whitespace or exclamation mark. You can tweak this expression as needed, as long as you keep the named group text. The flags g (global) and i (ignore case) are added automatically. Please refer to the XRegExp documentation for further details.

options.jiraUrl

Type: String
Default value: none

The URL of the Jira server, e.g. 'https://jira.example.com'. The path for the REST endpoint (i.e. '/rest/api/2') will be added automatically.

options.jiraUsername

Type: String
Default value: none

The username used for HTTP basic access authentication.

options.jiraPassword

Type: String
Default value: none

The password used for HTTP basic access authentication.

Usage Examples

'jira-todo': {
    source: {
        options: {
            projects: ['PM'],
            allowedStatuses: [1, 3, 10023, 10024],
            jiraUrl: 'https://jira.example.com',
            jiraUsername: 'myusername',
            jiraPassword: 'mypassword' // (see Security Notes below!)
        },
        src: ['src/**/*.js']
    }
}

Security Notes

It is strongly recommended not to put your Jira credentials in the Gruntfile. Instead, create a separate JSON file, add it to your .gitignore and read the username and password from there:

grunt.initConfig({
    jiraConfig: grunt.file.readJSON('jira-config.json'),
    // ...
    'jira-todo': {
        source: {
            options: {
                projects: ['ABC', 'DEF'],
                allowedStatuses: [1, 3],
                jiraUrl: 'https://jira.example.com',  // you may even want to hide that as well
                jiraUsername: '<%= jiraConfig.username %>',
                jiraPassword: '<%= jiraConfig.password %>'
            },
            src: ['src/**/*.js']
        }
    }
});

Also, make sure you use a secure connection (i.e. https) to protect your username and password.

Contributing

In lieu of a formal style guide, 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

• 2015-03-20   v0.3.1   Maintenance release.
• 2015-02-09 v0.3.0 Added allowedIssueTypes option.
• 2015-02-05   v0.2.1   Maintenance release.
• 2014-12-22   v0.2.0   Added issueRequired option and JSX support.
• 2014-11-28   v0.1.4   Maintenance release.
• 2014-10-02   v0.1.3   Improved regex and bumped dependency versions.
• 2014-04-24   v0.1.2   Improved error handling for configuration and source code documentation.
• 2014-04-22   v0.1.1   Fixed minor issues with the README and Grunt tasks, changelog added.
• 2014-04-19   v0.1.0   Initial release.