Skip to content
ContractSpec
Start here

Package manual · integrations

·Integrations and provider selection

integration.example-generator

Example plugin: Markdown documentation generator for ContractSpec specs

integrationsintegrationv76.0.5stableservernode
@lssm-tech/integration.example-generator
bun add @lssm-tech/integration.example-generator
Package source ↗Manifest ↗

Manifest 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.ts is part of the package's public or composition surface.
  • src/generator.ts is part of the package's public or composition surface.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/types.ts is shared public type definitions.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./config resolves through ./src/config.ts.
  • Export ./generator resolves through ./src/generator.ts.
  • Export ./types resolves through ./src/types.ts.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test --pass-with-no-tests
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run test:watch — bun test --watch
  • bun run test:coverage — bun test --coverage
  • bun 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-spec and schema; do not bundle them.

Relationships

THIS PACKAGEintegration.example-generator5 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

3 declarations

Declared capabilities

Integration Example Generator

Example plugin: Markdown documentation generator for ContractSpec specs

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint: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-tests
  • test:watchbun test --watch
  • test:coveragebun test --coverage
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit