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.

Installation

$ npm i --save is-ssh

Example

// Dependencies
var 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

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.

Where is this library used?

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

• git-up

License

MIT © Ionică Bizău