tool.docs-generator
CLI tool for generating docs artifacts from ContractSpec specs and DocBlocks
toolstoolv5.0.4stableservernode
@lssm-tech/tool.docs-generatorbun add @lssm-tech/tool.docs-generatorManifest 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 --helpArchitecture
src/fs.tsis part of the package's public or composition surface.src/generate.tsis part of the package's public or composition surface.src/index.tsis the root public barrel and package entrypoint.src/markdown.test.tsis part of the package's public or composition surface.src/markdown.tsis part of the package's public or composition surface.src/types.tsis shared public type definitions.
Public Entry Points
- Binary
contractspec-docspoints to./dist/index.js. - Export
.resolves through./src/index.ts.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun testbun 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 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-sourcescan be checked out on Windows. - Output paths are configured via CLI flags -- do not hard-code destination directories.
- Depends on
@lssm-tech/lib.contracts-specfor spec parsing -- changes there may require updates here. - The
docs:generatescript references relative paths togenerated/docsand 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
@lssm-tech/lib.surface-runtimeworkspace:^
Read the package manual ↗commandercatalog:server
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 --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdocs: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-manualscleanrimraf 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 testprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmitdevcontractspec-bun-build dev