"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app/apm/node_modules/normalize-git-url/README.md" (17 Oct 2016, 1371 Bytes) of archive /windows/misc/atom-windows.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


You have a bunch of Git URLs. You want to convert them to a canonical representation, probably for use inside npm so that it doesn’t end up creating a bunch of superfluous cached origins. You use this package.


javascript var ngu = require('normalize-git-url'); var normalized = ngu("git+ssh://git@github.com:organization/repo.git#hashbrowns") // get back: // { // url : "ssh://git@github.com/organization/repo.git", // branch : "hashbrowns" // did u know hashbrowns are delicious? // }


There’s just the one function, and all it takes is a single parameter, a non-normalized Git URL.


Returns an object with the following format:


Right now this doesn’t try to special-case GitHub too much – it doesn’t ensure that .git is added to the end of URLs, it doesn’t prefer https: over http: or ssh:, it doesn’t deal with redirects, and it doesn’t try to resolve symbolic names to treeish hashcodes. For now, it just tries to account for minor differences in representation.