chore: log 体系化

Author: trudbot

scripts/filename-lint.ts

@@ -2,8 +2,8 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import fs from 'fs';
 import sanitize from 'sanitize-filename';
-import chalk from 'chalk';
 import {traversal} from '../utils/fs-utils.js';
+import { logger } from '../utils/logger.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -24,6 +24,7 @@ export function lint() {
             const newFileName = fileNameLint(pth);
             if (pth !== newFileName) {
                 renameCount ++;
+                logger.warn('重命名', `${path.basename(pth)} -> ${path.basename(newFileName)}`);
             }
             fs.renameSync(pth, newFileName);
         } catch(e) {
@@ -33,9 +34,9 @@ export function lint() {
     });
 
     if (renameCount > 0) {
-        console.log(chalk.red.bold('filename lint失败, 已自动将路径非法字符改为"-", 请在git中review'));
+        logger.error('Lint 失败', '已自动修复非法文件名，请检查变更后重新提交。');
         process.exit(1);
     } else {
-        console.log(chalk.green.bold('filename lint完成, 没有不兼容的目录或文件名'));
+        logger.success('文件名检查通过');
     }
 }

scripts/pre-commit.ts

@@ -2,11 +2,11 @@ import { execSync } from 'child_process';
 import path from 'path';
 import matter from 'gray-matter';
 import fs from 'fs';
-import chalk from 'chalk';
 import { minimatch } from 'minimatch';
 import { lint } from './filename-lint.js';
 import {formatDate} from '../utils/date-format.js';
 import { genPostId } from '../utils/post-id';
