gulp-changed

> 编程语言

Open source

Only pass through changed files

739 stars0 likes1 views

Website GitHub

About

Only pass through changed files

gulp-changed

Only pass through changed files

No more wasting precious time on processing unchanged files.

By default it's only able to detect whether files in the stream changed. If you require something more advanced like knowing if imports/dependencies changed, create a custom comparator, or use another plugin.

Install

bash

npm install --save-dev gulp-changed

Usage

javascript

import gulp from 'gulp';
import changed from 'gulp-changed';
import ngAnnotate from 'gulp-ng-annotate'; // Just as an example

const SOURCE = 'src/*.js';
const DESTINATION = 'dist';

exports.default = () => (
	gulp.src(SOURCE)
		.pipe(changed(DESTINATION))
		// `ngAnnotate` will only get the files that
		// changed since the last time it was run
		.pipe(ngAnnotate())
		.pipe(gulp.dest(DESTINATION))
);

API

changed(destination, options?)

destination

Type: string | Function

Destination directory. Same as you put into gulp.dest().

This is needed to be able to compare the current files with the destination files.

Can also be a function returning a destination directory path.

options

Type: object

cwd

Type: string
Default: process.cwd()

Working directory the folder is relative to.

extension

Type: string

Extension of the destination files.

Useful if it differs from the original, like in the example below:

javascript

export const jade = () => (
	gulp.src('src/**/*.jade')
		.pipe(changed('app', {extension: '.html'}))
		.pipe(jade())
		.pipe(gulp.dest('app'))
);

hasChanged

Type: Function
Default: compareLastModifiedTime

Function that determines whether the source file is different from the destination file.

Built-in comparators

Named imports:

compareLastModifiedTime - Compare modification times (default)
compareContents - Compare file contents (only useful for files that are copied without transformation)

Example

javascript

import {compareContents} from 'gulp-changed';

// compareContents only works when files are copied without transformation
export const images = () => (
	gulp.src('src/images/**/*')
		.pipe(changed('dist/images', {hasChanged: compareContents}))
		.pipe(gulp.dest('dist/images'))
);

You can also specify a custom comparator function, which will receive the following arguments:

sourceFile (Vinyl file object)
destinationPath (string) - The destination for sourceFile as an absolute path

The function is expected to return sourceFile | Promise if it passes some comparison or undefined | Promise. Examples.

transformPath

Type: Function

Function to transform the path to the destination file. Should return the absolute path to the (renamed) destination file.

Useful if you rename your file later on, like in the below example:

javascript

export const marked = () => (
	gulp.src('src/content/about.md')
		.pipe(changed('dist', {
			transformPath: newPath => path.join(path.dirname(newPath), path.basename(newPath, '.md'), 'index.html')
		}))
		.pipe(marked())
		.pipe(rename(newPath => path.join(path.dirname(newPath), path.basename(newPath, '.md'), 'index.html')))
		.pipe(gulp.dest('dist'))
);