Jira-linkify NPM

This module formats any markdown files with references to Apache Jira issues to be hyperlinks to the issue itself.

Supports

individual markdown files relative to current working directory
folders (will format all markdown files within)
streams (v2)
any Apache JIRA prefix; default is "CB"
bracketed, nonbracketed, and colon'ed Apache JIRA issues
- i.e "CB-1234" and "CB-1234" and "CB-1234:"

Usage

Using Node Streams (v2)

var linkifier = require("jira-linkify");
var stream = require('stream');
var transformer = linkifier.stream("CB");
var read = new stream.Readable();
read._read = function(){};// noop
read.push('CB-123 this is issue number 123');
read.push(null);
var write = new Stream.Writable();
var data = '';
write._write = function(chunk, encoding, done) {
    data += chunk.toString();
    done();
}
write.on('finish', function() {
    console.log(data);
});
readable.pipe(transformer).pipe(writable);
// prints out "[CB-123](https://issues.apache.org/jira/browser/CB-123) this is issue number 123"

Markdown File

var linkifier = require("jira-linkify");
linkifier.file("test.md");
linkifier.file("test.md", "AA"); //default callback does nothing
linkifier.file("test.md", "AA", function(err, filePath) {
	if (err) {
		//err is boolean
		throw Error("failed");
	} else {
		console.log(filePath);
	}
});
linkifier.file("test.md", function(err, filePath) {}); //default prefix is "CB"

Folder of Markdown Files (Beta Usage - not extensively tested yet)

var linkifier = require("jira-linkify");
linkifier.folder("test"); //default JIRA code prefix is "CB"
linkifier.folder("test", "AA"); //default callback does nothing
linkifier.folder("test", "AA", function(err, filePaths) {
	if (err) {
		//err is boolean
		throw Error("failed");
	} else {
		console.log(filePaths);
	}
});
linkifier.folder("test", function(err, filePaths) {}); //default prefix is "CB"