import { type PluginOptions } from '../interfaces.js'; /** * The `FileWatcher` class provides functionalities to monitor files and directories * for changes. It leverages the `chokidar` library to efficiently watch files and * react to changes by updating the documentation accordingly. */ declare class FileWatcher { private readonly options; private readonly parsedArgs; /** * Initializes a new instance of the FileWatcher class. * * @param {PluginOptions} options - Configuration options and plugin options. */ constructor(options: PluginOptions); /** * Starts the file watching process if the "watch" argument is provided. * Outputs a message to the console indicating the start of the watching process. */ watch(): void; /** * Configures and returns a file watcher instance targeting the source folder * and README files. * * @returns {chokidar.FSWatcher} An instance of the file watcher. */ private setupFileWatcher; /** * Handles events when a file changes. It updates the documentation and * outputs relevant messages to the console. * * @param {string} path - The path of the file that changed. */ private handleFileChange; /** * Clears the console to provide a clean output for subsequent messages. */ private clearConsole; /** * Determines if the specified file is a README file. * * @param {string} path - The path of the file to check. * @param {string} srcFolder - The source directory path. * @returns {boolean} True if the file is a README file, otherwise false. */ private isReadmeFile; /** * Processes and updates the documentation for the specified file. * * @param {DirectoryFile} file - Details of the file to update. */ private updateDocumentationFile; } export default FileWatcher; //# sourceMappingURL=file-watcher.d.ts.map