@ilabdev/copy

Gulp tasks for copying files & directories

Installation & set up

Install @ilabdev/copy

npm install @ilabdev/copy --save-dev

-- OR --

yarn add @ilabdev/copy --dev

Include @ilabdev/copy in your gulpfile.js

NOTE: Make sure you pass gulp through to the package as shown below. The package sets up gulp tasks and will need it passed through to work.

require( '@ilabdev/copy' )( gulp )

Add the content from config.sample.js to your .gulpconfig.js and adjust as appropriate

module.exports = {
    // Other configs here...
    copy: {
        process: true,
        watch: true,
        logColor: 'cyan',
        areas: [
            {
                paths: {
                    src: './src/copy/**/*',
                    watch: './src/copy/**/*',
                    dest: './dist/copy',
                },
                pipes: {
                    // Put any pipe overrides here
                    src: {
                        allowEmpty: true,
                        base: './src/copy',
                    },
                    dest: {},
                },
            },
        ],
        pipes: {
            watch: {
                events: 'all',
            },
        },
    },
    // Other configs here...
}

Run gulp copy to run the copy task, gulp copy:watch to run the watch task, or add the task as a script and run that with npm or yarn

Config

process

Type: boolean

Whether to copy files & directories or not

watch

Type: boolean

Whether to watch files & directories for changes or not

loggerColor

Type: string

The logger color to use for any output text. See https://github.com/stgdp/fancy-logger#available-modifiers for colors that can be used

areas

Type: object[]

The areas to be copied. Each area has it's own, isolated settings to allow for separate configs

areas[].paths

Type: object

Path references for the copier

areas[].paths.src

Type: string[]|string

The paths to copy. Passed through to gulp.src, items can be globs

areas[].paths.watch

Type: string[]|string

The paths to watched. These are combined into a single array and passed through to gulp.watch

areas[].paths.dest

Type: string

The destination path of the files & directories. Passed through to gulp.dest, items can be globs

areas[].pipes

Type: object

Options to be passed through to the pipes.

areas[].pipes.src

Type: object

Options to be passed through to the gulp.src pipe. See https://gulpjs.com/docs/en/api/src/ for more information

areas[].pipes.dest

Type: object

Options to be passed through to the gulp.dest pipe. See https://gulpjs.com/docs/en/api/dest/ for more information

pipes

Type: object

Options to be passed through to the pipes.

pipes.watch

Type: object

Options to be passed through to the gulp.watch pipe. See https://gulpjs.com/docs/en/api/watch/ for more information