使用Gulp检查文件令牌存在性及现有任务相关技术咨询

嘿，我来帮你搞定Gulp里检查指定令牌的问题！先回顾下你现有的任务代码，已经能完成令牌替换、文件重命名并输出到目标目录了：

var gulp = require('gulp');
var replace = require('gulp-replace');
var rename = require('gulp-rename');
gulp.task('TaskExample', function ReplaceExampleFileTokens() {
  return gulp.src('./src/' + 'ExampleFileTokens.config')
    .pipe(replace('#{String}#', 'Hello World'))
    .pipe(rename('ExampleFile.config'))
    .pipe(gulp.dest('./dest'));
});

现在要实现检查文件中是否存在指定令牌的需求，这里有两种实用方案供你选择：

方案1：自定义流检查（无需额外插件） #

如果你不想引入新的依赖，可以用Gulp底层依赖的through2工具，写一个简单的自定义检查逻辑，灵活度更高。

首先确保through2已安装（没装的话执行npm install through2 --save-dev），然后修改或扩展你的任务：

var gulp = require('gulp');
var replace = require('gulp-replace');
var rename = require('gulp-rename');
var through2 = require('through2');

// 封装一个检查令牌的自定义流函数
function checkToken(targetToken) {
  return through2.obj(function(file, enc, cb) {
    if (file.isBuffer()) {
      const content = file.contents.toString(enc);
      if (!content.includes(targetToken)) {
        // 输出警告信息，也可以直接抛出错误终止任务
        console.warn(`⚠️ 注意：文件 ${file.path} 中未找到指定令牌「${targetToken}」`);
        // 若要强制终止任务，取消下面注释：
        // this.emit('error', new Error(`文件 ${file.path} 缺失必要令牌：${targetToken}`));
      } else {
        console.log(`✅ 文件 ${file.path} 已找到目标令牌「${targetToken}」`);
      }
    }
    this.push(file); // 把文件继续传递到下一个流
    cb();
  });
}

// 修改原有任务，加入令牌检查步骤
gulp.task('TaskExample', function ReplaceExampleFileTokens() {
  const targetToken = '#{String}#';
  return gulp.src('./src/ExampleFileTokens.config')
    .pipe(checkToken(targetToken)) // 先检查令牌是否存在
    .pipe(replace(targetToken, 'Hello World'))
    .pipe(rename('ExampleFile.config'))
    .pipe(gulp.dest('./dest'));
});

// 也可以单独写一个仅检查令牌的任务
gulp.task('checkTokens', function() {
  const targetToken = '#{String}#';
  return gulp.src('./src/*.config') // 批量检查所有config文件
    .pipe(checkToken(targetToken));
});

方案2：使用现成插件gulp-contains #

如果更倾向于用现成工具，可以试试gulp-contains，它专门用来检测文件内容是否包含指定字符串。

1. 先安装插件：

npm install gulp-contains --save-dev

2. 编写检查任务：

var gulp = require('gulp');
var contains = require('gulp-contains');

gulp.task('checkTokens', function() {
  return gulp.src('./src/ExampleFileTokens.config')
    .pipe(contains({
      search: '#{String}#', // 指定要检查的令牌
      onFound: function(string, file, cb) {
        console.log(`✅ 文件 ${file.path} 中找到令牌：${string}`);
        cb();
      },
      onNotFound: function(string, file, cb) {
        console.warn(`⚠️ 文件 ${file.path} 中未找到令牌：${string}`);
        // 若要终止任务，取消下面注释：
        // cb(new Error(`文件 ${file.path} 缺失必要令牌：${string}`));
      }
    }));
});

小提示 #

• 如果需要检查多个令牌，可以在自定义函数里扩展逻辑，比如传入一个令牌数组，循环检查每个令牌是否存在。
• 若要在令牌缺失时强制终止Gulp流程，只需要在对应回调里抛出错误或者调用cb(new Error(...))即可。

内容的提问来源于stack exchange，提问作者Alexandre Fernandes Bartolomeu