dynamic-cli-framework-api

API for the dynamic-cli-framework

Usage

Plugin authors should depend on this package (not the full @flowscripter/dynamic-cli-framework) as a peerDependency:

{
  "peerDependencies": {
    "@flowscripter/dynamic-cli-framework-api": "*",
  },
}

Key exports:

• createCLIPlugin - scaffolding helper to build a CLIPlugin from a CommandFactory and/or ServiceProviderFactory.
• CommandFactory, ServiceProviderFactory - extension interfaces implemented by a plugin.
• Command, SubCommand, GlobalCommand, GroupCommand - command types.
• Context, CLIConfig - runtime context passed to commands.
• Core service interfaces and their *_SERVICE_ID identifiers (PrinterService, TableGeneratorService, SyntaxHighlighterService, ConfigurationService, etc.) used to look up services via Context.
• StartupService/StartupTask, ShutdownService/ShutdownTask - priority-ordered registration of work to run once during CLI startup/shutdown, via registerTask({id, priority, run}) on either.

See dynamic-cli-framework for the runnable framework and its concrete service implementations.

API

Link to auto-generated API docs:

API Documentation

Development

Install dependencies:

bun install

Build (produces dist/ for Node.js and TypeScript consumers; Bun uses raw source directly):

bun run build

Format:

bunx oxfmt

Lint:

bunx oxlint index.ts src/ tests/

Generate HTML API documentation:

bunx typedoc index.ts

License

MIT © Flowscripter