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).
This package is intended to be used with gulp.
Install it with:
npm install gulp-jira-todo --save-devYou also need an external TODO parser like gulp-todo:
npm install gulp-todo --save-devYou can integrate it in your gulp setup like this:
var gulp = require('gulp'),
todo = require('gulp-todo'),
jiraTodo = require('gulp-jira-todo');
gulp.task('todo', function () {
return gulp.src('mySources/**/*.js')
.pipe(todo())
.pipe(jiraTodo({
issueRequired: true,
projects: ['ABC'],
allowedStatuses: [1, 3],
allowedIssueTypes: [1, 3, 4, 5],
jiraUrl: 'https://jira.example.com',
jiraUsername: 'myJiraAccount',
jiraPassword: 'secretJiraPassword' // (see Security Notes below!)
}));
});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.
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.
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.
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).
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.
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.
Type: String
Default value: none
The username used for HTTP basic access authentication.
Type: String
Default value: none
The password used for HTTP basic access authentication.
It is strongly recommended not to put your Jira credentials in your repository. Instead, create a separate JSON file, add it to your .gitignore and read the username and password from there.
For help, please read this: https://help.github.com/articles/remove-sensitive-data/
Also, make sure you use a secure connection (i.e. https) to protect your username and password.
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.
- 2015-05-25 v1.0.1 Fix callback parameters.
- 2015-05-25 v1.0.0 Fork to switch support to gulp. Require external TODO parser.
- 2015-03-20 v0.3.1 Maintenance release.
- 2015-02-09 v0.3.0 Added
allowedIssueTypesoption. - 2015-02-05 v0.2.1 Maintenance release.
- 2014-12-22 v0.2.0 Added
issueRequiredoption 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.