106 lines
3.2 KiB
JavaScript
106 lines
3.2 KiB
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
// Dependencies
|
||
|
|
const gitUp = require("git-up");
|
||
|
|
|
||
|
|
/**
|
||
|
|
* gitUrlParse
|
||
|
|
* Parses a Git url.
|
||
|
|
*
|
||
|
|
* @name gitUrlParse
|
||
|
|
* @function
|
||
|
|
* @param {String} url The Git url to parse.
|
||
|
|
* @return {GitUrl} The `GitUrl` object 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.
|
||
|
|
* - `full_name` (String): The owner and name values in the `owner/name` format.
|
||
|
|
* - `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.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
function gitUrlParse(url) {
|
||
|
|
|
||
|
|
if (typeof url !== "string") {
|
||
|
|
throw new Error("The url must be a string.");
|
||
|
|
}
|
||
|
|
|
||
|
|
let urlInfo = gitUp(url)
|
||
|
|
, sourceParts = urlInfo.resource.split(".")
|
||
|
|
, splits = null
|
||
|
|
;
|
||
|
|
|
||
|
|
urlInfo.toString = function (type) {
|
||
|
|
return gitUrlParse.stringify(this, type);
|
||
|
|
};
|
||
|
|
|
||
|
|
urlInfo.source = sourceParts.length > 2
|
||
|
|
? sourceParts.slice(-2).join(".")
|
||
|
|
: urlInfo.source = urlInfo.resource
|
||
|
|
;
|
||
|
|
|
||
|
|
urlInfo.name = urlInfo.pathname.substring(1).replace(/\.git$/, "");
|
||
|
|
urlInfo.owner = urlInfo.user;
|
||
|
|
urlInfo.organization = urlInfo.owner;
|
||
|
|
|
||
|
|
switch (urlInfo.source) {
|
||
|
|
case "cloudforge.com":
|
||
|
|
urlInfo.owner = urlInfo.user;
|
||
|
|
urlInfo.organization = sourceParts[0];
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
splits = urlInfo.name.split("/");
|
||
|
|
if (splits.length === 2) {
|
||
|
|
urlInfo.owner = splits[0];
|
||
|
|
urlInfo.name = splits[1];
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
urlInfo.full_name = urlInfo.owner;
|
||
|
|
if (urlInfo.name) {
|
||
|
|
urlInfo.full_name && (urlInfo.full_name += "/");
|
||
|
|
urlInfo.full_name += urlInfo.name;
|
||
|
|
}
|
||
|
|
|
||
|
|
return urlInfo;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* stringify
|
||
|
|
* Stringifies a `GitUrl` object.
|
||
|
|
*
|
||
|
|
* @name stringify
|
||
|
|
* @function
|
||
|
|
* @param {GitUrl} obj The parsed Git url object.
|
||
|
|
* @param {String} type The type of the stringified url (default `obj.protocol`).
|
||
|
|
* @return {String} The stringified url.
|
||
|
|
*/
|
||
|
|
gitUrlParse.stringify = function (obj, type) {
|
||
|
|
type = type || obj.protocol;
|
||
|
|
switch (type) {
|
||
|
|
case "ssh":
|
||
|
|
return `git@${obj.resource}:${obj.full_name}.git`;
|
||
|
|
case "git+ssh":
|
||
|
|
return `git+ssh://git@${obj.resource}/${obj.full_name}.git`;
|
||
|
|
case "http":
|
||
|
|
case "https":
|
||
|
|
return `${type}://${obj.resource}/${obj.full_name}`;
|
||
|
|
default:
|
||
|
|
return obj.href;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
module.exports = gitUrlParse;
|