turbo-gulp/task-generators/pug.ts

Gulp tasks to boost high-quality projects.

import { FSWatcher } from "fs";
import { Gulp } from "gulp";
import gulpPug from "gulp-pug";
import { Minimatch } from "minimatch";
import { TaskFunction } from "../utils/gulp-task-function";
import { asString, join } from "../utils/matcher";

export interface Options {
  /**
   * An array of minimatch patterns
   */
  files: string[];

  /**
   * Base-directory for copy
   */
    from: string;

  /**
   * Target directory
   */
  to: string;

  /**
   * gulp-pug options
   */
  pugOptions?: {
    locals?: {};
  };
}

/**
 * Return a list of sources, prefixed by "from"
 */
export function getSources({files, from}: Options): string[] {
  return files.map((val: string): string => asString(join(from, new Minimatch(val))));
}

export function buildPug(gulp: Gulp, options: Options): NodeJS.ReadableStream {
  return gulp
    .src(getSources(options), {base: options.from})
    .pipe(gulpPug(options.pugOptions))
    .pipe(gulp.dest(options.to));
}

/**
 * Generate a task to build pug files
 */
export function generateTask(gulp: Gulp, options: Options): TaskFunction {
  const task: TaskFunction = function (): NodeJS.ReadableStream {
    return buildPug(gulp, options);
  };
  task.displayName = "_build:pug";
  return task;
}

export function watch(gulp: Gulp, options: Options): FSWatcher {
  const buildTask: TaskFunction = generateTask(gulp, options);
  const sources: string[] = getSources(options);
  return gulp.watch(sources, {cwd: options.from}, buildTask) as FSWatcher;
}