@contractspec/lib.plugins 3.7.6 → 3.7.10

package/README.md

@@ -1,63 +1,64 @@
 # @contractspec/lib.plugins
 
-Core plugin API for ContractSpec. Defines plugin interfaces, registry management, and discovery configuration.
+Website: https://contractspec.io
 
-## Overview
+**Plugin API and registry for ContractSpec extensions.**
 
-Use this package to build generator, validator, adapter, formatter, and registry resolver plugins. The core types keep plugin behavior consistent while allowing capability-specific logic.
+## What It Provides
+
+- **Layer**: lib.
+- **Consumers**: bundles, CLI.
+- Related ContractSpec packages include `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Related ContractSpec packages include `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
 ## Installation
 
-```bash
-bun add @contractspec/lib.plugins
-```
+`npm install @contractspec/lib.plugins`
+
+or
+
+`bun add @contractspec/lib.plugins`
 
 ## Usage
 
-```typescript
-import type { ContractSpecPlugin, PluginContext } from "@contractspec/lib.plugins";
-
-export const MarkdownGeneratorPlugin: ContractSpecPlugin = {
-  meta: {
-    id: "markdown-generator",
-    version: "1.0.0",
-    type: "generator",
-    provides: ["docs"],
-  },
-  register(context: PluginContext) {
-    context.generators.register({
-      id: "markdown",
-      description: "Generate markdown docs",
-      generate: async (specs) => {
-        // Implementation
-      },
-    });
-  },
-};
-```
-
-## Capabilities
-
-- **Generators**: Produce code, docs, schemas, or artifacts.
-- **Validators**: Enforce policies and compliance checks.
-- **Adapters**: Integrate frameworks or runtimes.
-- **Formatters**: Post-process generated output.
-- **Registry resolvers**: Resolve plugins from workspace, npm, or remote registries.
-
-## Registry configuration
-
-```json
-{
-  "plugins": [
-    {
-      "id": "markdown-generator",
-      "package": "@contractspec/plugin.markdown-generator",
-      "capabilities": ["generator"],
-      "options": {
-        "outputDir": "./docs/generated",
-        "format": "table"
-      }
-    }
-  ]
-}
-```
+Import the root entrypoint from `@contractspec/lib.plugins`, or choose a documented subpath when you only need one part of the package surface.
+
+## Architecture
+
+- `src/config.ts` is part of the package's public or composition surface.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/registry.ts` is part of the package's public or composition surface.
+- `src/types.ts` is shared public type definitions.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./config` resolves through `./src/config.ts`.
+- Export `./registry` resolves through `./src/registry.ts`.
+- Export `./types` resolves through `./src/types.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 --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` — 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.
+
+## Notes
+
+- Plugin interface is a public API contract — breaking changes affect all published plugins.
+- Registry must stay backward-compatible; older plugin manifests must remain loadable.
+- Config schema changes require a migration path for existing plugin configurations.

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { AdapterCapability, AdapterRegistry, ContractSpecPlugin, FormatterCapability, FormatterRegistry, GeneratorCapability, GeneratorRegistry, PluginCapabilityType, PluginContext, PluginMeta, PluginRegistryConfig, PluginRegistryItem, RegistryResolverCapability, RegistryResolverRegistry, SpecRegistryEntry, ValidatorCapability, ValidatorRegistry, } from './types.js';
-export { PluginRegistries, defaultPluginRegistryConfig } from './registry.js';
 export { mergePluginConfig } from './config.js';
+export { defaultPluginRegistryConfig, PluginRegistries } from './registry.js';
+export type { AdapterCapability, AdapterRegistry, ContractSpecPlugin, FormatterCapability, FormatterRegistry, GeneratorCapability, GeneratorRegistry, PluginCapabilityType, PluginContext, PluginMeta, PluginRegistryConfig, PluginRegistryItem, RegistryResolverCapability, RegistryResolverRegistry, SpecRegistryEntry, ValidatorCapability, ValidatorRegistry, } from './types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/lib.plugins",
-  "version": "3.7.6",
+  "version": "3.7.10",
   "description": "Plugin API and registry for ContractSpec extensions",
   "keywords": [
     "contractspec",
@@ -23,21 +23,21 @@
     "dev": "contractspec-bun-build dev",
     "clean": "rimraf dist .turbo",
     "lint": "bun lint:fix",
-    "lint:fix": "eslint src --fix",
-    "lint:check": "eslint src",
+    "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
+    "lint:check": "biome check .",
     "test": "bun test --pass-with-no-tests",
     "prebuild": "contractspec-bun-build prebuild",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.contracts-spec": "3.7.6",
-    "@contractspec/lib.schema": "3.7.6",
+    "@contractspec/lib.contracts-spec": "4.1.2",
+    "@contractspec/lib.schema": "3.7.8",
     "zod": "^4.3.5"
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.6",
+    "@contractspec/tool.typescript": "3.7.8",
     "typescript": "^5.9.3",
-    "@contractspec/tool.bun": "3.7.6"
+    "@contractspec/tool.bun": "3.7.8"
   },
   "exports": {
     ".": {