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

grunt-wizard

v1.3.0

Published

A wizard to select the desired task and options

Downloads

8

Readme

grunt-wizard

A wizard to select the desired task and options

Preview

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-wizard --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wizard');

The "wizard" task

Overview

In your project's Gruntfile, add a section named wizard to the data object passed into grunt.initConfig().

grunt.initConfig({
  wizard: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.message

Type: String Default value: 'Choose a task to run'

options.choices

Type: Object|Function

A list of tasks and parameters

Usage Examples

If you just want to see this plugin in action clone the repository and launch grunt:

git clone https://github.com/jantimon/grunt-wizard
grunt

Default Options

In this example, the prompt will ask to choose between nodeunit and jshint:

grunt.initConfig({
  wizard: {
    default: {
      options: {
        message: 'Choose a task to run',
        choices: {
          'nodeunit': 'Test the plugin',
          'jshint': 'Check for common js errors'
        }
      }
    }
  },
})

Choices function

In this example the result will be the same as in default options however the choices are build up in a function

grunt.initConfig({
  wizard: {
    default: {
      options: {
        message: 'Choose a task to run',
        choices: function(){
          return {
            'nodeunit': 'Test the plugin',
            'jshint': 'Check for common js errors'
          };
      }
    }
  },
})

Sub parameters

It is also possible to set custom parameter values

grunt.initConfig({
  wizard: {
    default: {
      options: {
        message: 'Choose a task to run',
        choices: function(){
          return {
            'nodeunit': {
              label: 'Test the plugin',
              parameter: [{
                name: '--customParameter',
                message: 'Choose a value for --customParameter',
                choices: {
                  'blue': 'Run all tests in blue',
                  'red': 'Run all tests in red'
                }
              },
              {
                name: '--anotherCustomParameter',
                message: 'Choose a value for --anotherCustomParameter',
                choices: ['yellow', 'black']
              }]
            }
          },
          'jshint': 'Check for common js errors'
        };
      }
    }
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

Copyright (c) 2014 Jan Nicklas. Licensed under the MIT license.