@gemeentenijmegen/projen-project-type

中文文档
1.16.4发布于 2026/11/04EUPL-1.2TypeScriptCommonJS零依赖构建来源已验证近 30 天下载 3163

This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.

原始使用文档
文档目录10 节
  1. Github secrets
  2. Using this project type
  3. For new projects
  4. For existing projects
  5. Properties overview
  6. Upgrade dependencies
  7. Automerge workflow
  8. CDK upgrade
  9. Projen upgrade
  10. Local testing

GemeenteNijmegen projen project type

This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.

The project type GemeenteNijmegenCdkApp provides a number of default configurations and provides features used within our organization. There are:

  • Comments with CloudFormation template diffs on PRs
  • Cfn-lint Github wrokflow
  • Defautl configuration values

Github secrets

This project type relies on Github secrets to be set in order for all its Github workflows to work.

Environment variableExplanation
GITHUB_PROJEN_TOKENProjen Github personal access token
SLACK_WEBHOOK_URLThis is the url used for the emergency workflow to publish to slack

Using this project type

For new projects

npx projen new --from @gemeentenijmegen/projen-project-type {type}

The following project types can be used:

  • cdk-app standard CDK project
  • cdk-lib standard CDK construct library (published to NPM by default)
  • jsii-lib a JSII application (published to NPM by default)
  • ts-lib a typescript project (published to NPM by default)
  • ts-app a typescript project without publishing or cdk

Adding sample files to a cdk-app can be done with

npx projen new --from @gemeentenijmegen/projen-project-type cdk-app --makeSampleFiles

For existing projects

For instructions on how to start using the project type in existing projects there is the setup guide. Note: for switching back to the awscdk-app-ts projen project type also see the setup guide.

Properties overview

There are a number of relevant properties that are provided by projen

PropertyDefaultExplanation
cdkVersion'2.1.0'Minimum version of the cdk to use (upgraded using projen upgrade task)
defaultReleaseBranch'main'Should be set to acceptance
nameproject nameSets the project name
gitignoreA number of default ignored files are set specific to our projects
scriptsThe cfn-lint script is added to the list of scripts configured
licenseEUPL-1.2The defult license used by us
depsUpgradeOptionsUpgrade workflow configuration (branch: acceptance, labels: cfn-diff)

The project type in this npm package provides some additional configuration options:

PropertyDefaultExplanation
enableCfnLintOnGithubtrueEnable step in the Github build workflow that runs cfn-lint
enableEmergencyProceduretrueAdds the emergency procedure workflow to Github workflows
enableAutoMergeDependenciestrueAdds the auto-merge workflow for PR's to acceptance (from upgrade workflow)

Upgrade dependencies

De upgrade dependencies task en Github workflow zijn standaard enabled. Deze task zal de laatste versies van de dependencies zoeken (volgens semantic versionioning) en upgraden in de package.json.

Dit project type zet de default branch voor het uitvoeren van de workflow op acceptance. De Github workflow voert de upgrade dependencies taak uit en maakt een PR naar acceptance en geeft het PR een label cfn-diff en auto-merge.

Automerge workflow

De automerge workflow gaat af als een PR acceptance als base heeft en het label auto-merge heeft. Deze probeert het PR te mergen met de auto-merge feature van Github. Hiervoor moet in het Github-project automerge aan staan. NB: Zorg dat branch protection aan staat voor acceptance, met de eis dat aan alle voorwaarden voldaan is. Anders kan de auto-merge worden uitgevoerd voordat de build succesvol is.

CDK upgrade

De upgrade dependencies taak in projen is inclusief de CDK versie. Hiervoor wordt de minimum versie in de .projenrc.js van een project ingesteeld.

Dit betekent dat:

  • Wanneer cdkVersion: '2.1.0 gebruikt wordt in de .projenrc.js dit in de package.json wordt geimporteerd als "aws-cdk-lib": "^2.1.0"
  • Wanneer de upgrade dependencies taak draait de package.json wordt geupdate naar bijv: "aws-cdk-lib": "^2.31.0"
  • Semantic versioning zorgt er voor dat er nooit een major upgrade wordt gedaan omdat deze braking changes kan hebben.

Projen upgrade

De projen versie wordt ook geupgrade in de upgrade dependencies task.

Local testing

One can locally test project creation using this package by running

# Run the extract command on this project
cd /path/to/the/package/modules-projen && npx projen extract

# Create a new test project
mkdir test-project
cd test-project
npx projen new --from file://path/to/the/package/modules-projen/dist/js/package cdk-app

版本与发布记录

@gemeentenijmegen/projen-project-type 共发布 73 个版本,首次发布于 2023/01/02;过去 12 个月发布了 24 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.16.4latest2026/11/0411 天前
1.16.32026/10/2620 天前
1.16.22026/09/301 个月前
1.16.12026/09/082 个月前
1.16.02026/09/032 个月前
1.15.12026/08/272 个月前

关于 @gemeentenijmegen/projen-project-type 的常见问题

@gemeentenijmegen/projen-project-type 是什么?

This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.

如何安装 @gemeentenijmegen/projen-project-type?

在项目目录运行 npm install @gemeentenijmegen/projen-project-type,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:projen(>=0.99.27)、constructs(^10.8.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gemeentenijmegen/projen-project-type 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gemeentenijmegen/projen-project-type 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gemeentenijmegen/projen-project-type 可以商用吗?

@gemeentenijmegen/projen-project-type 使用 EUPL-1.2 许可。声明的许可为 EUPL-1.2,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@gemeentenijmegen/projen-project-type 的下载量有多少?

根据 npm 官方下载统计,@gemeentenijmegen/projen-project-type 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,163 次,日均约 105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gemeentenijmegen/projen-project-type 还在维护吗?

最新版本 1.16.4 发布于 2026/11/04(11 天前);至今共发布 73 个版本,其中过去 12 个月发布了 24 个;首次发布于 2023/01/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。