写一个自定义任务校验 dist 目录是否为空并给出警告

解读

在国内前端团队面试中,“写一个自定义 Grunt 任务” 属于高频实操题,重点考察三点:

  1. 对 Grunt 任务注册机制(grunt.registerTask / grunt.registerMultiTask)的熟练度;
  2. 对 Node 文件系统同步 API 的严谨使用(同步写法更贴合 Grunt 运行期,避免回调地狱);
  3. 对**“警告”与“失败”**的区分:警告用 grunt.log.warn,不中断流水线;失败用 grunt.fail.warn/fatal,直接阻断后续任务。

题目要求“校验 dist 目录是否为空并给出警告”,不强制中断构建,因此只需输出黄色警告,返回 true 即可。该场景在 CI 与本地开发中非常实用:若 dist 残留旧文件,可能导致发布包体积异常或缓存污染,提前提醒开发者清理。

知识点

  • Grunt 任务类型:registerTask(普通任务)与 registerMultiTask(多目标);本题用 registerTask 足够。
  • Node fs 同步方法:fs.existsSync → fs.readdirSync,避免异步回调。
  • 空目录判定:readdirSync 返回数组长度为 0。
  • 日志级别:grunt.log.warn 输出黄色警告;grunt.log.ok 输出绿色成功;grunt.fail.warn 输出并中断。
  • 任务返回值:返回 true 表示任务成功;返回 false 或抛出错误会被 Grunt 标记为失败。
  • 国内工程规范:dist 目录常由 .gitignore 忽略,构建前清空(clean)是基线要求,因此“非空”属于**“可警告但可容忍”**的柔性规则。

答案

在 Gruntfile.js 中新增自定义任务:

module.exports = function(grunt) {
  grunt.initConfig({ /* 其他配置 */ });

  grunt.registerTask('check-dist-empty', '校验 dist 目录是否为空', function() {
    const fs = require('fs');
    const path = require('path');
    const dist = path.resolve('dist');

    // 目录不存在也视为“空”
    if (!fs.existsSync(dist)) {
      grunt.log.ok('dist 目录不存在,视为空。');
      return true;
    }

    let stats;
    try {
      stats = fs.statSync(dist);
    } catch (e) {
      grunt.fail.warn('无法读取 dist 目录:' + e.message);
      return false;
    }

    if (!stats.isDirectory()) {
      grunt.fail.warn('dist 已存在但不是目录,请检查。');
      return false;
    }

    const files = fs.readdirSync(dist);
    if (files.length > 0) {
      grunt.log.warn(`**警告**:dist 目录非空,包含 ${files.length} 个文件/文件夹,建议先清理!`);
      // 仅警告,不阻断
      return true;
    }

    grunt.log.ok('dist 目录为空,校验通过。');
    return true;
  });

  // 推荐在 build 流水线头部插入
  grunt.registerTask('build', ['check-dist-empty', 'clean', 'copy', 'uglify']);
};

使用方式:

npx grunt check-dist-empty

拓展思考

  1. 参数化目录:把目录路径做成配置项,例如 grunt.config('check-dist-empty.options.targetDir'),实现任务复用。
  2. 阈值警告:允许保留 .gitkeep 或指定白名单文件,其余文件超过 N 个才警告,降低误报。
  3. 与 clean 任务联动:若检测到非空,可自动执行 grunt.task.run('clean') 并重新检查,实现**“智能清理”**。
  4. 性能优化:在大型 monorepo 中,dist 可能含上万文件,使用 fs.opendirSync 流式读取,读到第一个实体即提前退出,降低 IO 耗时。
  5. 国内 CI 场景:在 GitLab-CI 或 Jenkins 中,可将该任务置于**“预构建”阶段,配合钉钉/飞书机器人 webhook,把警告推送到群聊,实现“人未到,问题先知”**的自动化体验。