Files
oh-my-pi/packages/coding-agent/src/extensibility/plugins/loader.ts
T
ephraimduncan 93420c5782 fix(coding-agent/plugins): resolve directory manifest extension entries to their index.{ts,js,mjs,cjs}
Plugin manifests that declare a directory entry (e.g. pi-goal's
`"pi": { "extensions": [".pi/extensions/pi-goal"] }`) were
pushed through to the legacy module loader unchanged. `Bun.file()`
on a directory throws "Directories cannot be read like files",
so every such plugin failed to load.

`resolvePluginPaths` now routes each joined manifest entry through
`resolveManifestEntryFile`, which:
- returns the path as-is when it is a file,
- returns the directory's `index.{ts,js,mjs,cjs}` when it is a
  directory containing one of those files,
- otherwise returns null (skip).

This mirrors the documented native auto-discovery behavior in
`resolveExtensionEntries` and the candidate list in
`extensibility/custom-commands/loader.ts`.

Closes #1001.
2026-05-11 00:05:00 +00:00

289 lines
8.3 KiB
TypeScript

/**
* Plugin loader - discovers and loads manifest entry points from installed plugins.
*
* Reads enabled plugins from the runtime config and loads their
* tools/hooks/extensions/commands based on manifest entries and enabled features.
*/
import * as fs from "node:fs";
import * as path from "node:path";
import { getPluginsLockfile, getPluginsNodeModules, getPluginsPackageJson, isEnoent } from "@oh-my-pi/pi-utils";
import { getConfigDirPaths } from "../../config";
import { installLegacyPiSpecifierShim } from "./legacy-pi-compat";
import type { InstalledPlugin, PluginManifest, PluginRuntimeConfig, ProjectPluginOverrides } from "./types";
installLegacyPiSpecifierShim();
// =============================================================================
// Runtime Config Loading
// =============================================================================
/**
* Load plugin runtime config from lock file.
*/
async function loadRuntimeConfig(): Promise<PluginRuntimeConfig> {
const lockPath = getPluginsLockfile();
try {
return await Bun.file(lockPath).json();
} catch (err) {
if (isEnoent(err)) return { plugins: {}, settings: {} };
throw err;
}
}
/**
* Load project-local plugin overrides (checks .omp and .pi directories).
*/
async function loadProjectOverrides(cwd: string): Promise<ProjectPluginOverrides> {
for (const overridesPath of getConfigDirPaths("plugin-overrides.json", { user: false, cwd })) {
try {
return await Bun.file(overridesPath).json();
} catch (err) {
if (isEnoent(err)) continue;
// JSON parse error - continue to next path
}
}
return {};
}
/**
* Get list of enabled plugins with their resolved configurations.
* Respects both global runtime config and project overrides.
*/
export async function getEnabledPlugins(cwd: string): Promise<InstalledPlugin[]> {
const pkgJsonPath = getPluginsPackageJson();
let pkg: { dependencies?: Record<string, string> };
try {
pkg = await Bun.file(pkgJsonPath).json();
} catch (err) {
if (isEnoent(err)) return [];
throw err;
}
const nodeModulesPath = getPluginsNodeModules();
if (!fs.existsSync(nodeModulesPath)) {
return [];
}
const deps = pkg.dependencies || {};
const runtimeConfig = await loadRuntimeConfig();
const projectOverrides = await loadProjectOverrides(cwd);
const plugins: InstalledPlugin[] = [];
for (const [name] of Object.entries(deps)) {
const pluginPkgPath = path.join(nodeModulesPath, name, "package.json");
let pluginPkg: { version: string; omp?: PluginManifest; pi?: PluginManifest };
try {
pluginPkg = await Bun.file(pluginPkgPath).json();
} catch (err) {
if (isEnoent(err)) continue;
throw err;
}
const manifest: PluginManifest | undefined = pluginPkg.omp || pluginPkg.pi;
if (!manifest) {
// Not an omp plugin, skip
continue;
}
manifest.version = pluginPkg.version;
const runtimeState = runtimeConfig.plugins[name];
// Check if disabled globally
if (runtimeState && !runtimeState.enabled) {
continue;
}
// Check if disabled in project
if (projectOverrides.disabled?.includes(name)) {
continue;
}
// Resolve enabled features (project overrides take precedence)
const enabledFeatures = projectOverrides.features?.[name] ?? runtimeState?.enabledFeatures ?? null;
plugins.push({
name,
version: pluginPkg.version,
path: path.join(nodeModulesPath, name),
manifest,
enabledFeatures,
enabled: true,
});
}
return plugins;
}
// =============================================================================
// Path Resolution
// =============================================================================
const MANIFEST_ENTRY_INDEX_NAMES = ["index.ts", "index.js", "index.mjs", "index.cjs"];
/**
* Resolve a plugin manifest entry to a concrete loadable file path. Returns the
* file path itself when the entry points at a file, the matching index file when
* the entry points at a directory containing index.{ts,js,mjs,cjs}, and null
* when no entry exists at the joined path.
*/
function resolveManifestEntryFile(joined: string): string | null {
let stats: fs.Stats;
try {
stats = fs.statSync(joined);
} catch {
return null;
}
if (stats.isDirectory()) {
for (const name of MANIFEST_ENTRY_INDEX_NAMES) {
const candidate = path.join(joined, name);
if (fs.existsSync(candidate)) return candidate;
}
return null;
}
return joined;
}
/**
* Generic path resolver for plugin manifest entries (tools, hooks, commands, extensions).
* Handles both single-string and string[] base entries, plus feature-specific entries.
*/
function resolvePluginPaths(plugin: InstalledPlugin, key: "tools" | "hooks" | "commands" | "extensions"): string[] {
const paths: string[] = [];
const manifest = plugin.manifest;
// Base entry (always included if exists)
const base = manifest[key];
if (base) {
const entries = Array.isArray(base) ? base : [base];
for (const entry of entries) {
const resolved = resolveManifestEntryFile(path.join(plugin.path, entry));
if (resolved) {
paths.push(resolved);
}
}
}
// Feature-specific entries
if (manifest.features && plugin.enabledFeatures) {
const enabledSet = new Set(plugin.enabledFeatures);
for (const [featName, feat] of Object.entries(manifest.features)) {
if (!enabledSet.has(featName)) continue;
if (feat[key]) {
for (const entry of feat[key]) {
const resolved = resolveManifestEntryFile(path.join(plugin.path, entry));
if (resolved) {
paths.push(resolved);
}
}
}
}
} else if (manifest.features && plugin.enabledFeatures === null) {
// null means use defaults - enable features with default: true
for (const [_featName, feat] of Object.entries(manifest.features)) {
if (!feat.default) continue;
if (feat[key]) {
for (const entry of feat[key]) {
const resolved = resolveManifestEntryFile(path.join(plugin.path, entry));
if (resolved) {
paths.push(resolved);
}
}
}
}
}
return paths;
}
export function resolvePluginToolPaths(plugin: InstalledPlugin): string[] {
return resolvePluginPaths(plugin, "tools");
}
export function resolvePluginHookPaths(plugin: InstalledPlugin): string[] {
return resolvePluginPaths(plugin, "hooks");
}
export function resolvePluginCommandPaths(plugin: InstalledPlugin): string[] {
return resolvePluginPaths(plugin, "commands");
}
export function resolvePluginExtensionPaths(plugin: InstalledPlugin): string[] {
return resolvePluginPaths(plugin, "extensions");
}
// =============================================================================
// Aggregated Discovery
// =============================================================================
/**
* Get all tool paths from all enabled plugins.
*/
export async function getAllPluginToolPaths(cwd: string): Promise<string[]> {
const plugins = await getEnabledPlugins(cwd);
const paths: string[] = [];
for (const plugin of plugins) {
paths.push(...resolvePluginToolPaths(plugin));
}
return paths;
}
/**
* Get all hook paths from all enabled plugins.
*/
export async function getAllPluginHookPaths(cwd: string): Promise<string[]> {
const plugins = await getEnabledPlugins(cwd);
const paths: string[] = [];
for (const plugin of plugins) {
paths.push(...resolvePluginHookPaths(plugin));
}
return paths;
}
/**
* Get all command paths from all enabled plugins.
*/
export async function getAllPluginCommandPaths(cwd: string): Promise<string[]> {
const plugins = await getEnabledPlugins(cwd);
const paths: string[] = [];
for (const plugin of plugins) {
paths.push(...resolvePluginCommandPaths(plugin));
}
return paths;
}
/**
* Get all extension module paths from all enabled plugins.
*/
export async function getAllPluginExtensionPaths(cwd: string): Promise<string[]> {
const plugins = await getEnabledPlugins(cwd);
const paths: string[] = [];
for (const plugin of plugins) {
paths.push(...resolvePluginExtensionPaths(plugin));
}
return paths;
}
/**
* Get plugin settings for use in tool/hook contexts.
* Merges global settings with project overrides.
*/
export async function getPluginSettings(pluginName: string, cwd: string): Promise<Record<string, unknown>> {
const runtimeConfig = await loadRuntimeConfig();
const projectOverrides = await loadProjectOverrides(cwd);
const global = runtimeConfig.settings[pluginName] || {};
const project = projectOverrides.settings?.[pluginName] || {};
return { ...global, ...project };
}