如何为单个Firebase二代函数配置差异化ignore部署规则？

问题背景 #

我们有多个共享同一源码的二代Firebase Functions，仅其中一个函数需要特殊配置ignore规则：该函数必须包含约2MB的bin文件夹，其余函数都需要忽略这个文件夹。当前firebase.json的基础配置如下：

"functions": [{
  ... ...,
  "ignore": [
    "node_modules",
    "firebase-debug.log",
    ... ...,
    "bin"   // <==== 仅针对特定函数移除此行
  ]
}]

已尝试的方案及问题 #

• 尝试配置不同的functions[].codebase（如'code2'），执行firebase deploy --only functions:code2:myBinFunction，但因两个配置块的source指向同一文件夹，触发报错：Error: functions.source must be unique but './functions' was used more than once.
• 不想拆分源码文件夹，因为函数共享大量公共代码，拆分后会显著增加维护成本；同时必须确保：需要包含bin的函数如果缺失该文件夹则部署失败，避免团队成员误操作。
• 补充：将一个配置块的source设为'functions'，另一个设为'./functions'可解决部署报错，但仍需实现部署前的校验逻辑，防止误部署。

可行解决方案 #

方案1：双codebase配置+预部署校验（推荐） #

1. 调整firebase.json配置

添加两个functions配置块，分别对应普通函数和需要包含bin的函数，通过不同写法的source路径绕过唯一性校验，同时配置不同的ignore规则和codebase：

{
  "functions": [
    {
      "codebase": "default",
      "source": "functions",
      "ignore": [
        "node_modules",
        "firebase-debug.log",
        ...,
        "bin"
      ]
    },
    {
      "codebase": "with-bin",
      "source": "./functions",
      "ignore": [
        "node_modules",
        "firebase-debug.log",
        ...
        // 移除"bin"条目，让该codebase部署时包含bin文件夹
      ]
    }
  ]
}

2. 编写预部署校验脚本

在项目根目录创建scripts/check-bin.js脚本，用于校验部署条件：

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

// 检查bin文件夹是否存在（针对with-bin codebase部署）
const binDirPath = path.join(__dirname, '../functions/bin');
const targetCodebase = process.env.TARGET_CODEBASE;

if (targetCodebase === 'with-bin') {
  if (!fs.existsSync(binDirPath)) {
    console.error('❌ 部署失败：需要包含bin文件夹的函数缺失该目录！');
    process.exit(1);
  }
}

// 可选：校验default codebase部署时不会误带bin（可根据需求开启强制阻止）
if (targetCodebase === 'default' && fs.existsSync(binDirPath)) {
  console.warn('⚠️ 注意：default codebase部署会自动忽略bin文件夹，当前配置正常');
  // 若要强制阻止，替换为：process.exit(1);
}

console.log('✅ 部署校验通过');

3. 配置npm部署脚本

在项目的package.json中添加标准化部署脚本，让团队成员通过脚本执行部署：

{
  "scripts": {
    "deploy-with-bin": "TARGET_CODEBASE=with-bin node scripts/check-bin.js && firebase deploy --only functions:with-bin:myBinFunction",
    "deploy-default": "TARGET_CODEBASE=default node scripts/check-bin.js && firebase deploy --only functions:default:*"
  }
}

4. 团队部署规范

要求所有成员通过以下命令部署：

• 部署需要包含bin的函数：npm run deploy-with-bin
• 部署其他普通函数：npm run deploy-default

这样既实现了不同函数的ignore规则差异，又通过校验脚本杜绝了误部署的可能。

方案2：环境变量动态控制ignore规则（轻量替代） #

如果不想维护双codebase，可通过环境变量动态调整ignore规则：

1. 修改firebase.json中的ignore规则，使用环境变量占位：

"functions": [{
  "source": "functions",
  "ignore": [
    "node_modules",
    "firebase-debug.log",
    ...,
    "${IGNORE_BIN:-bin}"
  ]
}]

2. 添加npm部署脚本，通过环境变量控制是否忽略bin：

{
  "scripts": {
    "deploy-with-bin": "IGNORE_BIN='' node scripts/check-bin.js && firebase deploy --only functions:myBinFunction",
    "deploy-default": "firebase deploy --only functions:*",
    "check-bin": "node scripts/check-bin.js"
  }
}

此方案无需双codebase，但依赖团队严格使用指定脚本部署，否则可能出现配置错误。

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