integrationPackage manifestv76.0.5

integration.example-generator

Example plugin: Markdown documentation generator for ContractSpec specs

@lssm-tech/integration.example-generator
Source, release and verification context

Source snapshot bcc79fcc · Declared package version 76.0.5. This page combines the checked-in package guide and manifest; commands and runtime behavior were not executed in this review.

Package source ↗ Manifest ↗
servernode
EXPLORE THE PACKAGE

See where this package fits.

Follow a declared connection, inspect an import, then open the source guide when you need the detail.

THIS PACKAGEintegration.example-generatorintegrations

Arrows point from a package to its direct dependency. Each count is derived from the captured manifests.

3 declaracionesSELECT TO INSPECT

@lssm-tech/integration.example-generator

Website: https://contractspec.io

Example plugin: Markdown documentation generator for ContractSpec specs.

What It Provides

  • Capa: integration.
  • Consumers: plugin authors, documentation pipelines.
  • 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/integration.example-generator

or

bun add @lssm-tech/integration.example-generator

Usage

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

Arquitectura

  • src/config.ts is part of the package's public or composition surface.
  • src/generator.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 ./config resolves through ./src/config.ts.
  • Export ./generator resolves through ./src/generator.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 --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 test:watch — bun test --watch
  • bun run test:coverage — bun test --coverage
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.

Notes

  • Do not add business logic; this is a reference plugin.
  • Keep the export surface minimal -- new exports need a clear use-case.
  • Peer-depends on contracts-spec and schema; do not bundle them.

Declared capabilities.

Integration Example Generator

Example plugin: Markdown documentation generator for ContractSpec specs

Use it to

  • Adopt example plugin: markdown documentation generator for contractspec specs

Requires

  • TypeScript

Choose another boundary when

  • The @lssm-tech/integration.example-generator package constraints do not match the target runtime or platform.

@lssm-tech/integration.example-generator

@lssm-tech/integration.example-generator/config

@lssm-tech/integration.example-generator/generator

@lssm-tech/integration.example-generator/integration

@lssm-tech/integration.example-generator/types

Imports and export paths.

5 entries

These are package-manifest entry points. Named symbols listed above come from the capability catalogue; this is not an exhaustive TypeScript symbol reference.

5 importaciones

Dependencies and related packages.

Runtime dependencies 3
zod
catalog:
Peer dependencies 1
Development dependencies 5
@types/node
catalog:types
rimraf
catalog:build
typescript
catalog:

Package scripts.

Commands declared by this package. Review its setup requirements before running them; no command here was executed by this review.

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
test:watchbun test --watch
test:coveragebun test --coverage
prebuildcontractspec-bun-build prebuild
typechecktsgo --noEmit
Tu vista

Make room for your context.

Shape the presentation around this moment. You can change it whenever you need.

Tu contexto

The different parts of you

Choose a starting point

Una mezcla útil de contexto, imágenes y orientación discreta.

Tune each dimension
Each dimension can change independently. Product permissions and available actions stay unchanged.

Support the way you begin and return

Tune your support

Comodidad de lectura

Elige tu idioma

El idioma de la interfaz solo cambia el texto. Los mercados, precios y flujos de trabajo conservan sus propios ajustes.

Cobertura de traducción

Parte del contenido se muestra en inglés.

Navegación151
Grafo616
Categorías188
Portafolio332
Ejemplos2035
Vista previa de la fuente41

Se añadirán más traducciones a medida que se revise el contenido.

Esta preferencia se guarda en este navegador.

Buscar en el sitio web

Puntos de partida útiles

Sin resultados. Prueba una frase más corta, un nombre de operación u otro ámbito de búsqueda.

UN POCO DE ESPACIO PARA EXPLORAR

Encuentra algo que explorar.

Abre una vista detallada en esta página, prueba otra perspectiva o sigue el detalle a su propia página.

Cómo funcionan las vistas previas y los controles
01

Mirar antes de salir

Pasa el cursor por un enlace o enfócalo con Tab para ver una vista previa. Hacer clic en el enlace original o pulsar Intro siempre abre su destino.

02

Mantener el contexto

Entra en la vista previa para explorar sus secciones. Usa Alt + ↓ desde un enlace enfocado para entrar con el teclado. Escape la cierra.

03

Abrir las posibilidades

Las filas desplegables, las perspectivas y los controles destacados revelan más. Tu vista cambia la comodidad de lectura y el contexto que exploras.

Un botón separado para mirar más de cerca

Muestra pequeños botones de vista previa junto a los enlaces donde haya espacio. Toca el ojo para inspeccionar o el enlace para ir directamente. Esta elección permanece en esta pestaña.

No se recoge historial de navegación. El movimiento reducido sigue tu dispositivo y Tu vista.