npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

base-npm-prompt

v0.2.1

Published

Extends the base-npm plugin with prompts for intalling dependencies as a part of a build-workflow.

Downloads

4,666

Readme

base-npm-prompt NPM version NPM downloads Build Status

Extends the base-npm plugin with prompts for intalling dependencies as a part of a build-workflow.

Install

Install with npm:

$ npm install base-npm-prompt --save

Usage

var prompt = require('base-npm-prompt');
var npm  require('base-npm');
var Base = require('base-app');
var app = new Base();

// register the `base-npm` plugin first
app.use(npm());

// register the `base-npm-prompt` plugin
app.use(prompt());

Note that if you use base directly you will also need to let the plugin know that it is being registered on a Base "application" (since Base can be used to create anything, like views, collections etc.).

var Base = require('base');
var app = new Base({isApp: true}); // <=
var prompt = require('base-npm-prompt');
var npm = require('base-npm');

// register the `base-npm` plugin first
app.use(npm());

// register the `base-npm-prompt` plugin
app.use(prompt());

app.npm.prompt('dependencies', function(err) {
  if (err) return cb(err);
  app.npm.prompt('devDependencies', cb);
});

API

.npm.prompt

Prompts the user to ask if they want to install the packages listed on app.cache.install.dependencies or app.cache.install.devDependencies based on the given type.

Params

  • type {String}: dependency type to install (dependencies or devDependencies)
  • options {Object}
  • cb {Function}: Callback

Example

app.npm.prompt('dependencies', function(err) {
  if (err) return console.error(err):
});

.npm.askInstall

Prompts the user to ask if they want to install the given package(s). Requires the base-questions plugin to be registered first.

Params

  • names {String|Array}: One or more package names.
  • options {Object}
  • cb {Function}: Callback

Example

app.npm.askInstall('isobject', function(err) {
  if (err) throw err;
});

.npm.checkInstall

Prompts the user to ask if they want to check if the given package(s) exist on npm, then install the ones that do exist. Requires the base-questions plugin to be registered first.

Params

  • names {String|Array}: One or more package names.
  • options {Object}
  • cb {Function}: Callback

Example

app.npm.checkInstall('isobject', function(err) {
  if (err) throw err;
});

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.


This file was generated by verb, v0.9.0, on June 16, 2016.