is-ssh

What is is-ssh?

The is-ssh npm package is designed to check if a given string is a valid SSH URL. It can be used to validate SSH URLs in various applications, ensuring that the URLs conform to the expected format for SSH connections. This can be particularly useful in applications that deal with remote server management, deployment scripts, or any scenario where SSH URLs are handled programmatically.

What are is-ssh's main functionalities?

Validate SSH URL

This feature allows you to check if a given string is a valid SSH URL. The function returns true if the string is a valid SSH URL, otherwise, it returns false. This is useful for validating user input, configuration settings, or any data that is expected to be in the form of an SSH URL.

"const isSSH = require('is-ssh');

console.log(isSSH('[e-mail]:user/repo.git')); // true
console.log(isSSH('https://github.com/user/repo.git')); // false"

Other packages similar to is-ssh

validator

The 'validator' package is a comprehensive library for string validation and sanitization. While it offers a wide range of validation functions, including URL validation, it does not have a specific function dedicated to SSH URL validation. Compared to is-ssh, validator is more general-purpose and does not provide the same focused functionality for SSH URLs.

is-url

The 'is-url' package is designed to validate URLs to check if they are correctly formatted. Similar to 'validator', it provides a broader URL validation functionality but does not specifically target SSH URLs. Compared to is-ssh, 'is-url' offers a more general URL validation without the specificity for SSH URL formats.

README

is-ssh

Check if an input value is a ssh url or not.

:cloud: Installation

# Using npm
npm install --save is-ssh

# Using yarn
yarn add is-ssh

:clipboard: Example

// Dependencies
const isSsh = require("is-ssh");

// Secure Shell Transport Protocol (SSH)
console.log(isSsh("ssh://[e-mail]:port/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[e-mail]/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://[e-mail]/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[e-mail]/~user/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz/~user/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[e-mail]/~/path/to/repo.git"));
// true

console.log(isSsh("ssh://host.xz/~/path/to/repo.git"));
// true


console.log(isSsh("[e-mail]:/path/to/repo.git/"));
// true

console.log(isSsh("[e-mail]:~user/path/to/repo.git/"));
// true

console.log(isSsh("[e-mail]: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

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. 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. :rocket:

:memo: 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.

:yum: How to contribute

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

: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:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :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! :heart:

:dizzy: Where is this library used?

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

• 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.

:scroll: License

MIT © Ionică Bizău