mirror of
https://github.com/jackwener/OpenCLI.git
synced 2026-09-14 18:25:42 +08:00
34a9bff2b3
- NEW: src/interceptor.ts — unified XHR/Fetch interceptor (was duplicated 3x) - NEW: src/version.ts — centralized PKG_VERSION (was duplicated 2x) - NEW: src/constants.ts — shared VOLATILE_PARAMS, FIELD_ROLES etc. - NEW: src/engine.test.ts, src/registry.test.ts — 14 new unit tests - browser.ts: use shared normalizeEval, interceptor, withTimeoutMs, PKG_VERSION - intercept.ts, tap.ts: use shared interceptor generators - cascade.ts: extract shared buildFetchProbeJs (90% dedup) - engine.ts: use InternalCliCommand (no more 'as any' casts) - executor.ts: remove all 15 'as StepHandler' type casts - runtime.ts: add withTimeoutMs, IBrowserFactory interface - registry.ts: add InternalCliCommand type for internal fields - validate.ts: add pipeline step name validation - output.ts: remove 'null as any' and '.filter(() => true)' hacks - explore.ts, synthesize.ts: use shared constants - docs: fix V2EX commands (3→6), SKILL.md version, verify example Tests: 88 passed (was 74), tsc --noEmit: 0 errors
203 lines
7.0 KiB
TypeScript
203 lines
7.0 KiB
TypeScript
/**
|
|
* CLI discovery: finds YAML/TS CLI definitions and registers them.
|
|
*
|
|
* Supports two modes:
|
|
* 1. FAST PATH (manifest): If a pre-compiled cli-manifest.json exists,
|
|
* registers all YAML commands instantly without runtime YAML parsing.
|
|
* TS modules are loaded lazily only when their command is executed.
|
|
* 2. FALLBACK (filesystem scan): Traditional runtime discovery for development.
|
|
*/
|
|
|
|
import * as fs from 'node:fs';
|
|
import * as path from 'node:path';
|
|
import yaml from 'js-yaml';
|
|
import { type CliCommand, type InternalCliCommand, type Arg, Strategy, registerCommand } from './registry.js';
|
|
import type { IPage } from './types.js';
|
|
import { executePipeline } from './pipeline.js';
|
|
|
|
/** Set of TS module paths that have been loaded */
|
|
const _loadedModules = new Set<string>();
|
|
|
|
/**
|
|
* Discover and register CLI commands.
|
|
* Uses pre-compiled manifest when available for instant startup.
|
|
*/
|
|
export async function discoverClis(...dirs: string[]): Promise<void> {
|
|
// Fast path: try manifest first (production / post-build)
|
|
for (const dir of dirs) {
|
|
const manifestPath = path.resolve(dir, '..', 'cli-manifest.json');
|
|
if (fs.existsSync(manifestPath)) {
|
|
loadFromManifest(manifestPath, dir);
|
|
continue; // Skip filesystem scan for this directory
|
|
}
|
|
// Fallback: runtime filesystem scan (development)
|
|
await discoverClisFromFs(dir);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fast-path: register commands from pre-compiled manifest.
|
|
* YAML pipelines are inlined — zero YAML parsing at runtime.
|
|
* TS modules are deferred — loaded lazily on first execution.
|
|
*/
|
|
function loadFromManifest(manifestPath: string, clisDir: string): void {
|
|
try {
|
|
const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf-8')) as any[];
|
|
for (const entry of manifest) {
|
|
if (entry.type === 'yaml') {
|
|
// YAML pipelines fully inlined in manifest — register directly
|
|
const strategy = (Strategy as any)[entry.strategy.toUpperCase()] ?? Strategy.COOKIE;
|
|
const cmd: CliCommand = {
|
|
site: entry.site,
|
|
name: entry.name,
|
|
description: entry.description ?? '',
|
|
domain: entry.domain,
|
|
strategy,
|
|
browser: entry.browser,
|
|
args: entry.args ?? [],
|
|
columns: entry.columns,
|
|
pipeline: entry.pipeline,
|
|
timeoutSeconds: entry.timeout,
|
|
source: `manifest:${entry.site}/${entry.name}`,
|
|
};
|
|
registerCommand(cmd);
|
|
} else if (entry.type === 'ts' && entry.modulePath) {
|
|
// TS adapters: register a lightweight stub.
|
|
// The actual module is loaded lazily on first executeCommand().
|
|
const strategy = (Strategy as any)[(entry.strategy ?? 'cookie').toUpperCase()] ?? Strategy.COOKIE;
|
|
const modulePath = path.resolve(clisDir, entry.modulePath);
|
|
const cmd: InternalCliCommand = {
|
|
site: entry.site,
|
|
name: entry.name,
|
|
description: entry.description ?? '',
|
|
domain: entry.domain,
|
|
strategy,
|
|
browser: entry.browser ?? true,
|
|
args: entry.args ?? [],
|
|
columns: entry.columns,
|
|
timeoutSeconds: entry.timeout,
|
|
source: modulePath,
|
|
_lazy: true,
|
|
_modulePath: modulePath,
|
|
};
|
|
registerCommand(cmd);
|
|
}
|
|
}
|
|
} catch (err: any) {
|
|
process.stderr.write(`Warning: failed to load manifest ${manifestPath}: ${err.message}\n`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fallback: traditional filesystem scan (used during development with tsx).
|
|
*/
|
|
async function discoverClisFromFs(dir: string): Promise<void> {
|
|
if (!fs.existsSync(dir)) return;
|
|
const promises: Promise<any>[] = [];
|
|
for (const site of fs.readdirSync(dir)) {
|
|
const siteDir = path.join(dir, site);
|
|
if (!fs.statSync(siteDir).isDirectory()) continue;
|
|
for (const file of fs.readdirSync(siteDir)) {
|
|
const filePath = path.join(siteDir, file);
|
|
if (file.endsWith('.yaml') || file.endsWith('.yml')) {
|
|
registerYamlCli(filePath, site);
|
|
} else if (file.endsWith('.js') && !file.endsWith('.d.js')) {
|
|
promises.push(
|
|
import(`file://${filePath}`).catch((err: any) => {
|
|
process.stderr.write(`Warning: failed to load module ${filePath}: ${err.message}\n`);
|
|
})
|
|
);
|
|
}
|
|
}
|
|
}
|
|
await Promise.all(promises);
|
|
}
|
|
|
|
function registerYamlCli(filePath: string, defaultSite: string): void {
|
|
try {
|
|
const raw = fs.readFileSync(filePath, 'utf-8');
|
|
const def = yaml.load(raw) as any;
|
|
if (!def || typeof def !== 'object') return;
|
|
|
|
const site = def.site ?? defaultSite;
|
|
const name = def.name ?? path.basename(filePath, path.extname(filePath));
|
|
const strategyStr = def.strategy ?? (def.browser === false ? 'public' : 'cookie');
|
|
const strategy = (Strategy as any)[strategyStr.toUpperCase()] ?? Strategy.COOKIE;
|
|
const browser = def.browser ?? (strategy !== Strategy.PUBLIC);
|
|
|
|
const args: Arg[] = [];
|
|
if (def.args && typeof def.args === 'object') {
|
|
for (const [argName, argDef] of Object.entries(def.args as Record<string, any>)) {
|
|
args.push({
|
|
name: argName,
|
|
type: argDef?.type ?? 'str',
|
|
default: argDef?.default,
|
|
required: argDef?.required ?? false,
|
|
help: argDef?.description ?? argDef?.help ?? '',
|
|
choices: argDef?.choices,
|
|
});
|
|
}
|
|
}
|
|
|
|
const cmd: CliCommand = {
|
|
site,
|
|
name,
|
|
description: def.description ?? '',
|
|
domain: def.domain,
|
|
strategy,
|
|
browser,
|
|
args,
|
|
columns: def.columns,
|
|
pipeline: def.pipeline,
|
|
timeoutSeconds: def.timeout,
|
|
source: filePath,
|
|
};
|
|
|
|
registerCommand(cmd);
|
|
} catch (err: any) {
|
|
process.stderr.write(`Warning: failed to load ${filePath}: ${err.message}\n`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Execute a CLI command. Handles lazy-loading of TS modules.
|
|
*/
|
|
export async function executeCommand(
|
|
cmd: CliCommand,
|
|
page: IPage | null,
|
|
kwargs: Record<string, any>,
|
|
debug: boolean = false,
|
|
): Promise<any> {
|
|
// Lazy-load TS module on first execution
|
|
const internal = cmd as InternalCliCommand;
|
|
if (internal._lazy && internal._modulePath) {
|
|
const modulePath = internal._modulePath;
|
|
if (!_loadedModules.has(modulePath)) {
|
|
try {
|
|
await import(`file://${modulePath}`);
|
|
_loadedModules.add(modulePath);
|
|
} catch (err: any) {
|
|
throw new Error(`Failed to load adapter module ${modulePath}: ${err.message}`);
|
|
}
|
|
}
|
|
// After loading, the module's cli() call will have updated the registry
|
|
// with the real func/pipeline. Re-fetch the command.
|
|
const { getRegistry, fullName } = await import('./registry.js');
|
|
const updated = getRegistry().get(fullName(cmd));
|
|
if (updated && updated.func) {
|
|
return updated.func(page, kwargs, debug);
|
|
}
|
|
if (updated && updated.pipeline) {
|
|
return executePipeline(page, updated.pipeline, { args: kwargs, debug });
|
|
}
|
|
}
|
|
|
|
if (cmd.func) {
|
|
return cmd.func(page, kwargs, debug);
|
|
}
|
|
if (cmd.pipeline) {
|
|
return executePipeline(page, cmd.pipeline, { args: kwargs, debug });
|
|
}
|
|
throw new Error(`Command ${cmd.site}/${cmd.name} has no func or pipeline`);
|
|
}
|