Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 2.1 KB

readme.md

File metadata and controls

100 lines (69 loc) · 2.1 KB

depnames

Fetch a list of dependency names for a given npm package

Uses fetch-nice-package and nice-package under the hood.

Installation

Node 8 or greater is required because this module uses async functions.

npm i -g depnames

Module Usage

This module exports a single function which expects a package name and returns a promise. The resolved value is an array of package name strings:

require('depnames')('cheerio')
  .then(names => console.log(names))

To fetch dev dependencies, set the dev option:

require('depnames')('cheerio', {dev: true})
  .then(names => console.log(names))

If you need more flexibility, see fetch-nice-package and nice-package.

CLI Usage

The CLI prints a newline-delimited list to standard out:

depnames budo

bole
browserify
chokidar
connect-pushstate
escape-html
...

This newline pattern plays nicely with tools like the ghub CLI.

The following command will open every dependency's repository page in a browser tab:

npm i -g ghub depnames
depnames express | ghub

Pass the --dev flag to list devDependencies:

depnames budo --dev

2d-context
babel-preset-es2015
babelify
brfs
canvas-loop
...

Tests

npm install
npm test

Dependencies

Dev Dependencies

  • chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
  • mocha: simple, flexible, fun test framework
  • nixt: Simple and powerful testing for command-line apps
  • standard: JavaScript Standard Style
  • standard-markdown: Test your Markdown files for Standard JavaScript Style™

License

MIT