3 This will let you identify and transform various git hosts URLs between
4 protocols. It also can tell you what the URL is for the raw path for
5 particular file for direct access without git.
10 var hostedGitInfo = require("hosted-git-info")
11 var info = hostedGitInfo.fromUrl("git@github.com:npm/hosted-git-info.git")
17 project: "hosted-git-info"
22 If the URL can't be matched with a git host, `null` will be returned. We
23 can match git, ssh and https urls. Additionally, we can match ssh connect
24 strings (`git@github.com:npm/hosted-git-info`) and shortcuts (eg,
25 `github:npm/hosted-git-info`). Github specifically, is detected in the case
26 of a third, unprefixed, form: `npm/hosted-git-info`.
28 If it does match, the returned object has properties of:
30 * info.type -- The short name of the service
31 * info.domain -- The domain for git protocol use
32 * info.user -- The name of the user/org on the git host
33 * info.project -- The name of the project on the git host
39 Given the path of a file relative to the repository, returns a URL for
40 directly fetching it from the githost. If no committish was set then
41 `master` will be used as the default.
43 For example `hostedGitInfo.fromUrl("git@github.com:npm/hosted-git-info.git#v1.0.0").file("package.json")`
44 would return `https://raw.githubusercontent.com/npm/hosted-git-info/v1.0.0/package.json`
48 eg, `github:npm/hosted-git-info`
52 eg, `https://github.com/npm/hosted-git-info/tree/v1.2.0`
56 eg, `https://github.com/npm/hosted-git-info/issues`
60 eg, `https://github.com/npm/hosted-git-info/tree/v1.2.0#readme`
64 eg, `git+https://github.com/npm/hosted-git-info.git`
68 eg, `git+ssh://git@github.com/npm/hosted-git-info.git`
72 eg, `git@github.com:npm/hosted-git-info.git`
76 eg, `npm/hosted-git-info`
78 * info.getDefaultRepresentation()
80 Returns the default output type. The default output type is based on the
81 string you passed in to be parsed
85 Uses the getDefaultRepresentation to call one of the other methods to get a URL for
86 this resource. As such `hostedGitInfo.fromUrl(url).toString()` will give
87 you a normalized version of the URL that still uses the same protocol.
89 Shortcuts will still be returned as shortcuts, but the special case github
90 form of `org/project` will be normalized to `github:org/project`.
92 SSH connect strings will be normalized into `git+ssh` URLs.
97 Currently this supports Github, Bitbucket and Gitlab. Pull requests for
98 additional hosts welcome.