gulp-choose-files

gulp-choose-files

Gulp plugin that prompts you to choose the files to pass through the stream.

Install

Install with npm:

$ npm install --save gulp-choose-files

Install with yarn:

$ yarn add gulp-choose-files

Usage

var gulp = require('gulp');
var choose = require('gulp-choose-files');

gulp.task('default', function() {
  return gulp.src('fixtures/*.*')
    .pipe(choose())
    .pipe(gulp.dest('actual'));
});

options.key

Type: string

Default: relative

Specify the vinyl file property to use when displaying file names in the choices array.

Examples

Given the file path /dev/fixtures/foo.txt (depending on cwd and file.base), here is what you would get:

choose({key: 'path'});
//=> '/dev/fixtures/foo.txt'
choose({key: 'relative'});
//=> 'fixtures/foo.txt'
choose({key: 'basename'});
//=> 'foo.txt'
choose({key: 'stem'});
//=> 'foo'

options.choices

If you need to be able to automatically skip the prompt, you can pass a string or array with your "choices" to options.choices.

The following will only write a.txt:

gulp.task('default', function() {
  return gulp.src('fixtures/*.txt')
    .pipe(choose({choices: ['a.txt']}))
    .pipe(gulp.dest('actual'));
});

About

Related projects

• gulp-choose-file: Gulp plugin that prompts you to choose a file to pass through the stream. | homepage
• gulp-condense: Remove extra newlines in a string. | homepage
• gulp-extname: gulp plugin to dynamically rewrite dest extensions based on src extensions. | homepage
• gulp-htmlmin: gulp plugin to minify HTML. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on April 28, 2017.