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

inquander

v1.1.1

Published

Inquirer for commander. If no arguments and options are passed to your commander app, it runs inquirer.

Downloads

492

Readme

inquander

Inquirer for commander. This module takes two awesome modules and connects them.

If no arguments and options are passed to your commander app, it runs inquirer. For all commands, arguments and options defined in your commander app.

If you call your module with arguments it acts like a normal commander tool. call with arguments

But if you call it without any arguments or commands it will parse your definitions and runs it using inquirer. call without arguments

Usage

Instead of calling program.parse you need to call inquander.parse.

var program = require('commander'),
    inquander = require('inquander');

program
    .command('hello [name]')
    .action(function(name) {
        console.log('Hello', name);
    });
program
    .command('pay [creditcard]')
    .action(function(creditcard) {
        console.log('Please come again.');
        console.log(creditcard);
    });

inquander.parse(program, process.argv);

Options

Message and Default Command

The root message and default command options define the inquirer root behavior:

inquander.parse(program, process.argv, {
    message: 'Little Caesar\'s Pizza Ordering',
    defaultCommand: 'pay'
});

Type Overrides

The commander api doesn't identify special types (password, list, editor, etc). So to specify field types specifically for inquirer, use the overrides option:

inquander.parse(program, process.argv, {
    overrides: {
        'creditcard': {
            type: 'password'
        },
        'pickup': {
            type: 'checkbox',
            choices: ['one', 'two']
        }
    }
});

Hidden Fields

To hide a field from the interactive view, use the hidden option:

inquander.parse(program, process.argv, {
    hidden: ['notininquirer']
});
For more examples take a look into the example folder.

Advanced

Run Command

Inquander.runCommand(command, forceInteractive) allows you to manually trigger a generated command.

Detecting Interactive Mode

To enable different behavior for interactive and non-interactive modes, inquander defines a flag in program.usingInquirer which indicates whether inquander is using inquirer or commander.

Promises in Overrides

One can also pass Promises in for any value inside of the overrides object, for instance:

``Javascript inquander.parse(program, process.argv, { overrides: { 'creditcard': { type: 'password' }, 'pickup': { type: 'checkbox', choices: Promise.resolve(['one','two']) } } });