grunt-prompt
Advanced tools
Comparing version 0.2.1 to 0.2.2
@@ -19,8 +19,2 @@ /* | ||
grunt.loadNpmTasks('grunt-notify'); | ||
grunt.loadNpmTasks('grunt-contrib-jshint'); | ||
grunt.loadNpmTasks('grunt-mocha-cli'); | ||
grunt.loadTasks('tasks'); | ||
// Project configuration. | ||
@@ -298,2 +292,7 @@ grunt.initConfig({ | ||
]); | ||
require('load-grunt-tasks')(grunt); | ||
grunt.loadTasks('tasks'); | ||
}; |
{ | ||
"name": "grunt-prompt", | ||
"description": "Interactive prompt for your Grunt config using console checkboxes, text input with filtering, password fields.", | ||
"version": "0.2.1", | ||
"version": "0.2.2", | ||
"homepage": "https://github.com/dylang/grunt-prompt", | ||
@@ -38,3 +38,5 @@ "author": { | ||
"chai": "~1.9.0", | ||
"chalk": "~0.4.0" | ||
"chalk": "~0.4.0", | ||
"grunt-templates-dylang": "~0.1.0", | ||
"load-grunt-tasks": "~0.3.0" | ||
}, | ||
@@ -41,0 +43,0 @@ "peerDependencies": { |
@@ -1,17 +0,17 @@ | ||
# grunt-prompt [![Build Status](https://travis-ci.org/dylang/grunt-prompt.png?branch=master)](https://travis-ci.org/dylang/grunt-prompt) | ||
## grunt-prompt [![NPM version](https://badge.fury.io/js/grunt-prompt.png)](http://badge.fury.io/js/grunt-prompt) [![Build Status](https://travis-ci.org/dylang/grunt-prompt.png)](https://travis-ci.org/dylang/grunt-prompt) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) | ||
> Add interactive UI to your Gruntfile such as lists, checkboxes, text input with filtering, and password fields, all on the command line. | ||
> Interactive prompt for your Grunt config using console checkboxes, text input with filtering, password fields. | ||
![grunt-prompt-example](https://f.cloud.github.com/assets/51505/867636/e727abfc-f717-11e2-997e-6b97e24593c3.gif) | ||
`Grunt-prompt`'s UI is powered by the amazing [Inquirer](https://github.com/SBoudrias/Inquirer.js), a project created by Simon Boudrias. | ||
### Getting Started | ||
## Getting Started | ||
This plugin requires Grunt `~0.4.1` | ||
This plugin recommends Grunt `0.4.1` or newer. | ||
```shell | ||
### Installing | ||
```bash | ||
npm install grunt-prompt --save-dev | ||
``` | ||
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: | ||
Once that's done, add this line to your project's `Gruntfile.js`: | ||
@@ -22,4 +22,8 @@ ```js | ||
## grunt-prompt | ||
`Grunt-prompt`'s UI is powered by the amazing [Inquirer](https://github.com/SBoudrias/Inquirer.js), a project created by Simon Boudrias. | ||
![grunt-prompt-example](https://f.cloud.github.com/assets/51505/867636/e727abfc-f717-11e2-997e-6b97e24593c3.gif) | ||
### Overview | ||
@@ -53,6 +57,7 @@ In your project's Gruntfile, add a section named `prompt` to the data object passed into `grunt.initConfig()`. | ||
### Options | ||
#### config | ||
#### Options | ||
##### config | ||
Type: `String` _required_ | ||
@@ -66,3 +71,3 @@ | ||
#### type | ||
##### type | ||
@@ -85,3 +90,3 @@ Type: `String` _required_ | ||
#### message | ||
##### message | ||
@@ -94,3 +99,3 @@ Type: `String` _required_ | ||
#### default | ||
##### default | ||
@@ -101,3 +106,3 @@ Type: `String`/`Array`/`Boolean`/'function' _optional_ | ||
#### choices | ||
##### choices | ||
@@ -120,3 +125,3 @@ For `question types 'list' and 'checkbox'`: Type: `array of hashes` | ||
#### validate | ||
##### validate | ||
@@ -128,3 +133,3 @@ Type: `function(value)` _optional_ | ||
#### filter | ||
##### filter | ||
@@ -135,3 +140,3 @@ Type: `function(value)` _optional_ | ||
#### when | ||
##### when | ||
@@ -142,3 +147,3 @@ Type: `function(answers)` _optional_ | ||
#### then | ||
##### then | ||
@@ -149,4 +154,5 @@ Type: `function(results)` _optional_ | ||
## How to use the results in your Gruntfile | ||
### How to use the results in your Gruntfile | ||
You can also modify how tasks will work by changing options for other tasks. | ||
@@ -198,3 +204,3 @@ You do not need to write code to do this, it's all in the `config` var. | ||
## How can values be accessed from my own code? | ||
### How can values be accessed from my own code? | ||
@@ -215,2 +221,3 @@ This `config` value is accessible to all other `grunt` tasks via `grunt.config('<config name>')`. | ||
### Usage Examples | ||
@@ -303,3 +310,8 @@ | ||
## Release History | ||
### Release History | ||
* **0.2.2** - 4 Feb 2014 - Updated readme to make it auto-generated. | ||
* **0.2.1** - 4 Feb 2014 - Fix bug when using a function to provide choices. | ||
@@ -310,4 +322,39 @@ * **0.2.0** - 26 Jan 2014 - Added `then` option which runs after questions. Improved docs. | ||
## License | ||
MIT | ||
### About the Author | ||
Dylan is a senior JavaScript developer and tech lead at [Opower](http://opower.com), co-creator of [Doodle or Die](http://doodleordie.com), and father of two awesome kids. | ||
Here are some other Node modules Dylan has created: | ||
| Name | Description | Github Stars | Npm Installs | | ||
|---|---|--:|--:| | ||
| [grunt-notify](https://github.com/dylang/grunt-notify) | Automatic desktop notifications for Grunt errors and warnings using Growl for OS X or Windows, Mountain Lion and Mavericks Notification Center, and Notify-Send. | 619 | 52,208 | | ||
| [rss](https://github.com/dylang/node-rss) | RSS feed generator. A really simple API to add RSS feeds to any project. | 177 | 98,802 | | ||
| [shortid](https://github.com/dylang/shortid) | Amazingly short non-sequential url-friendly unique id generator. | 129 | 22,984 | | ||
| [xml](https://github.com/dylang/node-xml) | Fast and simple xml generator. Supports attributes, CDATA, etc. Includes tests and examples. | 35 | 180,625 | | ||
| [anthology](https://github.com/dylang/anthology) | Module information and stats for any @npmjs user | _New!_ | _TBD_ | | ||
| [grunt-attention](https://github.com/dylang/grunt-attention) | Display attention-grabbing messages in the terminal | _New!_ | 336 | | ||
| [observatory](https://github.com/dylang/observatory) | Beautiful UI for showing tasks running on the command line. | _New!_ | 81 | | ||
| [changelog](https://github.com/dylang/changelog) | Command line tool (and Node module) that generates a changelog in color output, markdown, or json for modules in npmjs.org's registry as well as any public github.com repo. | 51 | 2,081 | | ||
| [logging](https://github.com/dylang/logging) | Super sexy color console logging with cluster support. | 21 | 8,793 | | ||
| [grunt-cat](https://github.com/dylang/grunt-cat) | Echo a file to the terminal. Works with text, figlets, ascii art, and full-color ansi. | _New!_ | 396 | | ||
_Data collected on Saturday, February 8, 2014 using [anthology](https://github.com/dylang/anthology)._ | ||
### License | ||
Copyright (c) 2014 Dylan Greene, contributors. | ||
Released under the MIT license | ||
*** | ||
_Generated by [grunt-readme](https://github.com/assemble/grunt-readme) using [grunt-templates-dylang](https://github.com/dylang/grunt-templates-dylang) on Saturday, February 8, 2014._ | ||
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/dylang/grunt-prompt/trend.png)](https://bitdeli.com/free "Bitdeli Badge") [![Google Analytics](https://ga-beacon.appspot.com/UA-4820261-3/dylang/grunt-prompt)](https://github.com/igrigorik/ga-beacon) | ||
[grunt]: http://gruntjs.com/ | ||
[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md | ||
[package.json]: https://npmjs.org/doc/json.html |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
36564
17
345
9
327