@carlo-finance/tax-engine
v0.1.41
Published
Tax calculation engine for personal financial planning
Downloads
4,519
Readme
@carlo-finance/tax-engine
Tax calculation engine for personal financial planning.
Built with Effect — a TypeScript framework for composable, type-safe programs.
Status
Pre-release. Do not depend on this package yet.
How it's shaped
ARCHITECTURE.md — the three-layer chain (model → accounting → engine), the engine's internal subsystem map, the public API contract, and pointers into the specs.
docs/MODULE-AUTHORING.md — the recipe for adding a rule module with metadata, parameter bindings, diagnostics, provenance, tests, fixtures, ADRs, and changesets.
Install
pnpm add @carlo-finance/tax-engineDevelop
pnpm install
pnpm test # vitest, watch mode
pnpm check # typecheck (no emit)
pnpm lint # eslint
pnpm build # ESM + CJS to ./distRun a TypeScript file directly via tsx:
pnpm tsx ./path/to/file.tsReleasing
Versioning and publishing are managed by Changesets.
- After a code change, run
pnpm changesetand answer the prompts to record a changelog entry + bump type. - Commit the generated
.changeset/*.mdfile alongside your change. - Merging to
maintriggers.github/workflows/release.yml, which either opens a "Version Packages" PR or — once that PR is merged — publishes to npm.
