functional-examples

A language-agnostic library for treating code examples as first-class citizens.

This monorepo contains the core functional-examples library and related tooling.

Packages

Package	Description
functional-examples	Core scanner, config, CLI, and type generation
@functional-examples/devkit	Plugin development kit — shared types and utilities
@functional-examples/javascript	JavaScript/TypeScript extractor plugin
@functional-examples/yaml-manifest	YAML manifest extractor plugin
@functional-examples/test	Test runner plugin for examples
@functional-examples/documentation	Documentation generation plugin

Quick Start

npm install functional-examples
# or
pnpm add functional-examples
# or
yarn add functional-examples

/**
 * Basic example: Scanning for examples programmatically
 */
import { scan } from 'functional-examples';

async function main() {
  // scan() auto-discovers config and plugins
  const result = await scan();

  console.log(`Found ${result.examples.length} examples:`);
  for (const example of result.examples) {
    console.log(`  - ${example.title} (${example.id})`);
  }

  if (result.errors.length > 0) {
    console.log(`\n${result.errors.length} errors occurred:`);
    for (const error of result.errors) {
      console.log(`  - ${error.path}: ${error.message}`);
    }
  }
}

main().catch(console.error);

Development

# Install dependencies
pnpm install

# Build all packages
pnpm nx run-many -t build

# Run tests
pnpm nx run-many -t test

# Lint
pnpm nx run-many -t lint

License

MIT