@infra-blocks/lib-template NPM

ts-lib-template

This repository is a template to generate repositories meant to hold the source code of NPM packages written in TypeScript.

Follow these steps after instantiating the template:

Remove the trigger update from template workflow
Update the .nvmrc version file to latest
Update the package.json
- Rename the package name and links
- Update the engines section
Update the dependencies
Run nvm install
Run npm install
Run npm run compile && npm run lint && npm run test
Edit the .npmrc file if you wish to change the defaults. Specifically, if you wish to make your package private.
Rename the header of this document to match the repository
Replace this section of this document to include a description of the new package
Configure code coverage

Development

Repo init

This repository leverages nvm and users should have it installed in their local environment. In addition, it is recommended that users install a shell hook so that nvm use is run upon changing into a project that utilises nvm.

Upon checking out the repository, run the following commands:

nvm install
npm install
npm run compile
npm run lint
npm run test

Package publication

This package leverages the npm-publish-from-label action as a turnkey, automated mechanism for publishing packages. Refer to its documentation to understand its capabilities.