Gulp-ultimate-dependent NPM

gulp-ultimate-dependent

Gulp plugin to find the named ultimate dependent in the dependency graph.

Description

When you're running an incremental build system, you usually only want to build the files that change. For frontend applications with multiple main source files (Webpack entry points, individual style files, etc.), you usually only want to build the files containing a changed file. This plugin builds a dependency list and iterates through to find the highest-level dependent. This way, you won't have to do a full rebuild every time a file changes, but build just the files that depend on the changed file.

Of course, this package has uses other than frontend applications. You can use it to build other types of sources, or to generate the list of dependencies for your files.

How it works

1) Find the top-most files matching the ultimateGlob 2) For each file, find the dependencies and record them in a Map<fileName: string, dependencies: string[]> 3) For each of the dependencies, repeat step 2 until all files are processed 4) Search for the changed file in the dependency values of all the maps. If found, then search for that parent file in the dependencies for other files until you reach a parent that matches the ultimateGlob. Return those matches. 5) For any changed file, only rebuild the dependencies for that file (not the dependencies for each of that file's dependencies).

Requirements

Node.js 14 or higher
gulp v4 (untested with other versions)

Installation

npm install --save-dev gulp-ultimate-dependent

Example

const gulp = require('gulp');
const ultimateDependent = require('gulp-ultimate-dependent');

const firstRun = Date.now();
const getDependencyStream = ultimateDependent({
  ultimateGlob: 'src/**/*ParentPage.jsx',
  extensions: ['.js'],
  dependencyFile: 'dependencies.json',
  warnOnMissing: true,
  failOnMissing: true
});
gulp.task('incrementalBuild', () => {
  return gulp.src([
    'src/**/*.{js, jsx}' // all watched files
  ], { since: gulp.lastRun(incrementalBuild) || firstRun }) // what's changed
    .pipe(getDependencyStream())
    .pipe(build()) // build the ultimate dependents
    .pipe(gulp.dest('output/'));
});

Options

ultimateGlob: string - required - search glob pattern identifying all ultimate parent dependents
extensions: string[] - optional, default ['.js'] - used to further process matched dependency string, such as add inferred file extensions
dependencyFile: string | () => string - optional - if you want to output the dependency list, specify a file name or function which returns a file name
warnOnMissing: bool - optional, default false - if true, stream will output to console if it finds a dependency whose file is missing.
failOnMissing: bool - optional, default false - if true, stream will fail if it finds a dependency whose underlying file is missing (this is common if you delete a file you're watching). If false, stream still returns affected dependents. The stream will still fail on other errors.
ignoreCircularDependency: bool - optional, default true - if true, stream will ignore files it's already traversed, indicating a circular dependency. If false, stream will emit an error with the first file it sees twice.