Source of @absaoss-cps/ngx-ui-watchtower,
a telemetry library for Angular apps: scenarios (user end-to-end journeys or specific functional workflows through an app), BI events and
logs, with an optional AWS CloudWatch RUM sink.
How to use the library: projects/ngx-ui-watchtower/README.md (also the npm page). How it is designed: projects/ngx-ui-watchtower/DESIGN.md.
projects/ngx-ui-watchtower/
src/ main entry point — @absaoss-cps/ngx-ui-watchtower
rum/ secondary entry point — @absaoss-cps/ngx-ui-watchtower/rum
README.md usage guide, published to npm
DESIGN.md full design
package.json the published package's manifest
Requires Node.js 22 or later.
npm install
npm run test
npm run buildThe package is built to dist/ngx-ui-watchtower.
| Script | What it does |
|---|---|
npm run build |
Builds the package (production, partial compilation) |
npm run watch |
Rebuilds on change (development) |
npm run test |
Runs the unit tests (Jest) |
npm run test:coverage |
Runs the unit tests with coverage, as CI does |
npm run typecheck |
Type-checks every library and spec tsconfig |
npm run lint |
ESLint, no warnings allowed |
npm run format |
Formats with Prettier |
npm run format:check |
Checks formatting without writing |
Run all of them — each catches something the others don't:
npm run test
npm run typecheck
npm run lint
npm run format:check
npm run buildCI runs the same checks on every pull request and every push to main.
PR titles must follow Conventional Commits,
for example feat: add scenario timeout option or fix: flush logs on page hide.
Allowed types: feat, fix, docs, style, refactor, perf, test,
build, ci, chore, revert. A check enforces it; the ignore-cc-check
label skips it.
Squash-merge pull requests: the title then becomes the commit message on
main, and releases are built from those messages.
Releases are automated with release-please — don't publish by hand.
- Every push to
mainupdates a release PR.featbumps the minor version,fix,perfandrevertthe patch; until 1.0, a breaking change bumps the minor. Other types don't trigger a release. - The release PR holds the version bump and the
CHANGELOG.mdentry. - Merging it tags the release, creates the GitHub release and publishes the package to npm from GitHub Actions through trusted publishing — no npm token.
Apache License 2.0.