Package Exports
- git-url-parse
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-url-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
git-url-parse 
A high level git url parser for common git providers.
Installation
$ npm i git-url-parseExample
// Dependencies
var GitUrlParse = require("git-url-parse");
console.log(GitUrlParse("git@github.com:IonicaBizau/node-git-url-parse.git"));
// => {
// protocols: []
// , port: null
// , resource: "github.com"
// , user: "git"
// , pathname: "/IonicaBizau/node-git-url-parse.git"
// , hash: ""
// , search: ""
// , href: "git@github.com:IonicaBizau/node-git-url-parse.git"
// , token: ""
// , protocol: "ssh"
// , toString: [Function]
// , source: "github.com"
// , name: "node-git-url-parse"
// , owner: "IonicaBizau"
// } {
console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git"));
// => {
// protocols: ["https"]
// , port: null
// , resource: "github.com"
// , user: ""
// , pathname: "/IonicaBizau/node-git-url-parse.git"
// , hash: ""
// , search: ""
// , href: "https://github.com/IonicaBizau/node-git-url-parse.git"
// , token: ""
// , protocol: "https"
// , toString: [Function]
// , source: "github.com"
// , name: "node-git-url-parse"
// , owner: "IonicaBizau"
// }
console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git").toString("ssh"));
// => "git@github.com:IonicaBizau/node-git-url-parse.git"
console.log(GitUrlParse("git@github.com:IonicaBizau/node-git-url-parse.git").toString("https"));
// => "https://github.com/IonicaBizau/node-git-url-parse.git"
Documentation
GitUrlParse(url)
Parses a Git url.
Params
- String
url: The Git url to parse.
Return
- GitUrl The
GitUrlobject containing: protocols(Array): An array with the url protocols (usually it has one element).port(null|Number): The domain port.resource(String): The url domain (including subdomains).user(String): The authentication user (usually for ssh urls).pathname(String): The url pathname.hash(String): The url hash.search(String): The url querystring value.href(String): The input url.protocol(String): The git url protocol.token(String): The oauth token (could appear in the https urls).source(String): The Git provider (e.g."github.com").owner(String): The repository owner.name(String): The repository name.toString(Function): A function to stringify the parsed url into another url type.organization(String): The organization the owner belongs to. This is CloudForge specific.
stringify(obj, type)
Stringifies a GitUrl object.
Params
- GitUrl
obj: The parsed Git url object. - String
type: The type of the stringified url (defaultobj.protocol).
Return
- String The stringified url.
How to contribute
Have an idea? Found a bug? See how to contribute.
License
KINDLY © Ionică Bizău–The LICENSE file contains a copy of the license.