Repository URLs
Get repository URLs for one or more packages.
Installation
$ npm install npm-repo-url
Usage
var urls = ;
urls( opts, clbk )
Get repository URLs for one or more packages.
var opts ='packages':'dstructs-matrix''compute-erf''log''utils-copy''unknown_package_name';;{if errorthrow error;consoledir 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) or80
(HTTP). - protocol: registry protocol. Default:
'https'
.
To query an alternative registry, set the relevant options.
var opts ='packages':'dstructs-array''flow-map''utils-merge2''registry': 'my.favorite.npm/registry''port': 80'protocol': 'http';;
urls.factory( opts, clbk )
Creates a reusable function
.
var pkgs ='dstructs-matrix''compute-stdev''compute-variance';var get = urls;;;;// ...
The factory method accepts the same options
as urls()
.
Notes
- If the module encounters an application-level
error
(e.g., no network connection, non-existent registry, etc), thaterror
is returned immediately to the providedcallback
. - If the module encounters a downstream
error
(e.g., timeout, reset connection, etc), thaterror
is included in the returned results under thefailures
field. - Successfully resolved packages without an associated repository URL have a
url
value equal tonull
.
Examples
var ls = ;var urls = ;var opts ='username': 'kgryte';;{var opts;if errorthrow error;if !listlengthreturn;opts ='packages': list;;}{if errorthrow error;consoledir data ;}
To run the example code from the top-level application directory,
$ DEBUG=* node ./examples/index.js
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g npm-repo-url
Usage
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 tostdout
. - If a package cannot be resolved due to a downstream
error
(failure), the package (and its associatederror
) is written tosterr
. - Output order is not guaranteed to match input order.
Examples
$ 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), set the format
option.
$ 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 for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.