Skip to content
ContractSpec
Start here

Package manual · tools

·CLI, authoring and agent tooling

tool.docs-generator

CLI tool for generating docs artifacts from ContractSpec specs and DocBlocks

toolstoolv5.0.4stableservernode
@lssm-tech/tool.docs-generator
bun add @lssm-tech/tool.docs-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

CLI tool for generating docs artifacts from ContractSpec specs and DocBlocks.

What It Provides

  • Layer: tool.
  • Consumers: docs pipeline (bun run docs:generate), CI.
  • Related ContractSpec packages include @lssm-tech/lib.contracts-spec, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.
  • Related ContractSpec packages include @lssm-tech/lib.contracts-spec, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Installation

npm install @lssm-tech/tool.docs-generator

or

bun add @lssm-tech/tool.docs-generator

Usage

bash
npx contractspec-docs --help
# or
bunx contractspec-docs --help

Architecture

  • src/fs.ts is part of the package's public or composition surface.
  • src/generate.ts is part of the package's public or composition surface.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/markdown.test.ts is part of the package's public or composition surface.
  • src/markdown.ts is part of the package's public or composition surface.
  • src/types.ts is shared public type definitions.

Public Entry Points

  • Binary contractspec-docs points to ./dist/index.js.
  • Export . resolves through ./src/index.ts.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test
  • 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 docs:generate — bun src/index.ts generate --source "../../../generated/docs" --out "../../../packages/bundles/library/src/components/docs/generated" --content-root "../../../generated/docs"
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.

Notes

  • DocBlock IDs keep their identity and routes. Generated content paths replace dots with directory separators and colons with hyphens so namespaced IDs such as doc:sop.generation-sources can be checked out on Windows.
  • Output paths are configured via CLI flags -- do not hard-code destination directories.
  • Depends on @lssm-tech/lib.contracts-spec for spec parsing -- changes there may require updates here.
  • The docs:generate script references relative paths to generated/docs and the library bundle; verify paths if the monorepo structure changes.

Relationships

THIS PACKAGEtool.docs-generator1 import paths

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

2 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

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
  • docs:generatebun src/index.ts generate --source "../../../generated/docs" --out "../../../packages/bundles/library/src/components/docs/generated" --content-root "../../../generated/docs" && bun src/index.ts packages --root ../../.. --out ../../../generated/package-manuals
  • 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
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit
  • devcontractspec-bun-build dev