npm-pd

NPM Publisher Dashboard (npm-pd)

A beautiful CLI dashboard for NPM publishers.

Installation

yarn global add npm-pd

npm install --global npm-pd

API

• CLI Usage
  • npm-pd maintainer
  • npm-pd author
  • npm-pd evaluate
• Programmatic Usage
• Commander Plugins

CLI Usage:

yarn npm-pd --help

Usage: npm-pd [options] [command]

Options:
  -V, --version                output the version number
  -h, --help                   display help for command

Commands:
  maintainer [options] <name>  fetch packages by maintainer
  author [options] <name>      fetch packages by author
  evaluate <name>              show analysis for a package
  help [command]               display help for command

Maintainer:

yarn npm-pd maintainer --help

Display packages by maintainer.

Usage: npm-pd maintainer [options] <name>

fetch packages by maintainer

Options:
  -s --sort <value>    sort by 'date', 'name', 'version', 'quality', 'popularity', 'maintenance', or 'score'
  -r --reverse         reverse sort order
  -o --org <value      filter packages by org
  -l --limit <number>  limit the number of packages returned
  -h, --help           display help for command

Author:

yarn npm-pd author --help

Display packages by author.

Usage: npm-pd author [options] <name>

fetch packages by author

Options:
  -s --sort <value>    sort by 'name', 'version', 'date', 'quality', 'popularity', 'maintenance', or 'score'
  -r --reverse         reverse sort order
  -o --org <value      filter packages by org
  -l --limit <number>  limit the number of packages returned
  -h, --help           display help for command

Evaluate:

yarn npm-pd evaluate --help

Show search analysis for a package.

Usage: npm-pd evaluate [options] <name>

show search analysis for a package

Options:
  -h, --help  display help for command

Programmatic Usage:

Run npm-pd commands programmatically:

import { maintainerAction, authorAction, evaluateAction } from "npm-pd";

Types:

maintainerAction(name: string, options: PublisherOptions) => void;
 
authorAction(name: string, options: PublisherOptions) => void;
 
evaluateAction(name: string) => void;
 
type PublisherOptions = {
  sort?: SortBy;
  reverse?: boolean;
  org?: string;
  limit?: number;
}

Commander Plugins:

Add npm-pd commands to any commander program:

import { program } from "commander";
import { maintainer, author, evaluate } from "npm-pd";
 
maintainer(program);
author(program);
evaluate(program);

Dependencies

• @bconnorwhite/module: Set commander version based on your module's package.json.
• chalk: Terminal string styling done right
• cli-table3: Pretty unicode tables for the command line. Based on the original cli-table.
• commander: The complete solution for node.js command-line programs
• lodash: Lodash modular utilities.
• moment: Parse, validate, manipulate, and display dates
• npms-io-client: Isomorphic typed client for npms.io
• ora: Elegant terminal spinner
• semver: The semantic version parser used by npm.
• url: The core url packaged standalone for use with Browserify.

Dev Dependencies

• @bconnorwhite/bob: Bob builds and watches typescript projects.
• @types/lodash: TypeScript definitions for Lo-Dash
• @types/node: TypeScript definitions for Node.js

License

MIT

Related Packages

• npms-io-client: Isomorphic typed client for npms.io