Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kgryte/npm-repo-url

Get repository URLs for one or more packages.
https://github.com/kgryte/npm-repo-url

Last synced: 25 days ago
JSON representation

Get repository URLs for one or more packages.

Host: GitHub
URL: https://github.com/kgryte/npm-repo-url
Owner: kgryte
License: mit
Created: 2016-01-02T06:32:50.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-01-03T22:01:26.000Z (almost 9 years ago)
Last Synced: 2024-09-19T02:54:28.076Z (about 2 months ago)
Language: JavaScript
Homepage:
Size: 94.7 KB
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        Repository URLs

===

[![NPM version][npm-image]][npm-url] [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] [![Dependencies][dependencies-image]][dependencies-url]

> Get repository URLs for one or more packages.

## Installation

``` bash

$ npm install npm-repo-url

```

## Usage

``` javascript

var urls = require( 'npm-repo-url' );

```



#### urls( opts, clbk )

Get repository URLs for one or more packages.

``` javascript

var opts = {

	'packages': [

		'dstructs-matrix',

		'compute-erf',

		'log',

		'utils-copy',

		'unknown_package_name'

	]	

};

urls( opts, clbk );

function clbk( error, data ) {

	if ( error ) {

		throw error;

	}

	console.dir( data );

	/*

		{

			"meta": {

				"total": 5,

				"success": 4,

				"failure": 1

			},

			"data": {

				"dstructs-matrix": "https://github.com/dstructs/matrix.git",

				"compute-erf": "https://github.com/compute-io/erf.git",

				"log": null,

				"utils-copy": "https://github.com/kgryte/utils-copy.git"

			},

			"failures": {

				"unknown_package_name": "Not Found"

			}

	*/

}

```

The `function` accepts the following `options`:

*	__packages__: `array` of package names (*required*).

*	__registry__: registry. Default: `'registry.npmjs.org'`.

*	__port__: registry port. Default: `443` (HTTPS) or `80` (HTTP).

* 	__protocol__: registry protocol. Default: `'https'`.

To query an alternative registry, set the relevant options.

``` javascript

var opts = {

	'packages': [

		'dstructs-array',

		'flow-map',

		'utils-merge2'

	],

	'registry': 'my.favorite.npm/registry',

	'port': 80,

	'protocol': 'http'

};

urls( opts, clbk );

```

#### urls.factory( opts, clbk )

Creates a reusable `function`.

``` javascript

var pkgs = [

	'dstructs-matrix',

	'compute-stdev',

	'compute-variance'

];

var get = urls.factory( {'packages': pkgs}, clbk );

get();

get();

get();

// ...

```

The factory method accepts the same `options` as [`urls()`](#urls).

## Notes

*	If the module encounters an application-level `error` (e.g., no network connection, non-existent registry, etc), that `error` is returned immediately to the provided `callback`.

*	If the module encounters a downstream `error` (e.g., timeout, reset connection, etc), that `error` is included in the returned results under the `failures` field.

*	Successfully resolved packages without an associated repository URL have a `url` value equal to `null`.

## Examples

``` javascript

var ls = require( 'npm-list-author-packages' );

var urls = require( 'npm-repo-url' );

var opts = {

	'username': 'kgryte'

};

ls( opts, onList );

function onList( error, list ) {

	var opts;

	if ( error ) {

		throw error;

	}

	if ( !list.length ) {

		return;

	}

	opts = {

		'packages': list

	};

	urls( opts, onUrls );

}

function onUrls( error, data ) {

	if ( error ) {

		throw error;

	}

	console.dir( data );

}

```

To run the example code from the top-level application directory,

``` bash

$ DEBUG=* node ./examples/index.js

```

---

## CLI

### Installation

To use the module as a general utility, install the module globally

``` bash

$ npm install -g npm-repo-url

```

### Usage

``` bash

Usage: pkgrepo [options] pkg1 pkg2 ...

Options:

  -h,  --help                Print this message.

  -V,  --version             Print the package version.

  -p,  --port port           Registry port. Default: 443 (HTTPS) or 80 (HTTP).

       --registry registry   Registry. Default: 'registry.npmjs.org'.

       --protocol protocol   Registry protocol. Default: 'https'.

       --format format       Output format: csv or json. Default: 'csv'.

       --delimiter delimiter CSV column delimiter. Default: ','.

       --quotes              Wrap CSV column values in quotes.

```

### Notes

*	If a package is successfully resolved, the `package:url` pair is written to `stdout`.

*	If a package cannot be resolved due to a downstream `error` (failure), the package (and its associated `error`) is written to `sterr`.

*	Output order is __not__ guaranteed to match input order.

### Examples

``` bash

$ DEBUG=* pkgrepo dstructs-matrix compute-erf utils-copy log

# => dstructs-matrix,https://github.com/dstructs/matrix.git

# => log,null

# => utils-copy,https://github.com/kgryte/utils-copy.git

# => compute-erf,https://github.com/compute-io/erf.git

```

To output as newline-delimited JSON ([ndjson][ndjson]), set the `format` option.

``` bash

$ DEBUG=* pkgrepo --format=json dstructs-matrix compute-erf utils-copy log

# => {"dstructs-matrix":"https://github.com/dstructs/matrix.git"}

# => {"log":null}

# => {"utils-copy":"https://github.com/kgryte/utils-copy.git"}

# => {"compute-erf":"https://github.com/compute-io/erf.git"}

```

---

## Tests

### Unit

This repository uses [tape][tape] for unit tests. To run the tests, execute the following command in the top-level application directory:

``` bash

$ make test

```

All new feature development should have corresponding unit tests to validate correct functionality.

### Test Coverage

This repository uses [Istanbul][istanbul] as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash

$ make test-cov

```

Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,

``` bash

$ make view-cov

```

### Browser Support

This repository uses [Testling][testling] for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

``` bash

$ make test-browsers

```

To view the tests in a local web browser,

``` bash

$ make view-browser-tests

```

---

## License

[MIT license](http://opensource.org/licenses/MIT).

## Copyright

Copyright © 2016. Athan Reines.

[npm-image]: http://img.shields.io/npm/v/npm-repo-url.svg

[npm-url]: https://npmjs.org/package/npm-repo-url

[build-image]: http://img.shields.io/travis/kgryte/npm-repo-url/master.svg

[build-url]: https://travis-ci.org/kgryte/npm-repo-url

[coverage-image]: https://img.shields.io/codecov/c/github/kgryte/npm-repo-url/master.svg

[coverage-url]: https://codecov.io/github/kgryte/npm-repo-url?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/npm-repo-url.svg

[dependencies-url]: https://david-dm.org/kgryte/npm-repo-url

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/npm-repo-url.svg

[dev-dependencies-url]: https://david-dm.org/dev/kgryte/npm-repo-url

[github-issues-image]: http://img.shields.io/github/issues/kgryte/npm-repo-url.svg

[github-issues-url]: https://github.com/kgryte/npm-repo-url/issues

[tape]: https://github.com/substack/tape

[istanbul]: https://github.com/gotwarlost/istanbul

[testling]: https://ci.testling.com

[csv]: https://en.wikipedia.org/wiki/Comma-separated_values

[ndjson]: https://github.com/ndjson/ndjson-spec