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.75.tar.gz (340.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.75-py3-none-any.whl (338.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projen_modules-1.2.75.tar.gz
  • Upload date:
  • Size: 340.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.75.tar.gz
Algorithm Hash digest
SHA256 93f10d7eb41b1196021fa61c93015635345ed649fcc6e467bd15b7d1b412c5dd
MD5 af2f54565ea8c1160e705b8af94a0aae
BLAKE2b-256 58294786f3fbecde4a2824affd05162bf7c7ccd3df311caddcf46ee541c1ec84

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for projen_modules-1.2.75-py3-none-any.whl
Algorithm Hash digest
SHA256 64783ac0a4193c20f4a0a84b95da21c8763ca13cfed09a5359dd051f3d43bd5a
MD5 45849b3edc61a3553ab3ae0e53df9fa9
BLAKE2b-256 adb21483142040b6fdd458084ca6546cc27d81dd47fd95b430ee8f9fd8b7f8fb

See more details on using hashes here.

Provenance

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