Skip to content
ContractSpec
Start here

Package manual · tools

·CLI, authoring and agent tooling

lib.source-extractors

Extract contract candidates from TypeScript source code across multiple frameworks (NestJS, Express, Fastify, Hono, Elysia, tRPC, Next.js)

toolslibraryv4.0.4stableservernode
@lssm-tech/lib.source-extractors
bun add @lssm-tech/lib.source-extractors
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

This contributor/compiler package is owned at packages/tools/source-extractors. Its published package name and documented import paths remain unchanged.

Website: https://contractspec.io

Extract contract candidates from TypeScript source code across multiple frameworks (NestJS, Express, Fastify, Hono, Elysia, tRPC, Next.js).

What It Provides

  • Layer: lib.
  • Consumers: CLI, bundles.
  • 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/lib.source-extractors

or

bun add @lssm-tech/lib.source-extractors

Usage

Import the root entrypoint from @lssm-tech/lib.source-extractors, or choose a documented subpath when you only need one part of the package surface.

Architecture

  • src/__fixtures__ is part of the package's public or composition surface.
  • src/__snapshots__ is part of the package's public or composition surface.
  • src/codegen is part of the package's public or composition surface.
  • src/codegen.test.ts is part of the package's public or composition surface.
  • src/detect.test.ts is part of the package's public or composition surface.
  • src/detect.ts is part of the package's public or composition surface.
  • src/edge-cases.test.ts is part of the package's public or composition surface.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/types.ts is shared public type definitions.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./codegen resolves through ./src/codegen/index.ts.
  • Export ./extractors resolves through ./src/extractors/index.ts.
  • Export ./types resolves through ./src/types.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 prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.

Notes

  • Extractor interface must support multiple frameworks — keep it generic.
  • Codegen output must stay deterministic (same input → same output, always).

Internal source ownership

Detection rules, input strategies and project discovery have private source owners. IR metadata, candidate shapes and extraction results remain available through the existing type barrel. No package identity, public entrypoint or output changes. Original focused test paths aggregate the same suites after cohesive splitting.

Relationships

THIS PACKAGElib.source-extractors4 import paths

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

4 declarations

Declared capabilities

Lib Source Extractors

Extract contract candidates from TypeScript source code across multiple frameworks (NestJS, Express, Fastify, Hono, Elysia, tRPC, Next.js)

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