Skip to content
ContractSpec
Start here

Package manual · tools

·CLI, authoring and agent tooling

tool.create-contractspec-plugin

CLI tool for creating ContractSpec plugins from templates

toolstoolv5.0.4stableservernode
@lssm-tech/tool.create-contractspec-plugin
bun add @lssm-tech/tool.create-contractspec-plugin
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 creating ContractSpec plugins from templates.

What It Provides

  • Layer: tool.
  • Consumers: plugin authors (via create-contractspec-plugin CLI).
  • 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 --help

Architecture

  • src/index.ts is the root public barrel and package entrypoint.
  • src/templates is part of the package's public or composition surface.
  • src/utils.ts is part of the package's public or composition surface.

Public Entry Points

  • Binary create-contractspec-plugin points to ./dist/index.js.
  • Export . resolves through ./src/index.ts.
  • Export ./templates/example-generator resolves through ./src/templates/example-generator.ts.
  • Export ./utils resolves through ./src/utils.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 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-spec and @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.schema
  • @inquirer/prompts

    ^8.7.2

  • zod

    catalog:

  • commander

    catalog: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 --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
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit