如何将CDK TypeScript项目发布至NPM并实现安装后部署

核心问题 #

你定义在CDK项目package.json里的mycustomscriptname脚本，只会存在于node_modules/my-project下的package.json中，不会自动同步到安装该包的项目根目录package.json，所以直接跑npm run mycustomscriptname会找不到命令。

解决方案 #

方案1：让用户通过npx直接调用包内脚本 #

不需要修改发布包的核心配置，用户安装后可直接用npx mycustomscriptname执行部署。但需先在你的CDK项目package.json里添加bin字段，把脚本映射为可执行命令：

{
  "name": "my-project",
  "version": "0.0.1",
  "scripts": {
    "mycustomscriptname": "cdk deploy"
  },
  "bin": {
    "mycustomscriptname": "./deploy-script.js"
  }
}

同时创建deploy-script.js文件，用于触发cdk deploy：

#!/usr/bin/env node
const { execSync } = require('child_process');
execSync('cdk deploy', { stdio: 'inherit' });

Linux/macOS环境下需给该脚本添加可执行权限：chmod +x deploy-script.js，之后重新发布包。用户安装后就能直接通过npx mycustomscriptname完成部署。

方案2：通过postinstall脚本自动添加命令到用户的package.json #

在你的CDK项目package.json里添加postinstall脚本，自动将部署命令写入用户项目根目录的package.json：

{
  "scripts": {
    "mycustomscriptname": "cdk deploy",
    "postinstall": "node ./add-root-script.js"
  }
}

创建add-root-script.js脚本，内容如下：

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

// 定位用户项目根目录的package.json
const rootPackagePath = path.join(process.cwd(), 'package.json');
const rootPackage = require(rootPackagePath);

// 添加自定义部署脚本，注意指向CDK编译后的入口文件
rootPackage.scripts = rootPackage.scripts || {};
rootPackage.scripts.mycustomscriptname = 'cdk deploy --app "node node_modules/my-project/lib/app.js"';

// 写回修改后的package.json
fs.writeFileSync(rootPackagePath, JSON.stringify(rootPackage, null, 2));

发布后，用户安装包时会自动在根package.json添加mycustomscriptname脚本，之后就能用npm run mycustomscriptname执行部署。

方案3：提供使用文档，让用户手动添加脚本 #

如果不想自动修改用户的package.json，可以在包的README里说明手动配置方式：
让用户在自己的package.json中添加：

{
  "scripts": {
    "mycustomscriptname": "cdk deploy --app \"node node_modules/my-project/lib/app.js\""
  }
}

用户安装包后手动配置，即可正常执行部署命令。

注意事项 #

• 发布CDK项目前，必须先编译TypeScript到JavaScript（通常执行npm run build生成lib目录），并在package.json的files字段中包含lib目录及必要脚本文件，避免发布时遗漏：

{
  "files": [
    "lib",
    "add-root-script.js",
    "deploy-script.js"
  ]
}

• 确保CDK项目的核心依赖（如aws-cdk-lib、constructs）放在dependencies字段而非devDependencies，这样用户安装包时会自动拉取这些依赖。

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