Conflict resolution notes: - package.json/run-gates: both sides' new doc-sync gates kept (master's scoped-events/readme gates + this branch's website-api/website-yaml); js-yaml devDeps deduped (master added them independently). - pnpm-workspace/knip: website AND python/sdk-runtime entries kept. - doc-typecheck/verify-type-equiv: master's condensed headers kept, website glob retained in both scan scopes. - vendor/cordis/src/fiber.ts: master's lifecycle-hardening code taken; this branch's richer FiberState JSDoc reapplied on top. vendor/README.md logs both local modifications (hardening = 6, JSDoc enrichment = 7). - pnpm-lock: regenerated from master's side (pnpm install). Post-merge sync the gates forced (the system working as designed): - verify-website-yaml caught 4 stale plugin names from master's package reorg (dsh-stdio-agent -> dsh-stdio-demo, dsh-acp-agent -> dsh-acp-demo); 8 references fixed across guide/ and develop/. - gen-website-api picked up master's 6 new services automatically (ctx.approval/permission/sandbox/sessionQuery/skills/tasks -> 6 new pages + sidebar); api/index.md hub updated to list them. - AGENTS.md budget ceiling 1370 -> 1400: the website rows (layout line + two command lines) and master's own growth collided with the old ceiling; all three website rows are load-bearing (new top-level dir, new CI command).
Cordis
Cordis is a TypeScript plugin framework for applications that need explicit
dependency injection, scoped services, lifecycle-managed cleanup, and optional
configuration-driven loading. The core package is published as cordis; the
official packages in this repository add a loader, config-file includes, HMR,
console logging, timers, and project scaffolding.
Install
yarn add cordis
Cordis is ESM-first. The repository is tested on current Node releases, and the scaffolder requires Node 22 or newer.
Quick Start
import { Context, Service } from 'cordis'
declare module 'cordis' {
interface Context {
counter: Counter
}
interface Events {
'app/ready'(message: string): void
}
}
class Counter extends Service {
value = 0
constructor(ctx: Context) {
super(ctx, 'counter')
}
next() {
return ++this.value
}
}
const greeter = Object.assign((ctx: Context) => {
ctx.on('app/ready', (message) => {
ctx.logger.info('%s #%d', message, ctx.counter.next())
})
}, {
inject: ['counter'],
})
const root = new Context()
await root.plugin(Counter)
await root.plugin(greeter)
root.emit('app/ready', 'started')
await root.fiber.dispose()
The important pieces are:
new Context()creates the root dependency container.ctx.plugin()starts a plugin and returns aFiber.injecttells Cordis which services must exist before the plugin runs.- Effects, event listeners, and services are removed when their owning fiber is disposed.
Documentation
Packages
| Package | Purpose |
|---|---|
cordis |
Core context, plugin registry, fiber lifecycle, events, services, and logger. |
create-cordis |
Interactive project scaffolder. |
@cordisjs/plugin-loader |
Runtime plugin tree and loader service. |
@cordisjs/plugin-include |
YAML/JSON config-file include support for the loader. |
@cordisjs/plugin-group |
Nested plugin groups for loader configs. |
@cordisjs/plugin-hmr |
Hot module replacement for loader-managed plugins. |
@cordisjs/plugin-logger-console |
Console exporter for the built-in logger. |
@cordisjs/plugin-timer |
Disposal-aware timeout, interval, throttle, and debounce helpers. |
@cordisjs/utils |
Shared utilities used by Cordis packages. |
Development
yarn install
yarn build
yarn test
yarn lint
The monorepo uses Yakumo to build and test all packages. Most examples in the
docs use public APIs from cordis; loader examples additionally use
@cordisjs/plugin-loader and @cordisjs/plugin-include.