git-yike-logger-hook/dist/comment-scanner.d.ts

A TypeScript Git hook plugin for automatically generating commit logs with TODO/WIP comment scanning

import { CodeComment } from './types';
/**
 * JavaScript 文件注释扫描器
 */
export declare class CommentScanner {
    private supportedExtensions;
    private todoPatterns;
    private wipPatterns;
    /**
     * 扫描指定目录下的所有 JavaScript 文件，提取 TODO 和 WIP 注释
     */
    scanDirectory(dirPath: string): Promise<{
        todos: CodeComment[];
        wips: CodeComment[];
    }>;
    /**
     * 扫描单个文件
     */
    scanFile(filePath: string): Promise<{
        todos: CodeComment[];
        wips: CodeComment[];
    }>;
    /**
     * 获取目录下所有 JavaScript 文件
     */
    private getAllJavaScriptFiles;
    /**
     * 判断是否应该跳过某个目录
     */
    private shouldSkipDirectory;
    /**
     * 从文本中提取匹配的注释
     */
    private extractMatches;
    /**
     * 标准化文件路径（使用正斜杠）
     */
    private normalizePath;
    /**
     * 扫描工作区中变更的 JavaScript 文件
     */
    scanChangedFiles(changedFiles: {
        added: string[];
        modified: string[];
        deleted: string[];
    }): Promise<{
        todos: CodeComment[];
        wips: CodeComment[];
    }>;
    /**
     * 判断是否为 JavaScript 文件
     */
    private isJavaScriptFile;
}