使用oakLogger搭配esbuild插件,替代了之前的日志实现方式

This commit is contained in:
Pan Qiancheng 2024-11-10 12:39:34 +08:00
parent 00bdc8b896
commit d3186240fa
5 changed files with 77 additions and 12 deletions

View File

@ -69,6 +69,49 @@ const esbuildProblemMatcherPlugin = {
}, },
}; };
/**
* @type {import('esbuild').Plugin}
*/
const loggerPlugin = {
name: 'logger-plugin',
setup(build) {
build.onLoad({ filter: /\.ts$/ }, async (args) => {
if (
['logger.ts', 'analyzeWorker.ts'].includes(
path.basename(args.path)
)
) {
return;
}
const contents = await fs.readFile(args.path, 'utf8');
const transformed = contents.replace(
/(console\.)(log|error|warn)\(/g,
(match, p1, p2) => {
const method =
p2 === 'log'
? 'log'
: p2 === 'error'
? 'error'
: 'warn';
console.log(
`transform: ${path.basename(
args.path
)} ${match} to oakLogger.${method}(`
);
return `oakLogger.${method}(`;
}
);
// 添加import oakLogger from './oakLogger';
const contentsAdd = `import oakLogger from '@/utils/logger';\n${transformed}`;
return { contents: contentsAdd, loader: 'ts' };
});
},
};
async function main() { async function main() {
const ctx = await esbuild.context({ const ctx = await esbuild.context({
entryPoints: [ entryPoints: [
@ -94,7 +137,12 @@ async function main() {
/* add to the end of plugins array */ /* add to the end of plugins array */
esbuildProblemMatcherPlugin, esbuildProblemMatcherPlugin,
copyTemplatesPlugin, copyTemplatesPlugin,
loggerPlugin,
], ],
// 路径别名
alias: {
'@': path.resolve(__dirname, 'src'),
},
}); });
if (watch) { if (watch) {
await ctx.watch(); await ctx.watch();

View File

@ -280,7 +280,7 @@ export async function activate(context: vscode.ExtensionContext) {
return; return;
} }
const projectHome = join(uri.fsPath, '..', config.projectDir); const projectHome = join(uri.fsPath, '..', config.projectDir);
log('projectHome:', projectHome); log('log', 'projectHome:', projectHome);
// 设置projectHome // 设置projectHome
setProjectHome(projectHome); setProjectHome(projectHome);
// 通知已经启用 // 通知已经启用

View File

@ -1,9 +1,10 @@
import * as vscode from 'vscode'; import * as vscode from 'vscode';
// 通过createOutputChannel创建一个输出频道 // 通过createOutputChannel创建一个输出频道
export const logger = vscode.window.createOutputChannel('oak-assistant'); export const logger = vscode.window.createOutputChannel('oak-assistant');
// 输出日志 // 输出日志
export const log = (...message: any[]) => { export const log = (level: 'log' | 'warn' | 'error' = 'log', ...message: any[]) => {
// 将日志信息输出到频道。需要判断类型 // 将日志信息输出到频道。需要判断类型
const msg: string[] = message.map((msg) => { const msg: string[] = message.map((msg) => {
if (typeof msg === 'object') { if (typeof msg === 'object') {
@ -14,27 +15,34 @@ export const log = (...message: any[]) => {
return msg; return msg;
} }
}); });
logger.appendLine(msg.join(' ')); const prefix = {
// log: '\x1b[32m[INFO] \x1b[0m', // 绿色
// warn: '\x1b[33m[WARN] \x1b[0m', // 黄色
// error: '\x1b[31m[ERROR] \x1b[0m' // 红色
log: '[INFO] ',
warn: '[WARN] ',
error: '[ERROR] '
}[level];
logger.appendLine(`${prefix}${msg.join(' ')}`);
}; };
// polyfill全局的console对象重定向到输出频道 const oakLogger = {
const console = global.console;
global.console = {
...console,
log: (...args: any[]) => { log: (...args: any[]) => {
console.log(...args); console.log(...args);
log(...args); log('log', ...args);
}, },
error: (...args: any[]) => { error: (...args: any[]) => {
console.error(...args); console.error(...args);
log(...args); log('error', ...args);
}, },
warn: (...args: any[]) => { warn: (...args: any[]) => {
console.warn(...args); console.warn(...args);
log(...args); log('warn', ...args);
}, },
info: (...args: any[]) => { info: (...args: any[]) => {
console.info(...args); console.info(...args);
log(...args); log('log', ...args);
}, },
}; };
export default oakLogger;

View File

@ -79,7 +79,6 @@ export const loadConfig = () => {
const content = fs.readFileSync(path, 'utf-8'); const content = fs.readFileSync(path, 'utf-8');
const config = JSON.parse(content); const config = JSON.parse(content);
cachedConfig = deepMergeObject(defaultConfig, config); cachedConfig = deepMergeObject(defaultConfig, config);
console.log('load config:', cachedConfig); console.log('load config:', cachedConfig);
}; };

10
types.d.ts vendored Normal file
View File

@ -0,0 +1,10 @@
export {}; // This ensures the file is treated as a module
declare global {
interface oakLogger {
log: (...args: any[]) => void;
error: (...args: any[]) => void;
warn: (...args: any[]) => void;
info: (...args: any[]) => void;
}
}