git-up

A low level git url parser.

☁️ Installation

# Using npm
npm install --save git-up

# Using yarn
yarn add git-up

📋 Example

// Dependencies
var gitUp = require("git-up");

console.log(gitUp("git@github.com:IonicaBizau/node-parse-url.git"));
// => {
//     protocols: []
//   , port: null
//   , resource: "github.com"
//   , user: "git"
//   , pathname: "/IonicaBizau/node-parse-url.git"
//   , hash: ""
//   , search: ""
//   , href: "git@github.com:IonicaBizau/node-parse-url.git"
//   , protocol: "ssh"
// }

console.log(gitUp("https://github.com/IonicaBizau/node-parse-url.git"));
// => {
//     protocols: [ "https" ]
//   , port: null
//   , resource: "github.com"
//   , user: ""
//   , pathname: "/IonicaBizau/node-parse-url.git"
//   , hash: ""
//   , search: ""
//   , href: "https://github.com/IonicaBizau/node-parse-url.git"
//   , protocol: "https"
// }

❓ Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. 🐛
For direct and quick help, you can use Codementor. 🚀

📝 Documentation

`gitUp(input)`

Parses the input url.

Params

String input: The input url.

Return

Object An object containing the following fields:
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).

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like 🚀
—I love books! I will remember you after years if you buy me one. 😁 📖
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. 🍵
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

git-url-parse
gatsby-telemetry
@jamo/gatsby-telemetry
@enkeledi/react-native-week-month-date-picker
erxes-telemetry
@hemith/react-native-tnk
miguelcostero-ng2-toasty
native-kakao-login
react-native-my-first-try-arun-ramya
react-native-kakao-maps
react-native-is7
react-native-ytximkit
react-native-payu-payment-testing
npm_one_1_2_3
react-native-biometric-authenticate
react-native-arunmeena1987
react-native-contact-list
rn-adyen-dropin
@positionex/position-sdk
@corelmax/react-native-my2c2p-sdk
@felipesimmi/react-native-datalogic-module
@hawkingnetwork/react-native-tab-view
drowl-base-theme-iconset
native-apple-login
react-native-cplus
npm_qwerty
react-native-arunjeyam1987
react-native-bubble-chart
react-native-flyy
@react-18-pdf/root
@apardellass/react-native-audio-stream
@geeky-apo/react-native-advanced-clipboard
candlelabssdk
@saad27/react-native-bottom-tab-tour
codelofts-git-url-parse
gb-notifications
react-native-dsphoto-module
react-native-responsive-size
react-native-sayhello-module
npm_one_12_34_1_
npm_one_2_2
payutesting
@con-test/react-native-concent-common
react-native-shekhar-bridge-test
react-feedback-sdk
@oiti/documentoscopy-react-native
birken-react-native-community-image-editor
git-web
luojia-cli-dev
reac-native-arun-ramya-test
react-native-plugpag-wrapper
react-native-pulsator-native
react-native-arun-ramya-test
react-native-arunramya151
react-native-transtracker-library
ship-release
@jfilipe-sparta/react-native-module_2
cogoportutils
@buganto/client
angularvezba
astra-ufo-sdk
react-native-syan-photo-picker
@wecraftapps/react-native-use-keyboard
l2forlerna
native-google-login
react-native-modal-progress-bar
react-native-test-module-hhh
raact-native-arunramya151
react-native-jsi-device-info
react-native-badge-control
front-end-styleguide-cli
front-end-styleguide-init
hubgit
rn-tm-notify
native-date-picker-module

IonicaBizau/git-up