node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »



Turn stuff like isaacs/npm#1234 into, for your hyperlinking pleasure.


ghlink(input, [options])

The options can have a format field (default = 'text') and a project field (default = null).

var ghlink = require('ghlink');
var someString = 'hello world user/project#12 fixed by isaacs/node@deadbeef';
var textOutput = ghlink(someString);
// hello world fixed by 
var htmlOutput = ghlink(someString, { format: 'html' });
// hello world <a href="">user/project#12</a> fixed by 
// <a href="">isaacs/node@deadbeef</a> 
var links = ghlink(someString, { format: 'links' });
// [user/project#12]: 
// [isaacs/node@deadbeef]: 
var md = ghlink(someString, { format: 'markdown' });
// hello world [user/project#12]( fixed by 
// [isaacs/node@deadbeef]( 
var lexed = ghlink(someString, { format: 'lex' });
// lexed is now an array with some strings and some objects huzzah. 
var linkobj = ghlink(someString, { format: 'linkobj' })
// like lexed, but just the link objects, no strings 

The project field in the options object should be something like user/project, and then stuff like GH-1234 or #223 are assumed to be for that project.

Note that this module does not look up anything at any github API to verify that the references actually exist, or to provide titles or anything else. It's strictly a string munging utility.