github-linker-resolver

Little module that helps with link resolving.

Usage no npm install needed!

<script type="module">
  import githubLinkerResolver from 'https://cdn.skypack.dev/github-linker-resolver';
</script>

README

github-linker-resolver

NPM version Build Status Dependency Status Coverage Status

Little module that helps with link resolving.

Install

$ npm install --save github-linker-resolver

API

Resolve a url into GitHub endpoint

var resolver = require('github-linker-resolverr');

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) 2014 Stefan Buck. Licensed under the MIT license.