show-deps
v0.0.0
Published
A command-line utility for showing dependencies from a project's `package.json` in a fashionable way
Downloads
2
Readme
show-deps
A command-line utility for showing dependencies from a Node.js project's
package.json
in a fashionable way.
Installation
We require Node.js, which comes bundled with npm:
⇒ npm install --global show-deps
Note: You may require some sudo
powers to install globally. So try
use sudo npm install --global show-deps
if necessary.
Basic Usage
I want to see all the dependencies stated in my current directory
⇒ show-deps
┌────────────┬─────────┐
│ Dependency │ Version │
├────────────┼─────────┤
│ cli-table │ ^0.3.1 │
├────────────┼─────────┤
│ commander │ ^2.5.0 │
├────────────┼─────────┤
│ debug │ ^2.1.0 │
└────────────┴─────────┘
┌────────────────┬─────────┐
│ Dev-Dependency │ Version │
├────────────────┼─────────┤
│ mocha │ ^2.0.1 │
├────────────────┼─────────┤
│ should │ ^4.4.1 │
└────────────────┴─────────┘
I want to see the dependencies for the project in that directory
⇒ show-deps --input ../github/node-sequential-ids/
> No Dependencies
┌────────────────┬─────────┐
│ Dev-Dependency │ Version │
├────────────────┼─────────┤
│ mocha │ 1.21.4 │
└────────────────┴─────────┘
I want to see the dependencies stated in that package.json
⇒ show-deps --input ../github/node-simple-argparse/package.json
> No Dependencies
┌────────────────┬─────────┐
│ Dev-Dependency │ Version │
├────────────────┼─────────┤
│ mocha │ 1.21.5 │
├────────────────┼─────────┤
│ should │ 4.0.4 │
└────────────────┴─────────┘
Tables
The previous examples have shown some Guy typing all over the shell.... BAZINGA! A table appeared! Those are CLI-tables. It is possible to produce the table in other formats.
⇒ show-deps --tables
You will get to see all the available table formats. If I wanted to generate
a Markdown table and save it to a Dependencies.md
file, I would:
⇒ show-deps --table md --output Dependencies.md
Help Information
⇒ show-deps -h
Usage: show-deps [options]
Options:
-h, --help output usage information
-V, --version output the version number
-i, --input [file] which JSON File to read from
-o, --output [file] where to write to
-t, --table [shorthand] which kind of table
-a, --tables what kind of tables are there
-v, --verbose do print output
-d, --debug show debug information
TODO
- [ ] add comprehensive tests for table formats and integrations
- [ ] add more table formats
- [ ] feel good about it!
LICENSE
The MIT License (MIT)
Copyright (c) 2015 GochoMugo [email protected]