example.video-docs-terminal
Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.
@lssm-tech/example.video-docs-terminalbun add @lssm-tech/example.video-docs-terminalManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.
What This Demonstrates
- Terminal demo video generation pipeline.
- Narration generation from CLI walkthroughs.
- Sample tutorial definitions for video input.
src/docs/contains docblocks and documentation-facing exports.src/docs/contains docblocks and documentation-facing exports.
Running Locally
From examples/video-docs-terminal:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @lssm-tech/example.video-docs-terminal as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/build-tutorial.tsis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/generate-narration.tsis part of the package's public or composition surface.src/index.tsis the root public barrel and package entrypoint.src/sample-tutorials.tsis part of the package's public or composition surface.src/video-docs-terminal.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./build-tutorialresolves through./src/build-tutorial.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/video-docs-terminal.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./generate-narrationresolves through./src/generate-narration.ts. - Export
./sample-tutorialsresolves through./src/sample-tutorials.ts. - Export
./video-docs-terminal.featureresolves through./src/video-docs-terminal.feature.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 prebuild— contractspec-bun-build prebuild
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
- Missing contract layers.
Notes
- Works alongside
@lssm-tech/lib.content-gen,@lssm-tech/lib.contracts-integrations,@lssm-tech/lib.contracts-spec,@lssm-tech/lib.video-gen,@lssm-tech/tool.bun, ...
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
4 declarations
@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-integrationsworkspace:^
Read the package manual ↗@lssm-tech/lib.video-genworkspace:^
Read the package manual ↗@lssm-tech/lib.content-genworkspace:^
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
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-testsprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit