Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ruyadorno/grunt-menu

Useful menu interface for listing/executing your configured tasks
https://github.com/ruyadorno/grunt-menu

grunt grunt-plugins javascript js nodejs

Last synced: 2 months ago
JSON representation

Useful menu interface for listing/executing your configured tasks

Host: GitHub
URL: https://github.com/ruyadorno/grunt-menu
Owner: ruyadorno
Created: 2014-08-06T01:57:43.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2020-05-14T21:24:44.000Z (over 4 years ago)
Last Synced: 2024-10-17T03:14:50.985Z (3 months ago)
Topics: grunt, grunt-plugins, javascript, js, nodejs
Language: JavaScript
Size: 31.3 KB
Stars: 79
Watchers: 5
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# grunt-menu

> Useful menu interface for listing/executing your configured tasks.

version: 1.0.2

[![Build Status](https://travis-ci.org/ruyadorno/grunt-menu.svg?branch=master)](https://travis-ci.org/ruyadorno/grunt-menu)

## About

This plugin is intended to just add a simple menu interface for browsing and eventually executing your configured tasks.

See what it looks like:

![Executing plugin example](http://i.imgur.com/ojC1tXi.png)

## Getting Started

This plugin requires Grunt.

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

### Setup

```shell
npm install grunt-menu --save-dev
```

If you are using the `load-grunt-tasks` module to automatically load your Grunt plugins, you are good to go. If that is not the case, the menu may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-menu');
```

## Usage Examples

To invoke the menu just run the `grunt menu` task:

```shell
grunt menu
```

That's it, a menu interface should appear and allow you to select which task to run.

### Multi task mode

If you want to invoke more than one task at once, you can activate the multiple tasks mode:

```shell
grunt menu --multi
```

It will behave like a checkbox list, where you select items using **space** and run the selected commands with the **enter** key.

### Informative mode

You can configure the menu task to exhibit the description of each task along with its name. It can be configured within you Gruntfile tasks by setting `{ info: true }` in your menu task configuration options **or** when invoking the Grunt command on shell:

```shell
grunt menu --info
```

## Pro tip

Add the menu task as your default task, that way anytime a new person come accross your project they just need to run `grunt` and have a nice overview of the available tasks.

Just add/replace the following line in your **Gruntfile**:

```js
grunt.registerTask('default', ['menu']);
```

## 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](http://gruntjs.com/).