+import { logger } from '../utils/logger.js';
 
 function decodeUtf8(str: string): string {
     str = str.replace(/\\(\d{3})/g, (_match: string, octal: string) => {
@@ -19,7 +19,7 @@ function decodeUtf8(str: string): string {
  * 在md文件的frontmatter中更新lastUpdated字段
  */
 try {
-    console.log(chalk.bgCyan.black.bold(' 1. Markdown 预处理 '), chalk.gray('(自动补充 frontmatter 信息)'));
+    logger.section('1. Markdown 预处理', '(自动补充 frontmatter 信息)');
     // 获取本次提交修改过的文件列表
     const modifiedFiles = execSync('git diff --cached --name-only', {encoding: 'utf-8'})
         .trim()
@@ -35,8 +35,8 @@ try {
         }).map(decodeUtf8);
 
     const mdFiles = modifiedFiles.filter(file => minimatch(file, '_posts/**/*.md')).filter(file => fs.existsSync(file));
-    console.log(chalk.cyan('  • 本次提交修改的文件: '), modifiedFiles);
-    console.log(chalk.cyan('  • 在_posts中的md文件:'), mdFiles);
+    logger.info('本次提交修改的文件: ', modifiedFiles);
+    logger.info('在_posts中的md文件:', mdFiles);
     mdFiles.forEach(file => {
         const pth = path.resolve(file);
         const content = fs.readFileSync(pth, {encoding: 'utf-8'});
@@ -48,22 +48,22 @@ try {
         // 无title字段则使用文件名
         if (!frontmatter.title) {
             frontmatter.title = fileName;
-            console.log(chalk.green('    ✔ 更新 Title: ') + chalk.yellow(fileName));
+            logger.success('更新 Title', fileName);
         }
 
         // 更新lastUpdated字段
         frontmatter.lastUpdated = formatDate(stats.mtime);
-        console.log(chalk.green('    ✔ 更新 LastUpdated: ') + chalk.yellow(fileName));
+        logger.success('更新 LastUpdated', fileName);
 
         if (!frontmatter.date) {
             const creationTime = stats.birthtime;
             frontmatter.date = formatDate(creationTime);
-            console.log(chalk.green('    ✔ 更新 Date: ') + chalk.yellow(fileName));
+            logger.success('更新 Date', fileName);
         }
 
         if (!frontmatter.id) {
             frontmatter.id = genPostId();
-            console.log(chalk.green('    ✔ 生成 ID: ') + chalk.yellow(fileName));
+            logger.success('生成 ID', fileName);
         }
 
         const newContent = matter.stringify(fileContent.content, frontmatter);
@@ -75,14 +75,14 @@ try {
     if (mdFiles.length > 0) {
         execSync(`git add ${mdFiles.map(file => `"${file}"`).join(' ')}`);
     } else {
-        console.log(chalk.gray('  - 没有需要更新的文件')); 
+        logger.gray('没有需要更新的文件'); 
     }
 
-    console.log('\n' + chalk.bgCyan.black.bold(' 2. FileName Lint '), chalk.gray('(检查文件名兼容性)'));
+    logger.section('2. FileName Lint', '(检查文件名兼容性)');
     lint();
-    console.log('\n' + chalk.green.bold('✨ Pre-commit hook completed successfully.'));
+    logger.complete('Pre-commit hook completed successfully.');
     process.exit(0);
 } catch (error) {
-    console.error('\n' + chalk.red.bold('✖ Error running pre-commit hook:'), error);
+    logger.error('Error running pre-commit hook:', error);
     process.exit(1);
 }

utils/logger.ts

@@ -0,0 +1,78 @@
+import chalk from 'chalk';
+
+export const logger = {
+    /**
+     * 打印章节标题
+     * @param title 标题文本
+     * @param subtitle 副标题/说明文本
+     */
+    section: (title: string, subtitle: string = '') => {
+        console.log('\n' + chalk.bgCyan.black.bold(` ${title} `) + (subtitle ? ' ' + chalk.gray(subtitle) : ''));
+    },
+
+    /**
+     * 打印信息列表项 (带 • 前缀)
+     * @param label 标签
+     * @param value 值 (可选)
+     */
+    info: (label: string, value?: object | Array<unknown> | string) => {
+        let msg = chalk.cyan(`  • ${label}`);
+        if (value !== undefined) {
+            // 如果是对象或数组，格式化一下，否则直接拼接
+            const valStr = typeof value === 'object' ? JSON.stringify(value) : String(value);
+            msg += ' ' + valStr;
+        }
+        console.log(msg);
+    },
+
+    /**
+     * 打印成功/完成的子项 (带 ✔ 前缀)
+     * @param label 动作描述
+     * @param detail 详细信息 (通常是文件名，会高亮显示)
+     */
+    success: (label: string, detail?: string) => {
+        let msg = chalk.green(`    ✔ ${label}`);
+        if (detail) {
+            msg += ': ' + chalk.yellow(detail);
+        }
+        console.log(msg);
+    },
+
+    /**
+     * 打印警告信息 (带 ⚠ 前缀)
+     * @param label 警告描述
+     * @param detail 详细信息
+     */
+    warn: (label: string, detail?: string) => {
+        let msg = chalk.yellow(`  ⚠ ${label}`);
+        if (detail) {
+            msg += ': ' + detail;
+        }
+        console.log(msg);
+    },
+
+    /**
+     * 打印错误信息 (带 ✖ 前缀)
+     * @param label 错误描述
+     * @param error 错误对象或详细信息
+     */
+    error: (label: string, error?: object | string | Array<unknown>) => {
+        console.error('\n' + chalk.red.bold(`✖ ${label}`), error || '');
+    },
+
+    /**
+     * 打印完成状态 (带 ✨ 前缀)
+     * @param message 完成信息
+     */
+    complete: (message: string) => {
+        console.log('\n' + chalk.green.bold(`✨ ${message}`));
+    },
+
+    /**
+     * 打印灰色的一般信息 (用于无操作等场景)
+     * @param message 信息文本
+     */
+    gray: (message: string) => {
+        console.log(chalk.gray(`  - ${message}`));
+    }
+};