tool.create-contractspec-plugin
CLI tool for creating ContractSpec plugins from templates
toolstoolv5.0.4stableservernode
@lssm-tech/tool.create-contractspec-pluginbun add @lssm-tech/tool.create-contractspec-pluginManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
CLI tool for creating ContractSpec plugins from templates.
What It Provides
- Layer: tool.
- Consumers: plugin authors (via
create-contractspec-pluginCLI). - 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/tool.create-contractspec-plugin
or
bun add @lssm-tech/tool.create-contractspec-plugin
Usage
bash
npx create-contractspec-plugin --help
# or
bunx create-contractspec-plugin --helpArchitecture
src/index.tsis the root public barrel and package entrypoint.src/templatesis part of the package's public or composition surface.src/utils.tsis part of the package's public or composition surface.
Public Entry Points
- Binary
create-contractspec-pluginpoints to./dist/index.js. - Export
.resolves through./src/index.ts. - Export
./templates/example-generatorresolves through./src/templates/example-generator.ts. - Export
./utilsresolves through./src/utils.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.
Notes
- Template files live in
templates/-- keep them in sync with the current plugin contract. - Do not change interactive prompts without updating the corresponding template variables.
- Depends on
@lssm-tech/lib.contracts-specand@lssm-tech/lib.schema-- respect their APIs.
Relationships
THIS PACKAGEtool.create-contractspec-plugin3 import paths
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
7 declarations
@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗@inquirer/prompts^8.7.2
zodcatalog:
commandercatalog:server
chalk^6.0.0
fs-extra^11.4.0
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