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.109.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.109-py3-none-any.whl (355.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projen_modules-1.2.109.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.109.tar.gz
Algorithm Hash digest
SHA256 f9e49aedea2c948c9d9a965868f06f147d5a6b748cd59d17416f91ee0ac27044
MD5 a9425dcca31583f23b0395c7cabd826e
BLAKE2b-256 1a2a6b7ed9c5f116626000bf7b7d7c2ad58644ce1e5d792f3adf1d04bdc426e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for projen_modules-1.2.109.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.109-py3-none-any.whl.

File metadata

File hashes

Hashes for projen_modules-1.2.109-py3-none-any.whl
Algorithm Hash digest
SHA256 d6bbfdf79cc7257dd487370f4e61cdced7f356dac59e979ab76a1c141e38a630
MD5 a2b24fddf6c3c0f7d09034c42c0197b8
BLAKE2b-256 c0ac90732afa8dab462e08f66c4ff78b485a978a19f0865819d54e1e010bd6c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for projen_modules-1.2.109-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