进阶 oclif.io 2026-10-18 02:37:03 · 26 阅读

第36章 日志

Logging 日志 默认情况下,oclif 使用 debug 库生成调试日志,可通过 DEBUG 环境变量查看。要查看所有日志,可设置 DEBUG=oclif*。 若希望将 oclif 的日志输出到自定义 logger 而非 debug,可以为 oclif 提供自定义 logger。 以下是 logger 必须遵循的接口: export type Logger = {
debug: (formatter: unknown, ...args: unknown[]) => void
error: (formatter: unknown, ...args: unknown[]) => void
info: (formatter: unknown, ...args: unknown[]) => void
trace: (formatter: unknown, ...args: unknown[]) => void
warn: (formatter: unknown, ...args: unknown[]) => void
child: (namespace: string) => Logger
namespace: string
}
示例如下: // oclif-logger.ts
import { format } from 'node:util';
import { Interfaces } from '@oclif/core';
import { Logger } from './my-cli-logger';

export const customLogger = (namespace: string): Interfaces.Logger => {
const myLogger = new Logger(namespace);
return {
child: (ns: string, delimiter?: string) => customLogger(`${namespace}${delimiter ?? ':'}${ns}`),
debug: (formatter: unknown, ...args: unknown[]) => myLogger.debug(format(formatter, ...args)),
error: (formatter: unknown, ...args: unknown[]) => myLogger.error(format(formatter, ...args)),
info: (formatter: unknown, ...args: unknown[]) => myLogger.info(format(formatter, ...args)),
trace: (formatter: unknown, ...args: unknown[]) => myLogger.trace(format(formatter, ...args)),
warn: (formatter: unknown, ...args: unknown[]) => myLogger.warn(format(formatter, ...args)),
namespace,
};
};

export const logger = customLogger('my-cli');
接下来,需要将该 logger 提供给 oclif 以便其使用: // bin/run.js
#!/usr/bin/env node

async function main() {
const {execute} = await import('@oclif/core');
const { logger } = await import('../dist/oclif-logger.js');
await oclif.execute({
dir: import.meta.url,
loadOptions: {
root: import.meta.dirname,
logger,
},
});
}

await main();
如果先实例化 Config 再调用 run 或 execute,也可以将 logger 传递给 Config: import {Config, run} from '@oclif/core'
const config = await config.load({
logger,
});

await run(process.argv.slice(2), config)

评论 (0)