@contractspec/module.workspace 3.7.6 → 4.0.3

package/README.md

@@ -1,50 +1,67 @@
 # @contractspec/module.workspace
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Workspace discovery and management module.**
 
-Pure, deterministic domain logic and static analysis utilities for ContractSpec workspace operations.
+## What It Provides
 
-## Purpose
+- **Layer**: module.
+- **Consumers**: bundles (contractspec-studio), apps (cli-contractspec, vscode-contractspec).
+- Related ContractSpec packages include `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Related ContractSpec packages include `@contractspec/lib.contracts-integrations`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
-This module contains platform-agnostic logic used by ContractSpec tooling:
+## Installation
 
-- **Types**: Shared type definitions for specs, templates, and analysis results
-- **Analysis**: Static code analysis (spec scanning, dependency graphs, semantic diff)
-- **Templates**: Code generation templates for specs and handlers
-- **AI Prompts**: Prompt builders for AI-assisted spec creation and code generation
+`npm install @contractspec/module.workspace`
 
-## Design Principles
+or
 
-- **No side effects**: All functions are pure and deterministic
-- **No CLI dependencies**: No `chalk`, `ora`, `commander`, or `inquirer`
-- **No filesystem access**: Operations take code/data as input, return results
-- **Reusable**: Can be used by CLI, web apps, VS Code extensions, etc.
+`bun add @contractspec/module.workspace`
 
 ## Usage
 
-```typescript
-import {
-  scanSpecSource,
-  computeSemanticDiff,
-  buildDependencyGraph,
-  validateSpecStructure,
-  generateOperationSpec,
-} from '@contractspec/module.workspace';
-```
+Import the root entrypoint from `@contractspec/module.workspace`, or choose a documented subpath when you only need one part of the package surface.
 
-## Exports
-
-- `analysis/` - Static analysis utilities
-- `templates/` - Code generation templates
-- `ai/` - AI prompt builders
-- `types/` - Shared type definitions
+## Architecture
 
+- `src/ai` is part of the package's public or composition surface.
+- `src/analysis` is part of the package's public or composition surface.
+- `src/formatter.ts` is part of the package's public or composition surface.
+- `src/formatters` is part of the package's public or composition surface.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/templates` is part of the package's public or composition surface.
+- `src/types` is part of the package's public or composition surface.
 
+## Public Entry Points
 
+- Export `.` resolves through `./src/index.ts`.
 
+## Local Commands
 
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `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` — tsc --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.
+- Stability.
+- Add changesets and apply pending fixes.
+- Add ai-native messaging channel runtime.
 
+## Notes
 
+- Uses `ts-morph` for AST analysis and `compare-versions` for semver checks -- version bumps may affect parsing behavior.
+- Workspace detection is file-system-dependent; always use the provided abstractions, never raw `fs` calls.
+- Changes here affect CLI, VSCode extension, and studio workspace initialization flows.

package/dist/ai/prompts/index.d.ts

@@ -1,2 +1,2 @@
-export * from './spec-creation';
 export * from './code-generation';
+export * from './spec-creation';

package/dist/analysis/deps/graph.d.ts

@@ -2,8 +2,8 @@
  * Contract dependency graph utilities.
  * Extracted from cli-contractspec/src/commands/deps/graph.ts
  */
-import type { ContractNode, ContractGraph } from '../../types/analysis-types';
-export type { ContractNode, ContractGraph };
+import type { ContractGraph, ContractNode } from '../../types/analysis-types';
+export type { ContractGraph, ContractNode };
 /**
  * Build reverse edges (dependents) for all nodes in the graph.
  */

package/dist/analysis/diff/deep-diff.d.ts

@@ -4,8 +4,8 @@
  * Compares input/output schemas field-by-field to detect
  * breaking and non-breaking changes.
  */
-import type { FieldSnapshot, IoSnapshot } from '../snapshot/types';
 import type { SemanticDiffItem } from '../../types/analysis-types';
+import type { FieldSnapshot, IoSnapshot } from '../snapshot/types';
 /**
  * Deep diff options.
  */

package/dist/analysis/diff/index.d.ts

@@ -1,5 +1,5 @@
 /**
  * Semantic diff utilities for comparing specs.
  */
-export * from './semantic';
 export * from './deep-diff';
+export * from './semantic';

package/dist/analysis/impact/index.d.ts

@@ -3,6 +3,6 @@
  *
  * Provides classification of contract changes as breaking or non-breaking.
  */
-export * from './types';
-export { DEFAULT_RULES, BREAKING_RULES, NON_BREAKING_RULES, INFO_RULES, findMatchingRule, getRulesBySeverity, } from './rules';
 export { classifyImpact } from './classifier';
+export { BREAKING_RULES, DEFAULT_RULES, findMatchingRule, getRulesBySeverity, INFO_RULES, NON_BREAKING_RULES, } from './rules';
+export * from './types';

package/dist/analysis/index.d.ts

@@ -1,13 +1,13 @@
 /**
  * Static analysis utilities for ContractSpec.
  */
-export * from './spec-scan';
-export * from './feature-scan';
+export * from './deps/index';
+export * from './diff/index';
 export * from './example-scan';
+export * from './feature-scan';
 export * from './grouping';
-export * from './diff/index';
-export * from './deps/index';
-export * from './validate/index';
-export * from './snapshot/index';
 export * from './impact/index';
+export * from './snapshot/index';
 export * from './spec-parser';
+export * from './spec-scan';
+export * from './validate/index';

package/dist/analysis/snapshot/index.d.ts

@@ -3,6 +3,6 @@
  *
  * Provides deterministic snapshot generation for contract comparison.
  */
-export * from './types';
-export { normalizeValue, toCanonicalJson, computeHash, sortSpecs, sortFields, } from './normalizer';
+export { computeHash, normalizeValue, sortFields, sortSpecs, toCanonicalJson, } from './normalizer';
 export { generateSnapshot } from './snapshot';
+export * from './types';

package/dist/analysis/spec-scan.d.ts

@@ -4,7 +4,7 @@
  * Scans source code to extract spec definitions and metadata without execution.
  */
 import type { AnalyzedOperationKind, AnalyzedSpecType, SpecScanResult } from '../types/analysis-types';
-export { extractTestTarget, extractTestCoverage } from './spec-parsing-utils';
+export { extractTestCoverage, extractTestTarget } from './spec-parsing-utils';
 /**
  * Scan all specs from a single source file.
  */

package/dist/formatters/spec-to-docblock.d.ts

@@ -1,5 +1,5 @@
-import type { ParsedSpec } from '../types/llm-types';
 import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
+import type { ParsedSpec } from '../types/llm-types';
 /**
  * Convert a parsed spec to a DocBlock for documentation generation.
  */

package/dist/index.d.ts

@@ -4,9 +4,9 @@
  * Pure, deterministic domain logic and static analysis utilities
  * for ContractSpec workspace operations.
  */
-export * from './types/index';
-export * from './analysis/index';
-export * from './templates/index';
 export * from './ai/index';
+export * from './analysis/index';
 export * from './formatter';
 export * from './formatters/index';
+export * from './templates/index';
+export * from './types/index';