@berenddeboer/nx-aws-cdk (英语)

用于开发的自导出 Nx 插件 aws-cdk (英语) 应用程序。 。 。 .

目录

• 安装
• 使用量
  • 生成应用程序
  • 目标
• 维护者
• 捐款
• 许可证

安装

npm install --save-dev @berenddeboer/nx-aws-cdk

pnpm i --save-dev @berenddeboer/nx-aws-cdk

yarn add --dev @berenddeboer/nx-aws-cdk

bun add -D @berenddeboer/nx-aws-cdk

使用量

插件

此软件包使用 推断 目标 (任务). 任何项目 带有 cdk.json 在其根会创建适当的 cdk 目标 为了那个计划.

您可以在插件中配置默认目标名称 :

{
  "plugin": "@berenddeboer/nx-aws-cdk/plugin",
  "options": {
    "cdkTargetName": "cdk",
    "synthTargetName": "synth",
    "deployTargetName": "deploy",
    "diffTargetName": "diff",
    "rollbackTargetName": "rollback",
    "watchTargetName": "watch",
    "destroyTargetName": "destroy"
  }
},

如果您不想自动生成目标, 请删除目标 .

不需要再使用执行器了 但你还可以使用 对于非受罪目标.

使用 cdk 目标轻松运行任何 cdk 命令 :

npx nx run my-stack:cdk diff ...

生成 CDK 应用程序

生成一个 AWS CDK v2 (英语) 应用数字 :

npx nx generate @berenddeboer/nx-aws-cdk:application --directory=stacks/cdk-app --name=cdk-app

目前没有指定单位试跑者. 此崩溃 nx 表示 但原因不详.

您可以通过这些选项来进一步定制 :

nx generate @berenddeboer/nx-aws-cdk:application [directory] [options,...]

Options:
    --directory                  The directory of the new                          [string]
                                 application.
    --name                       The name of the application.                      [string]
    --linter                     The tool to use for running   [string] [choices: "eslint",
                                 lint checks.                     "none"] [default: "none"]
    --setParserOptionsProject    Whether or not to configure                      [boolean]
                                 the ESLint
                                 `parserOptions.project`
                                 option. We do not do this by
                                 default for lint performance
                                 reasons.
    --tags                       Add tags to the project (used                     [string]
                                 for linting)
    --unitTestRunner             Test runner to use for unit     [string] [choices: "jest",
                                 tests.                         "vitest", "none"] [default:
                                                                                    "none"]
    --useProjectJson             Use a `project.json`                             [boolean]
                                 configuration file instead of
                                 inlining the Nx configuration
                                 in the `package.json` file.
    --skipFormat                 Skip formatting files.                           [boolean]
    --skipPackageJson            Do not add dependencies to                       [boolean]
                                 `package.json`.

目标

被生成的应用程序向CLI暴露出允许用户部署,破坏等几种功能.

nx deploy myApp
nx destroy myApp

我们推断出最常见的Cdk命令. 使用执行器访问 到所有 CDK 命令.

捐款

见 贡献文件来啊!

公关接受.

如果编辑 README, 请遵守 标准读取 规格.

许可证

这个项目获得了麻省理工学院的许可.