forked from daren.hsu/line_push
148 lines
5.7 KiB
Markdown
148 lines
5.7 KiB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
|
|
|
|
|
|
# git-up
|
|
|
|
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/git-up) [](https://www.npmjs.com/package/git-up) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
|
|
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
|
|
|
> A low level git url parser.
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save git-up
|
|
|
|
# Using yarn
|
|
yarn add git-up
|
|
```
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
// 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"
|
|
// }
|
|
```
|
|
|
|
|
|
|
|
## :question: Get Help
|
|
|
|
There are few ways to get help:
|
|
|
|
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
|
2. For bug reports and feature requests, open issues. :bug:
|
|
|
|
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
|
|
|
|
|
|
|
|
## :memo: 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).
|
|
|
|
|
|
|
|
## :yum: How to contribute
|
|
Have an idea? Found a bug? See [how to contribute][contributing].
|
|
|
|
|
|
## :sparkling_heart: 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 :rocket:
|
|
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
|
|
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
- [![Support me on Patreon][badge_patreon]][patreon]—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! :heart:
|
|
|
|
|
|
## :dizzy: Where is this library used?
|
|
If you are using this library in one of your projects, add it in this list. :sparkles:
|
|
|
|
|
|
- [`codelofts-git-url-parse`](https://github.com/IonicaBizau/git-url-parse)—A high level git url parser for common git providers.
|
|
- [`front-end-styleguide-cli`](https://front-end-style.guide) (by Fynn Becker)—Provides access to the global CLI interface for the Front End Styleguide
|
|
- [`git-url-parse`](https://github.com/IonicaBizau/git-url-parse)—A high level git url parser for common git providers.
|
|
- [`miguelcostero-ng2-toasty`](https://github.com/akserg/ng2-toasty) (by Sergey Akopkokhyants)—Angular2 Toasty component shows growl-style alerts and messages for your web app
|
|
- [`ship-release`](https://github.com/IonicaBizau/ship-release#readme)—Publish new versions on GitHub and npm with ease.
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
|
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
|
|
|
|
[patreon]: https://www.patreon.com/ionicabizau
|
|
[amazon]: http://amzn.eu/hRo9sIZ
|
|
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|
|
|
|
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
|
|
[website]: https://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|