gulp-repl

A simple REPL for gulp.

usage

// gulpfile.ts
import gulp, { type TaskFunction } from 'gulp';
import repl from 'gulp-repl';

const gulpWithRepl = gulp as typeof gulp & { repl?: ReturnType<typeof repl.start> };

const replStart: TaskFunction = (done) => {
  gulpWithRepl.repl = repl.start(gulp);
  done();
};

const replStop: TaskFunction = (done) => {
  if (gulpWithRepl.repl) {
    gulpWithRepl.repl.close(); // same as nodejs.org/api/readline.html#readline_rl_close
  }
  done();
};

const foo: TaskFunction = (done) => {
  // do foo stuff
  done();
};

const bar: TaskFunction = (done) => {
  // do bar stuff
  done();
};

exports['repl-start'] = replStart;
exports['repl-stop'] = replStop;
exports.foo = foo;
exports.bar = bar;
exports.default = gulp.series('foo', 'bar');

Note: For gulpfile.ts, ensure ts-node or tsx is available. Use gulpfile.js with require() if you prefer plain JavaScript.

Then, on your terminal write:

gulp repl-start

and you'll have a REPL with:

1. Press Enter to see the prompt
2. Write the tasks you want to run
3. Press Tab for completion

$ gulp
... some task logging here
(press Enter)
> (press Tab to see completion)
foo      bar      default
> foo bar
[10:39:11] Starting 'foo'...
[10:39:11] Finished 'foo' after 13 μs
[10:39:11] Starting 'bar'...
[10:39:11] Finished 'bar' after 5.52 μs

API

The module exports an object with the following methods:

import repl from 'gulp-repl';

repl.add

add(gulp: Gulp): typeof repl

Adds the gulp instance tasks for the REPL and returns the module again.

repl.remove

remove(gulp: Gulp): typeof repl

Removes the gulp instance tasks from the REPL and returns the module again.

repl.reset

reset(): typeof repl

Removes all of the previously added instances and returns the module again.

repl.get

get(gulp?: Gulp): ReplInstance[] | ReplInstance | null

Takes a gulp instance as argument.

returns

• null if the gulp instance wasn't stored yet
• all of the stored instances if no arguments are given
• metadata stored for the given gulp instance if was already stored

repl.start

start(gulp?: Gulp): readline.Interface

Takes a gulp instance as argument.

Adds the gulp instance tasks for the REPL.

Starts a REPL listening on stdin and writing on stdout. Each of the commands typed to the REPL are looked up in each of the instances given on add.

returns a readline.Interface instance.

See node's core module readline documentation about the readline.Interface.

install

$ npm install --save-dev gulp-repl

requirements

• Node.js >= 20.0.0

Changelog

v3.0.0:

• Modernize codebase: TypeScript, Jest, ESLint
• Add GitHub Actions CI (Node 20, 22, 24)
• Pin package versions
• Breaking: Output is now in dist/, requires build step before publish

v2.0.1:

• test: small fix to use repl.start instead of the module.exports
• docs: remove docs of exporting a function
• docs: small fix on the docs
• version bump

v2.0.0:

• docs: add new api docs
• test: split test into files for each api method
• dev: separate module into add, get, remove, reset and start

v1.1.2:

• docs: add changelog
• next_release: patch release
• fix: gulp.parallel as task runner when gulp.start is undefined

v1.1.1:

• fix: make the repl prompt after not found tasks
• fix: line end matches

v1.1.0:

• manage multiple gulp instances

license

The MIT License (MIT)

Copyright (c) 2015-present Javier Carrillo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.