@triangulum/tng-router

Type-safe, signal-based routing primitives for Angular.

Installation

npm install @triangulum/tng-router

Building

To build the library, run:

ng build tng-router

This command will compile the project, and the build artifacts will be placed in the dist/tng-router directory.

Publishing the Library

Publishing is automated via GitHub Actions. To cut a release:

1. Bump the version in projects/tng-router/package.json.
2. Commit and push to main.
3. Create a GitHub Release (or push a v<version> tag, e.g. v0.0.1) whose version matches package.json.

The Publish workflow builds dist/tng-router and runs npm publish --access public to the public npm registry using the NPM_TOKEN secret. The tag/release version must match package.json or the workflow fails.

Both the CI and Publish workflows run inside the repository's .devcontainer (via the devcontainers/ci action), so the artifact is built and tested in the exact same environment used for development.

To publish manually instead:

ng build tng-router
cd dist/tng-router
npm publish --access public

Running unit tests

To execute unit tests with the Karma test runner, use the following command:

ng test

Running end-to-end tests

For end-to-end (e2e) testing, run:

ng e2e

Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.

Additional Resources

For more information on using the Angular CLI, including detailed command references, visit the Angular CLI Overview and Command Reference page.