ssh-url - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

README.md

		# ssh-url [![NPM version](https://badge.fury.io/js/ssh-url.svg)](http://badge.fury.io/js/ssh-url) [![Build Status](https://travis-ci.org/kaelzhang/node-ssh-url.svg?branch=master)](https://travis-ci.org/kaelzhang/node-ssh-url) [![Dependency Status](https://gemnasium.com/kaelzhang/node-ssh-url.svg)](https://gemnasium.com/kaelzhang/node-ssh-url)

		Utilities to resolute and parse ssh url including scp-like syntax SSH protocol.

		## Installation

		```bash
		$ npm install ssh-url --save
		```

		## Usage

		```js
		var url = require('ssh-url');

		var parsed = url.parse('git@github.com:kaelzhang/node-ssh-url.git');
		// -> {
		// protocol: null,
		// user: 'git',
		// hostname: 'github.com',
		// pathname: 'kaelzhang/node-ssh-url.git'
		// }

		url.format(parsed);
		// -> git@github.com:kaelzhang/node-ssh-url.git
		```

		### url.parse(urlStr)

		Takes a SSH URL string, and returns an object.

		#### urlObj

		For now, `urlObj` only contains four properties.

		- protocol `null\|String` if null, indicates that `urlStr` uses scp-like syntax.
		- user `String`
		- hostname `String` for now, there's no port.
		- pathname `String` starts with `'/'`

		### url.format(urlObj)

		Takes a parsed SSH URL object, and returns a formatted URL string.

test/ssh-url.js

		'use strict';

		var expect = require('chai').expect;
		var ssh_url = require('../');
		var url = require('../');

		var cases = [
		{
		d: 'scp-like syntax',
		u: 'git@github.com:kaelzhang/node-ssh-url.git',
		e: {
		protocol: null,
		user: 'git',
		hostname: 'github.com',
		pathname: '/kaelzhang/node-ssh-url.git'
		}
		},
		{
		d: 'ssh protocol',
		u: 'ssh://git@github.com/kaelzhang/node-ssh-url.git',
		e: {
		protocol: 'ssh:',
		user: 'git',
		hostname: 'github.com',
		pathname: '/kaelzhang/node-ssh-url.git'
		}
		}
		];


		describe("url.parse(str), url.format(obj)", function(){
		cases.forEach(function (c) {
		it(c.d, function(){
		var parsed = url.parse(c.u);
		expect(parsed).to.deep.equal(c.e);
		var formated = url.format(parsed);
		expect(formated).to.equal(c.u);
		});
		});
		});

index.js→index.js

New alerts