https://github.com/mxl/gulp-interactive

Gulp interactive prompt.
https://github.com/mxl/gulp-interactive

gulp gulp-friendly interactive prompt

Last synced: 9 days ago
JSON representation

Gulp interactive prompt.

• Host: GitHub
• URL: https://github.com/mxl/gulp-interactive
• Owner: mxl
• License: mit
• Created: 2017-05-11T09:28:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T11:27:39.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T21:54:20.259Z (7 months ago)
• Topics: gulp, gulp-friendly, interactive, prompt
• Language: JavaScript
• Size: 1.45 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/gulp-interactive.svg)](https://www.npmjs.com/package/gulp-interactive)

[![Build Status](https://travis-ci.org/mxl/gulp-interactive.svg?branch=master)](https://travis-ci.org/mxl/gulp-interactive)

[![David](https://img.shields.io/david/mxl/gulp-interactive.svg)](https://david-dm.org/mxl/gulp-interactive)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

# gulp-interactive

Gulp interactive prompt.

## Install

```bash

$ npm install --save-dev gulp-interactive

```

## Usage

### gulpfile.js

```js

var gulp = require('gulp')

var interactive = require('gulp-interactive')

interactive();

gulp.task('build', function(cb) {

  cb();

});

```

### Shell

Launch interactive prompt:

```bash

$ gulp prompt

[01:37:56] Using gulpfile ~/gulp-interactive-example/gulpfile.js

[01:37:56] Starting 'prompt'...

? Enter gulp task name:

```

Then enter task name:

```bash

? Enter gulp task name: build

[01:38:05] Finished 'prompt' after 9 s

[01:38:05] Starting 'build'...

[01:39:05] Finished 'build' after 15 μs

[01:39:05] Starting 'prompt'...

? Enter gulp task name:

```

Enter `:q` to exit prompt.

```bash

? Enter gulp task name: :q

[01:39:09] Finished 'prompt' after 4 s

```

## API

### interactive(options)

#### options

Type: `Object`

##### repeatOnEnter

Type: `boolean`


Default: `false`

Repeat last executed task by simply pressing Enter.

##### taskName

Type: `string`


Default: `prompt`

Gulp task name that starts interactive prompt.

## License

See the [LICENSE](https://github.com/mxl/gulp-interactive/blob/master/LICENSE) file for details.