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.77.tar.gz (340.4 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.77-py3-none-any.whl (338.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projen_modules-1.2.77.tar.gz
  • Upload date:
  • Size: 340.4 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.77.tar.gz
Algorithm Hash digest
SHA256 f0976b6d3ef960e2a85deed34667fcee24fa1d6f9e97a4f0a58f137d459f62cf
MD5 e4cb0a65d52d16aee16fb024b60645ae
BLAKE2b-256 df43a995c6e8199bc8f8949277f4025ca983abf20b7d015f22ac9be991d509dc

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for projen_modules-1.2.77-py3-none-any.whl
Algorithm Hash digest
SHA256 de4aa1094585916c1a94a66b37e08fbdab90a9c78069bf568070c14e2bcbbe06
MD5 8d9fbd1df86b6bd35ea0913c27f8a347
BLAKE2b-256 b81e70e9ad42fadd06d9c7b2234ea1ecf0ed9f00dcead6acc3e43e290b581e1e

See more details on using hashes here.

Provenance

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