openg

openg

open Github repo pages for npm modules in your browser

Install

npm install --save openg

Usage

const openg = require('openg');

openg('hackathons');
//=> returns a promise that opens the github page for the current directory in-browser

openg('express');
//=> returns a promise that opens the github page for express in-browser

openg(['inf', 'sist', 'openg'], {
  issues: true
});
//=>  returns a promise that opens the github issues pages for all in-browser

API

openg(target, [opts])

target

Type: string | array

npm modules name(s) you want to open in your browser

opts

Type: optional object

Pass these in to modify the behavior of openg

issues: true

Open the GitHub issues page for specified repo(s)

dryRun: true

Return the url's that would be opened and do not open them in-browser

Example usage:

openg('openg', {
  issues: true,
  dryRun: true
}).then(resp => {
  console.log(resp);
});

//=> ['https://github.com/dawsonbotsford/openg/issues']

returns

Type: promise

Array of expected url value(s)

License

MIT © Dawson Botsford