Skip to content

Latest commit

 

History

History
executable file
·
52 lines (32 loc) · 1.45 KB

README.md

File metadata and controls

executable file
·
52 lines (32 loc) · 1.45 KB

resolver

NPM version Build Status Dependency Status Coverage Status

Little module that helps with link resolving.

Install

$ npm install --save octo-linker-resolver

API

Resolve a url into a GitHub url

var resolver = require('octo-linker-resolver');

resolver('user/repo'); 
// https://github.com/user/repo

resolver('user/repo#master'); 
// https://github.com/user/repo/tree/master

resolver('../../index.js', 'https://github.com/user/repo/blob/master/lib/utils/math.js'); 
// https://github.com/user/repo/blob/master/index.js

resolver('user/repo@master'); 
// https://github.com/user/tree/master

resolver('user/repo@master:/folder/file.js');
// https://github.com/user/repo/blob/master/folder/file.js

License

Copyright (c) 2015 Stefan Buck. Licensed under the MIT license.