如何在带共享文件夹的Firebase Functions中使用绝对导入？

问题根源 #

1. TypeScript的paths仅为编译时路径映射，编译后不会自动转换为Node.js可识别的相对路径，运行时无法解析@common这类别名。
2. Firebase部署默认仅上传functions目录内的文件，外部的common目录不会被包含到部署包中，导致运行时找不到模块。

可行解决方案 #

方案一：用tsconfig-paths处理运行时路径映射 #

1. 在functions目录安装依赖：

   npm install tsconfig-paths --save
   

2. 在functions/src/index.ts最顶部添加路径注册代码：

   import * as tsconfigPaths from 'tsconfig-paths';
   import * as path from 'path';
   
   // 编译后代码在lib目录，baseUrl指向lib，tsconfig.json在上级目录
   const baseUrl = path.join(__dirname, './');
   const tsConfig = require('../tsconfig.json');
   
   tsconfigPaths.register({
     baseUrl,
     paths: tsConfig.compilerOptions.paths
   });
   

3. 重新执行部署流程，tsconfig-paths会在运行时将@common别名映射到实际路径。

方案二：预部署时复制common目录到functions/lib #

1. 修改functions/predeploy.js，添加复制common目录的逻辑（需先安装fs-extra：npm install fs-extra --save-dev）：

   const fs = require('fs-extra');
   const path = require('path');
   
   async function copyCommonFiles() {
     try {
       const sourceDir = path.join(__dirname, '../common/src');
       const targetDir = path.join(__dirname, './lib/common');
       await fs.copy(sourceDir, targetDir);
       console.log('Common目录已成功复制到lib');
     } catch (err) {
       console.error('复制Common目录失败:', err);
       process.exit(1);
     }
   }
   
   copyCommonFiles();
   

2. 更新functions/tsconfig.json的paths配置，让编译后的代码指向lib内的common：

   "paths": {
     "@functions/*": ["./src/*"],
     "@common/*": ["./lib/common/*"]
   }
   

3. 确保firebase.json的ignore列表没有排除lib/common目录，部署时该目录会被打包上传。

方案三：将common作为本地npm包 #

1. 在common目录初始化package.json：

   cd common && npm init -y
   

   编辑common/package.json，设置name为自定义包名（比如@your-project/common）。
2. 在functions目录安装这个本地包：

   npm install ../common
   

3. 修改functions/tsconfig.json的paths：

   "paths": {
     "@functions/*": ["./src/*"],
     "@common/*": ["./node_modules/@your-project/common/src/*"]
   }
   

4. 部署时，npm会自动将common包的内容打包到functions/node_modules中，Node.js可直接通过别名找到模块。

内容的提问来源于stack exchange，提问作者Felipe César