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

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).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

projen_modules-1.2.112.tar.gz (357.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

projen_modules-1.2.112-py3-none-any.whl (355.5 kB view details)

Uploaded Python 3

File details

Details for the file projen_modules-1.2.112.tar.gz.

File metadata

  • Download URL: projen_modules-1.2.112.tar.gz
  • Upload date:
  • Size: 357.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.14.6

File hashes

Hashes for projen_modules-1.2.112.tar.gz
Algorithm Hash digest
SHA256 fb6bbcba635b63941c7a1adfc1145144a630658035191cecc08998ead7f3c0d3
MD5 4130e1603713dd996e96876dd3470760
BLAKE2b-256 0c163bec5e78e42a17b7c9b7d05e6697427f841805b9cbe363b136873409a827

See more details on using hashes here.

Provenance

The following attestation bundles were made for projen_modules-1.2.112.tar.gz:

Publisher: release.yml on daveshepherd/projen-modules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file projen_modules-1.2.112-py3-none-any.whl.

File metadata

File hashes

Hashes for projen_modules-1.2.112-py3-none-any.whl
Algorithm Hash digest
SHA256 4932afdc408db20099fbf41712d702600786cc0f7a7463aef352a87c1ed448b5
MD5 1cb4f90e828a94228933d01c4152e90a
BLAKE2b-256 480ef42b449a962b2cf371f48446220d1a0d4941cc61eead71dcda8becafc74a

See more details on using hashes here.

Provenance

The following attestation bundles were made for projen_modules-1.2.112-py3-none-any.whl:

Publisher: release.yml on daveshepherd/projen-modules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page