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.104.tar.gz (357.6 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.104-py3-none-any.whl (355.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projen_modules-1.2.104.tar.gz
  • Upload date:
  • Size: 357.6 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.104.tar.gz
Algorithm Hash digest
SHA256 37b093b1a91fdcc9c033690195f0f2969d8105f8f0c5bedfdfda07e5d5bdd044
MD5 46865de87af0cd78e5df93d5fc60281c
BLAKE2b-256 0ec47e0985fb732cae779f8ffba282d8bfbb6469e7f8a92d2a00880b7900cbf1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for projen_modules-1.2.104-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b9df226b0b8f603ab7008eee732bc39421187140b8a63a2e2e3c58102751eb
MD5 0dc6c4a041a644903ff0087f01af78f0
BLAKE2b-256 be3a02aad2ef2dea1a9e180d558a81519890626376a2a704548615ad1457d92c

See more details on using hashes here.

Provenance

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