mirror of
https://github.com/stablyai/orca.git
synced 2026-11-15 02:17:31 +00:00
Neil
a37a5b3e2d
* feat(plugins): dev emit also reaches the plugin's open panels orca plugin dev emit now publishes through the panel bridge to that dev plugin's open panels that subscribed with orca.on, under the same approval and capability rules as the worker, and reports delivered.panels. The bridge's publishEvent takes an optional pluginKey filter and returns how many panels heard it. A panel-only plugin no longer needs a worker; an event nothing listens for is refused. * docs(skills): trim the plugin authoring guide; details move to references The main guide drops from 299 to 121 lines: the decision table, build-less rules, core loop (create → dev watch --check --shot → read the PNG → test → check → release-entry), approval and top gotchas. Test/check and orca/testing (panels and workers), dev watch events, shot, open and dev emit move to a hand-written references/workflow.md; the panel/worker/data and agent status recipes to references/recipes.md, each with a read-when row. The guide test now also scans hand-written references for commands and caps the main guide at 150 lines.
77 lines
3.0 KiB
JavaScript
77 lines
3.0 KiB
JavaScript
import { readdir, readFile } from 'node:fs/promises'
|
|
import path from 'node:path'
|
|
import { describe, expect, it } from 'vitest'
|
|
import {
|
|
PLUGIN_AUTHORING_COMMAND_SPECS,
|
|
PLUGIN_RUNTIME_COMMAND_SPECS
|
|
} from '../../src/cli/specs/plugin'
|
|
import { PLUGIN_VIEW_COMMAND_SPECS } from '../../src/cli/specs/plugin-view'
|
|
import {
|
|
buildPluginAuthoringReferences,
|
|
findStalePluginAuthoringReferences
|
|
} from './generate-plugin-authoring-skill-references.mjs'
|
|
|
|
const projectDir = path.resolve(import.meta.dirname, '..', '..')
|
|
describe('plugin authoring skill references', () => {
|
|
it('checks in the references generated from the plugin sources', async () => {
|
|
const artifacts = await buildPluginAuthoringReferences(projectDir)
|
|
|
|
// Run `pnpm generate:plugin-authoring-skill-references` when this fails.
|
|
await expect(findStalePluginAuthoringReferences(artifacts, projectDir)).resolves.toEqual([])
|
|
})
|
|
|
|
it('reports a stale reference by its repo path', async () => {
|
|
const [first, ...rest] = await buildPluginAuthoringReferences(projectDir)
|
|
const stale = [{ ...first, content: `${first.content}drift\n` }, ...rest]
|
|
|
|
await expect(findStalePluginAuthoringReferences(stale, projectDir)).resolves.toEqual([
|
|
'skill-guides/orca-plugin-authoring/references/cli.md'
|
|
])
|
|
})
|
|
|
|
it('names only plugin commands this CLI defines, in the guide and its hand-written references', async () => {
|
|
const generated = new Set(
|
|
(await buildPluginAuthoringReferences(projectDir)).map((artifact) =>
|
|
path.basename(artifact.path)
|
|
)
|
|
)
|
|
const referenceDir = path.join(
|
|
projectDir,
|
|
'skill-guides',
|
|
'orca-plugin-authoring',
|
|
'references'
|
|
)
|
|
const handWritten = (await readdir(referenceDir)).filter(
|
|
(name) => name.endsWith('.md') && !generated.has(name)
|
|
)
|
|
expect(handWritten).toEqual(expect.arrayContaining(['recipes.md', 'workflow.md']))
|
|
const documents = await Promise.all([
|
|
readFile(path.join(projectDir, 'skill-guides', 'orca-plugin-authoring.md'), 'utf8'),
|
|
...handWritten.map((name) => readFile(path.join(referenceDir, name), 'utf8'))
|
|
])
|
|
const known = [
|
|
...PLUGIN_AUTHORING_COMMAND_SPECS,
|
|
...PLUGIN_RUNTIME_COMMAND_SPECS,
|
|
...PLUGIN_VIEW_COMMAND_SPECS
|
|
].map((spec) => spec.path.join(' '))
|
|
const named = documents.flatMap((text) =>
|
|
[...text.matchAll(/ORCA (plugin(?: [a-z-]+){1,2})/gu)].map((match) => match[1])
|
|
)
|
|
const unknown = named.filter(
|
|
(command) => !known.some((path) => command === path || command.startsWith(`${path} `))
|
|
)
|
|
|
|
expect(named.length).toBeGreaterThan(5)
|
|
expect(unknown).toEqual([])
|
|
})
|
|
|
|
it('keeps the main guide short; details live in references', async () => {
|
|
const guide = await readFile(
|
|
path.join(projectDir, 'skill-guides', 'orca-plugin-authoring.md'),
|
|
'utf8'
|
|
)
|
|
// Why: agents load the whole guide each time; references load only when needed.
|
|
expect(guide.split('\n').length).toBeLessThanOrEqual(150)
|
|
})
|
|
})
|