repo-utils

repo-utils

Utils for normalizing and formatting repo data.

Install with npm

npm i repo-utils --save

Usage

var repo = require('repo-utils');

API

.git

Create a github .git url.

• path {String}: user/repo or org/repo
• returns {String}: Formatted github git url

repo.git('abc/xyz');
//=> 'https://github.com/abc/xyz.git'

var url = require('url');
var parts = url.parse('abc/xyz');
repo.git(parts);
//=> 'https://github.com/abc/xyz.git'

.github

Create a GitHub url.

• url {String}: user/repo or org/repo
• returns {String}: Formatted github url

repo.github('abc/xyz');
//=> 'https://github.com/abc/xyz'

repo.github('abc', 'xyz');
//=> 'https://github.com/abc/xyz'

repo.github('abc');
//=> 'https://github.com/abc'

repo.github('abc', {hostname: 'foo.org'});
//=> 'https://foo.org/abc'

.url

Base method used by other utils for creating a URL from a string or object.

• pathname {String|Object}: Pathname or options object. Pathname should be user/repo or org/repo
• options {Object}
• returns {String}: Formatted github url

repo.url('abc/xyz');
//=> 'https://github.com/abc/xyz'

repo.url({pathname: 'abc/xyz'});
//=> 'https://github.com/abc/xyz'

Run tests

Install dev dependencies:

node i -d && mocha

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb on January 10, 2015.