IonicaBizau / Is Ssh
Programming Languages
is-ssh
Check if an input value is a ssh url or not.
โ๏ธ Installation
# Using npm
npm install --save is-ssh
# Using yarn
yarn add is-ssh
๐ Example
// Dependencies
const isSsh = require("is-ssh");
// Secure Shell Transport Protocol (SSH)
console.log(isSsh("ssh://[email protected]:port/path/to/repo.git/"));
// true
console.log(isSsh("ssh://[email protected]/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz:port/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true
console.log(isSsh("ssh://[email protected]/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true
console.log(isSsh("ssh://[email protected]/~user/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz/~user/path/to/repo.git/"));
// true
console.log(isSsh("ssh://[email protected]/~/path/to/repo.git"));
// true
console.log(isSsh("ssh://host.xz/~/path/to/repo.git"));
// true
console.log(isSsh("[email protected]:/path/to/repo.git/"));
// true
console.log(isSsh("[email protected]:~user/path/to/repo.git/"));
// true
console.log(isSsh("[email protected]:path/to/repo.git"));
// true
console.log(isSsh("host.xz:/path/to/repo.git/"));
// true
console.log(isSsh("host.xz:path/to/repo.git"));
// true
console.log(isSsh("host.xz:~user/path/to/repo.git/"));
// true
console.log(isSsh("rsync://host.xz/path/to/repo.git/"));
// true
// Git Transport Protocol
console.log(isSsh("git://host.xz/path/to/repo.git/"));
// false
console.log(isSsh("git://host.xz/~user/path/to/repo.git/"));
// false
// HTTP/S Transport Protocol
console.log(isSsh("http://host.xz/path/to/repo.git/"));
// false
console.log(isSsh("https://host.xz/path/to/repo.git/"));
// false
// Local (Filesystem) Transport Protocol
console.log(isSsh("/path/to/repo.git/"));
// false
console.log(isSsh("path/to/repo.git/"));
// false
console.log(isSsh("~/path/to/repo.git"));
// false
console.log(isSsh("file:///path/to/repo.git/"));
// false
console.log(isSsh("file://~/path/to/repo.git/"));
// false
โ 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
isSsh(input)
Checks if an input value is a ssh url or not.
Params
-
String|Array
input
: The input url or an array of protocols.
Return
-
Boolean
true
if the input is a ssh url,false
otherwise.
๐ 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
coffeetea. ๐ต -
โ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. โจ
-
bb-git-up
โA low level git url parser. -
bb-parse-url
โAn advanced url parser supporting git urls too. -
git-up
โA low level git url parser. -
miguelcostero-ng2-toasty
(by Sergey Akopkokhyants)โAngular2 Toasty component shows growl-style alerts and messages for your web app -
nodegit-clone
(by Andrew Abramov)โClone git repository with nodegit -
normalize-ssh
(by Zoltan Kochan)โNormalize a SSH URL -
parse-path
โParse paths (local paths, urls: ssh/git/etc) -
parse-url
โAn advanced url parser supporting git urls too.