如何将包含本地依赖的TypeScript Node.js复合项目Docker化

本地依赖解析方案 #

你可以直接将package.json中原file:协议的本地依赖，替换为对应的GitHub私有仓库引用，无需依赖本地文件路径，示例配置如下：

"dependencies": {
    "local1-dep1": "github:你的组织名/local1-dep1#版本标签或commit哈希",
    "local2-dep2": "github:你的组织名/local2-dep2#版本标签或commit哈希"
}

私有仓库的访问权限可通过构建参数传入GitHub个人访问令牌实现，无需将令牌硬编码到项目配置中。

标准多阶段构建实践（满足体积控制要求） #

采用多阶段构建方式，将编译构建和运行环境拆分，最终镜像仅保留必要的运行时产物，不会携带源码、本地依赖源码、完整node_modules或构建工具：

# 第一阶段：构建编译阶段
FROM node:18-alpine AS builder
# 传入GitHub私有仓库访问令牌
ARG GITHUB_TOKEN
# 配置npm私有源认证
RUN npm config set //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN} \
    && npm config set @你的组织名:registry=https://npm.pkg.github.com

WORKDIR /app
# 优先拷贝依赖锁文件，利用Docker层缓存避免每次修改代码都重新安装依赖
COPY package*.json ./
# 仅安装生产依赖，跳过开发依赖，减少不必要的依赖安装
RUN npm ci --only=production
# 拷贝项目源码完成TypeScript编译
COPY . .
RUN npm run build

# 第二阶段：运行阶段
# 选用极小的distroless Node.js镜像作为运行时基础，镜像体积远小于普通Node镜像
FROM gcr.io/distroless/nodejs18-debian11 AS runner
WORKDIR /app
# 仅从构建阶段拷贝编译后的产物，无需拷贝node_modules、源码等冗余文件
COPY --from=builder /app/dist ./dist
COPY --from=builder /app/package.json ./

# 启动服务
CMD ["dist/index.js"]

关键注意事项 #

• 构建镜像时执行docker build --build-arg GITHUB_TOKEN=你的个人访问令牌 .传入认证信息，令牌仅在构建阶段生效，不会留存到最终的运行镜像中，无泄露风险
• 如果你的项目未做单文件打包，运行时仍需依赖node_modules，可以在运行阶段增加一行COPY --from=builder /app/node_modules ./node_modules，由于构建阶段仅安装了生产依赖，node_modules体积已经经过裁剪，不会过度增大镜像体积
• 如果你暂时不想将本地依赖替换为私有仓库引用，也可以调整Docker构建上下文，将所有关联的本地依赖目录都纳入构建上下文，在构建阶段统一拷贝后安装依赖，该方案适合本地依赖都在同个父目录下的场景

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