@lernetz/gulp-serve

    0.2.0 • Public • Published

    @lernetz/gulp-serve

    Gulp-compatible wrapper functions around docker-compose to start Docker containers with proper project name and port listing.

    Usage

    This package exports two asynchronous functions serve and stopServe. Because they follow the error-first callback pattern, they can be used with Gulp as follows:

    // In your Gulpfile:
    
    // Using classic Gulp syntax:
    const gulp = require('gulp');
    const {serve, stopServe} = require('@lernetz/gulp-serve');
    gulp.task('serve', serve());
    gulp.task('serve:stop', stopServe());
    
    // Or, using the newer Gulp 4 syntax:
    const {serve, stopServe} = require('@lernetz/gulp-serve');
    module.exports = {
        'serve': serve(),
        'serve:stop': stopServe(),
    };

    Then run the defined tasks from the command line:

    npx gulp serve
    npx gulp serve:stop

    Options

    The two functions can be configured to use non-default options via an options argument:

    module.exports = {
        'serve': serve(options),
        'serve:stop': stopServe(options),
    };

    The options object allows you to specify the following properties:

    • folder: The path to the folder containing the docker-compose.yml file. The default is 'docker/dev'.

    • name: The project name to be used by docker-compose. Every container will be prefixed with that project name. By default, the name of the current directory will be used.

    Install

    npm i @lernetz/gulp-serve

    DownloadsWeekly Downloads

    1

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    4.33 kB

    Total Files

    4

    Last publish

    Collaborators

    • lernetz-mich
    • stakx