projen-utils
This project contains a couple of constructs which are meant
to be used with the projen project. These utilities
extend existing projen constructs to enable easier development
of TypeScript ESM projects/packages as well as handling
pre-commit configuration in projen-managed projects.
Badges
Table of Contents
Installation
Install using npm, yarn, or pnpm (preferred).
pnpm add --save-dev @ncfour-us/projen-utils
Getting Started
Documentation on constructs.dev: @ncfour-us/projen-utils
Project documentation: @ncfour-us/projen-utils
The TypeScriptESMProject supports both "local" and "Github workflow" styles
of build/release handling. (NOTE: "Github workflow" handling is still
under development).
Local build and release processing
With "local" style builds/releases, a project is managed from a user's
workstation terminal interface, using the pnpm build and pnpm release
commands.
Support exists for publishing build artifacts to:
- "local" archive (a folder on the local workstation)
- "npm" package registry (the NPM Package registry)
- "github" creating tagged releases in the associated Github-hosted Git repository
There are some preparatory steps required before publishing to NPM and Github will work.
For publishing to NPM, the package MUST have first been created in NPM by a manual publishing step.
The command to publish to NPM is:
npm publish <file name .tgz file containing the package> --access public
This command will create the package in the NPM registry.
The command to create a Github repository, using the gh GitHub CLI is:
gh repo create ncfour-us/byte-buffer --public --source=. --remote=origin
This command will use the contents of the current folder to create a
Git repository on Github and link the remote repository with name origin.
After creating the repository, use git push to link the main branch
of the local repository to the main branch in GitHub using command:
git push -u origin main
Once these steps are completed, the publish tasks for NPM and GitHub can be enabled by setting:
...
releaseToNpm: true,
releaseToGithub: true
...
in the constructor options of the TypeScriptESMProject project.
When running pnpm release locally, there is a requirement that the user
has active login credentials to both NPM and GitHub. For NPM, 2FA login
is required when running a npm publish. If interactive user
credentials are being used, the user will be prompted to supply their
2FA login info during the publish:npm task processing.
To login to GitHub, use the gh auth login command. Login status
can be checked using the gh auth status command. GitHub login credentials
are used during the publish:github task processing.
Contributing
Fork this repository and submit a PR.
Authors
- Tim Hahn (hahntj@gmail.com, github: @climbertjh)
License
The project is covered by the MIT license, see LICENSE.
Acknowledgements
1 maintainer
Metadata
1 maintainer
Release files for ncfour-us-projen-utils 0.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ncfour_us_projen_utils-0.3.4.tar.gz | 169.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ncfour_us_projen_utils-0.3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 336.6 kB
Release files / ncfour_us_projen_utils-0.3.4.tar.gz
| Download URL | ncfour_us_projen_utils-0.3.4.tar.gz |
|---|---|
| Size | 169.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aa743394254907f19aa2a604193c22e29f99211502377f67cdb9a33a3e1f09e0
|
|
BLAKE2b-256 checksum How to use checksums |
0cb00b808ca607b33c3c4dd220409a10c15a20c74f7e14c4aaa2a816db41613c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.14.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 22, 2026.
Transparency logRelease files / ncfour_us_projen_utils-0.3.4-py3-none-any.whl
| Download URL | ncfour_us_projen_utils-0.3.4-py3-none-any.whl |
|---|---|
| Size | 167.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
43068314622dd88ab7c5949ec2fdbd6de9cd2888ed64574037f9b9fdba095ff3
|
|
BLAKE2b-256 checksum How to use checksums |
2a1c9744fbe877169d9a7bf840e0a9648eaf7c22f11cb97246d8118455392720
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.14.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 22, 2026.
Transparency log
