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

prompt-expand

v1.0.1

Published

Expand prompt. Can be used as a standalone prompt, or with a prompt system like [Enquirer].

Downloads

32,420

Readme

prompt-expand NPM version NPM monthly downloads NPM total downloads

Expand prompt. Can be used as a standalone prompt, or with a prompt system like Enquirer.

prompt-expand example

Install

Install with npm:

$ npm install --save prompt-expand

Usage

var Prompt = require('prompt-expand');
var prompt = new Prompt({
  message: 'What action should be taken on file.js?',
  name: 'conflict',
  default: 'x',
  choices: [
    {
      key: 'y',
      name: 'Overwrite',
      value: 'overwrite'
    },
    {
      key: 'a',
      name: 'Overwrite this one and all next',
      value: 'overwrite_all'
    },
    {
      key: 'd',
      name: 'Show diff',
      value: 'diff'
    },
    new Prompt.Separator(),
    {
      key: 'x',
      name: 'Abort',
      value: 'abort'
    }
  ]
});

// async
prompt.ask(function(answer) {
  console.log({file: answer});
});

// promise
prompt.run()
  .then(function(answer) {
    console.log({file: answer});
  })
  .catch(function(err) {
    console.log(err);
  });

Enquirer usage

Register as a plugin with enquirer.

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('expand', require('prompt-expand'));

Functional-style questions

Define questions using the .question method.

enquirer.question('file', 'Conflict on `file.js`: ', {
  type: 'expand',
  // "default" can be the index of the default choice, 
  // or the `key` or `name` of the default choice
  default: 'x', 
  choices: [
    {
      key: 'y',
      name: 'Overwrite',
      value: 'overwrite'
    },
    {
      key: 'a',
      name: 'Overwrite this one and all next',
      value: 'overwrite_all'
    },
    {
      key: 'd',
      name: 'Show diff',
      value: 'diff'
    },
    enquirer.separator(),
    {
      key: 'x',
      name: 'Abort',
      value: 'abort'
    }
  ]
});

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers);
  })
  .catch(function(err) {
    console.log(err);
  });

Declarative-style questions

Define questions using a declarative, Inquirer-style format.

var questions = [
  {
    type: 'expand',
    message: 'Conflict on `file.js`: ',
    default: 'x',
    name: 'file',
    choices: [
      {
        key: 'y',
        name: 'Overwrite',
        value: 'overwrite'
      },
      {
        key: 'a',
        name: 'Overwrite this one and all next',
        value: 'overwrite_all'
      },
      {
        key: 'd',
        name: 'Show diff',
        value: 'diff'
      },
      enquirer.separator(),
      {
        key: 'x',
        name: 'Abort',
        value: 'abort'
      }
    ]
  }
];

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers);
  })
  .catch(function(err) {
    console.log(err);
  });

Attribution

Based on the expand prompt in inquirer.

About

Related projects

Contributing

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

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 27, 2017.