Gulp技术问题：如何自动获取到项目根目录的相对路径深度？

我刚好碰到过一模一样的场景——主题文件夹嵌套层级不固定，手动算相对路径太容易出错。用Node.js的fs和path内置模块就能完美解决，不需要额外装插件，直接在你的主题gulpfile.js里加这段代码就行：

const fs = require('fs');
const path = require('path');

// 递归向上查找包含config.json的项目根目录
function findProjectRoot(currentDir) {
  const configPath = path.join(currentDir, 'config.json');
  if (fs.existsSync(configPath)) {
    return currentDir;
  }
  const parentDir = path.dirname(currentDir);
  // 防止无限递归，到系统根目录就停止
  if (parentDir === currentDir) {
    throw new Error('找不到项目根目录：未发现config.json文件');
  }
  return findProjectRoot(parentDir);
}

// 当前gulpfile所在的绝对路径
const gulpfileDir = __dirname;
// 获取项目根目录的绝对路径
const projectRoot = findProjectRoot(gulpfileDir);
// 计算从gulpfile目录到根目录的相对路径
const relativeToRoot = path.relative(gulpfileDir, projectRoot);

// 测试输出：比如会打印出 "../../../../../../" 这类路径
console.log('到项目根目录的相对路径：', relativeToRoot);

代码说明： #

• __dirname是Node.js的内置变量，永远指向当前gulpfile.js所在的绝对目录，不管你在哪个目录执行gulp命令，这个值都是准确的，这是整个方案的核心。
• findProjectRoot函数会从当前目录开始，一层一层往上找，直到找到包含config.json的目录——也就是你的项目根目录，完全不用手动指定层级。
• path.relative(from, to)是Node.js的内置方法，会自动生成从from到to的标准相对路径，格式完全符合Gulp插件对相对路径的要求。

实际使用示例： #

比如你要在gulp任务里引用根目录core下的文件，直接用这个相对路径拼接就行：

// 引用core目录下的工具模块
const coreUtils = require(path.join(relativeToRoot, 'core', 'utils.js'));

// 或者在gulp的src/dest路径里使用
gulp.task('copy-core-assets', function() {
  return gulp.src(path.join(relativeToRoot, 'core', 'assets', '**/*'))
    .pipe(gulp.dest('./theme-assets/core'));
});

这个方案的好处是不管你的主题文件夹嵌套多深，哪怕以后新增更深层级的主题，代码都不需要修改，完全自动化适配。

内容的提问来源于stack exchange，提问作者vlasterx