https://github.com/octolinker/resolver
https://github.com/octolinker/resolver
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/octolinker/resolver
- Owner: OctoLinker
- Created: 2014-09-22T22:26:36.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-12-09T20:14:09.000Z (over 10 years ago)
- Last Synced: 2025-04-12T01:09:40.644Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 15
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# resolver
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image] [![Coverage Status][coveralls-image]][coveralls-url]
Little module that helps with link resolving.
## Install
```bash
$ npm install --save octo-linker-resolver
```
## API
Resolve a url into a GitHub url
```javascript
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.
[npm-url]: https://npmjs.org/package/octo-linker-resolver
[npm-image]: https://badge.fury.io/js/octo-linker-resolver.svg
[travis-url]: https://travis-ci.org/octo-linker/resolver
[travis-image]: https://travis-ci.org/octo-linker/resolver.svg?branch=master
[daviddm-url]: https://david-dm.org/octo-linker/resolver.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/octo-linker/resolver
[coveralls-url]: https://coveralls.io/r/octo-linker/resolver
[coveralls-image]: https://coveralls.io/repos/octo-linker/resolver/badge.png