turbo-gulp/task-generators/clean.ts

Gulp tasks to boost high-quality projects.

import del from "del";
import { Gulp } from "gulp";
import { Minimatch } from "minimatch";
import {posix as path } from "path";
import { TaskFunction } from "../utils/gulp-task-function";
import * as matcher from "../utils/matcher";

export interface CleanOptions {
  /**
   * Base-directory for clean (usually `project.root`)
   */
  base: string;

  /**
   * An array of relative paths to directories to delete
   */
  dirs?: string[];

  /**
   * An array of minimatch patterns
   */
  files?: string[];
}

/**
 * Return a list of files, prefixed by "base"
 */
function getFiles(options: CleanOptions): string[] {
  const files: string[] = [];

  if (options.dirs !== undefined) {
    for (const dir of options.dirs) {
      files.push(path.join(options.base, dir));
    }
  }

  if (options.files !== undefined) {
    for (const file of options.files) {
      files.push(matcher.asString(matcher.join(options.base, new Minimatch(file))));
    }
  }

  return files;
}

/**
 * Generate a task to clean files
 */
export function generateTask(gulp: Gulp, options: CleanOptions): TaskFunction {
  return async function () {
    return del(getFiles(options));
  };
}