example.minimal
Minimal reference project demonstrating a complete ContractSpec workflow.
examplesexamplev4.0.4stableservernode
@lssm-tech/example.minimalbun add @lssm-tech/example.minimalManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Minimal ContractSpec example showing the simplest possible contract definition and build.
What This Demonstrates
- Bare-minimum contract definition (user contract).
contractspec buildandcontractspec validateCLI usage.- Maintained example package included in the ContractSpec example registry.
src/contracts/contains contract specs, operations, entities, and registry exports.src/docs/contains docblocks and documentation-facing exports.src/handlers/contains handlers or demo adapters wired to contract surfaces.
Running Locally
From examples/minimal:
bun run buildbun run testbun run typecheckbun run smokebun run preflight
Usage
Use @lssm-tech/example.minimal as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/contracts/contains contract specs, operations, entities, and registry exports.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/handlers/contains handlers or demo adapters wired to contract surfaces.src/index.tsis the root public barrel and package entrypoint.src/minimal.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/minimal.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./minimal.featureresolves through./src/minimal.feature.ts. - Export
./contracts/userresolves through./src/contracts/user.ts.
Local Commands
bun run build— bun ../../packages/apps/cli-contractspec/src/cli.ts build src/contracts/user.tsbun run validate— bun ../../packages/apps/cli-contractspec/src/cli.ts validate src/contracts/user.tsbun run typecheck— tsgo --noEmitbun run test— bun testbun run smoke— bun test src/example.smoke.test.tsbun run preflight— bun run build && bun run typecheck && bun run test && bun run validate && bun run smoke
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
- Stability.
- Missing contract layers.
Notes
- Works alongside
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.schema.
Relationships
THIS PACKAGEexample.minimal6 import paths
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
2 declarations
@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗
Declared capabilities
This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.
Scripts
buildbun x --bun tsc --project tsconfig.jsonscaffoldbun ../../packages/apps/cli-contractspec/src/cli.ts build src/contracts/user.tsvalidatebun ../../packages/apps/cli-contractspec/src/cli.ts validate src/contracts/user.tstypechecktsgo --noEmittestbun testsmokebun test src/example.smoke.test.tspreflightbun run build && bun run typecheck && bun run test && bun run validate && bun run smoke