integration.example-generator
Example plugin: Markdown documentation generator for ContractSpec specs
@lssm-tech/integration.example-generatorbun add @lssm-tech/integration.example-generatorManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Example plugin: Markdown documentation generator for ContractSpec specs.
What It Provides
- Layer: integration.
- Consumers: plugin authors, documentation pipelines.
- Related ContractSpec packages include
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.schema,@lssm-tech/tool.bun,@lssm-tech/tool.typescript. - Related ContractSpec packages include
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.schema,@lssm-tech/tool.bun,@lssm-tech/tool.typescript.
Installation
npm install @lssm-tech/integration.example-generator
or
bun add @lssm-tech/integration.example-generator
Usage
Import the root entrypoint from @lssm-tech/integration.example-generator, or choose a documented subpath when you only need one part of the package surface.
Architecture
src/config.tsis part of the package's public or composition surface.src/generator.tsis part of the package's public or composition surface.src/index.tsis the root public barrel and package entrypoint.src/types.tsis shared public type definitions.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./configresolves through./src/config.ts. - Export
./generatorresolves through./src/generator.ts. - Export
./typesresolves through./src/types.ts.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun run test:watch— bun test --watchbun run test:coverage— bun test --coveragebun run prebuild— contractspec-bun-build prebuild
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
Notes
- Do not add business logic; this is a reference plugin.
- Keep the export surface minimal -- new exports need a clear use-case.
- Peer-depends on
contracts-specandschema; do not bundle them.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
3 declarations
@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗zodcatalog:
@lssm-tech/lib.contracts-integrationsworkspace:^
Read the package manual ↗
Declared capabilities
Example plugin: Markdown documentation generator for ContractSpec specs
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint:fixnode ../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../scripts/biome.cjs check --write .lint:checknode ../../../scripts/biome.cjs check .testbun test --pass-with-no-teststest:watchbun test --watchtest:coveragebun test --coverageprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit