https://github.com/sgtlambda/gitresolve
Resolve shorthand repository names (github, bitbucket, gitlab) into their full URLs
https://github.com/sgtlambda/gitresolve
Last synced: about 1 year ago
JSON representation
Resolve shorthand repository names (github, bitbucket, gitlab) into their full URLs
- Host: GitHub
- URL: https://github.com/sgtlambda/gitresolve
- Owner: sgtlambda
- License: mit
- Created: 2015-10-30T13:26:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-12T05:45:44.000Z (about 10 years ago)
- Last Synced: 2025-04-02T03:01:44.051Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# gitresolve
> Resolve shorthand repository names (github, bitbucket) into their full URLs
[![Build Status][travis-image]][travis-url]
[![NPM Version][npm-image]][npm-url]
## Install
```
$ npm install --save gitresolve
```
## Usage
```js
var gitresolve = require('gitresolve');
gitresolve('jmversteeg/gitresolve').then(console.log);
//=> [ { service: 'GitHub',
// url: 'https://github.com/jmversteeg/gitresolve.git',
// name: 'gitresolve' } ]
```
## API
### gitresolve(shorthand, [servicesMask])
#### shorthand
Type: `string`
Shorthand repository name.
Example: `jmversteeg/gitresolve`
#### servicesMask
Type: `string[]`
Array of resolvers to use (by function name). If not provided, all resolvers will be tried. See [lib/services](https://github.com/jmversteeg/gitresolve/tree/master/lib/services) for the available services.
Example: `['github', 'bitbucket']`
## License
MIT © [JM Versteeg](https://github.com/jmversteeg)
[![dependency Status][david-image]][david-url]
[![devDependency Status][david-dev-image]][david-dev-url]
[travis-image]: https://img.shields.io/travis/jmversteeg/gitresolve.svg?style=flat-square
[travis-url]: https://travis-ci.org/jmversteeg/gitresolve
[codeclimate-image]: https://img.shields.io/codeclimate/github/jmversteeg/gitresolve.svg?style=flat-square
[codeclimate-url]: https://codeclimate.com/github/jmversteeg/gitresolve
[david-image]: https://img.shields.io/david/jmversteeg/gitresolve.svg?style=flat-square
[david-url]: https://david-dm.org/jmversteeg/gitresolve
[david-dev-image]: https://img.shields.io/david/dev/jmversteeg/gitresolve.svg?style=flat-square
[david-dev-url]: https://david-dm.org/jmversteeg/gitresolve#info=devDependencies
[coveralls-image]: https://img.shields.io/coveralls/jmversteeg/gitresolve.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/jmversteeg/gitresolve
[npm-image]: https://img.shields.io/npm/v/gitresolve.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/gitresolve