Skip to main content

projen-modules

A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.

Getting Started

Prerequisites:

  • Node.js 22
  • Yarn 1 (classic)
yarn install
npx projen build

This will:

  • Install the dependencies
  • Apply any projen changes
  • Run tests
  • Package project locally

Any files changed by projen should be committed to git.

Running the tests like this will update any snapshot files, this should be reviewed and committed to git.

Testing

Types of testing:

  • Snapshot - projen project outputs are stored as a snapshot in the corresponding __snapshots__ directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
  • Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.

Creating a New Project

npx projen new {project} --from projen-modules

Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.

Project Types

Project type Description
cdk-typescript-app A typescript CDK app
npm-package A typescript npm package
python-package A python package
jsii-package A typescript JSII package

Project Structure

All source is located in src and is grouped by:

  • components - these are common building blocks that can be used by projects to implement specific project functionality.
  • projects - these are projects that can be built from this project (see #something)
  • utils - these are helper functions that are often reused

test contains tests, and mirrors the src directory structure. Within here there are __snapshots__ which contain snapshots of project tests (see #section).

Contributing

Pull request titles must follow Conventional Commits, with one of the types feat, fix or chore, such as feat: describe the change. The Validate PR title check fails until the title does.

Once a pull request is approved, or is opened by daveshepherd, and its checks pass, the Mergify merge queue squash merges it, with its title as the commit message. Draft pull requests and those labelled do-not-merge are not merged.

The type decides the next release: feat releases a minor version and fix a patch version, while a breaking change, marked by ! after the type (such as feat!: ...) or a BREAKING CHANGE: footer, releases a major version. Other types still release a patch version. While the version is below 1.0.0, a breaking change releases a minor version and feat a patch version.

GitHub Configuration

The one-off configuration that this repository needs on GitHub, such as the Mergify merge queue and the branch ruleset, is described in docs/github-configuration.md.

Known Issues

cdk-typescript-app defaults to Jest 30, which hoists @sinonjs/fake-timers 15 whose bundled types conflict with the @types/sinon used by aws-sdk-client-mock. Projects using aws-sdk-client-mock can set compilerOptions.skipLibCheck on the test tsconfig:

project.tryFindObjectFile('test/tsconfig.json')?.addOverride('compilerOptions.skipLibCheck', true);

Metadata

Release files for projen-modules 5.7.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for projen-modules 5.7.7
File Size Uploaded Provenance
projen_modules-5.7.7.tar.gz 441.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for projen-modules 5.7.7
File Interpreter ABI Platform
projen_modules-5.7.7-py3-none-any.whl Python 3 none any Details

Total release size: 881.6 kB

Release files / projen_modules-5.7.7.tar.gz

Download URL projen_modules-5.7.7.tar.gz
Size 441.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2d65b9f26546c0914fa005b7929bbe2e00b939fb704a0bccde6ace4ca41d7d38
BLAKE2b-256 checksum
How to use checksums
f446ed62431314a13866007d8b8e2957cc1294288fad1c8437d5bbee1f96f2ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.15.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Release files / projen_modules-5.7.7-py3-none-any.whl

Download URL projen_modules-5.7.7-py3-none-any.whl
Size 440.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
72358ad8a6dda63800229122423b9460883c626c0675635dd325b80a8e65cce7
BLAKE2b-256 checksum
How to use checksums
4725d9257eeb1428aeb71aa401a2f20f98af7b0104999fa8ad88e0e54bba0f89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.15.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Security for projen-modules 5.7.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for projen_modules-5.7.7.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.7.7 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page