如何在CommonJS环境下使用Octokit且无需设置Node16模块解析

问题分析 #

• 直接用import {App} from "@octokit/app"部署时报错，本质是@octokit/app为ESM模块，而你的Firebase Functions编译为CommonJS，require()无法加载ESM模块。
• 从octokit包导入时的类型错误，是因为当前moduleResolution设置不兼容octokit的类型解析逻辑。

可行解决方案 #

方案1：使用动态import()（推荐） #

CommonJS模块原生支持动态import()，Firebase Functions也兼容异步函数，直接在函数逻辑内动态加载即可：

// 示例Firebase函数
exports.githubWebhookHandler = async (req, res) => {
  // 动态导入@octokit/app
  const { App } = await import("@octokit/app");
  
  // 初始化App实例
  const app = new App({
    appId: "你的应用ID",
    privateKey: "你的私钥"
  });
  
  // 后续业务逻辑
  // ...
  
  res.status(200).send("处理完成");
};

如果用TypeScript，只需确保tsconfig.json的target设为ES2020或更高（支持异步导入），无需修改module和moduleResolution为Node16。

方案2：安装兼容CommonJS的旧版本 #

如果不想用动态导入，可以安装@octokit/app的v10.x及以下版本（这类版本同时支持CommonJS和ESM）：

npm install @octokit/app@10.x

安装后直接用CommonJS语法导入：

const { App } = require("@octokit/app");

注意旧版本可能缺少新特性，需根据业务需求权衡。

类型错误的临时处理 #

如果用TypeScript遇到类型解析问题：

• 单条导入语句可添加// @ts-ignore忽略类型检查：

  // @ts-ignore
  const { App } = await import("@octokit/app");
  

• 或在tsconfig.json中设置skipLibCheck: true，跳过所有第三方库的类型检查（不推荐长期使用，可能隐藏其他类型问题）。

兼容性说明 #

Octokit最新版本虽偏向ESM，但通过动态导入或旧版本，完全可以在CommonJS环境的Firebase Functions中正常使用，无需强制升级moduleResolution设置。

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