File size: 2,686 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { watch, type FSWatcher } from 'chokidar';
import path from 'node:path';
export type FileWatcherEvent = {
eventType: 'add' | 'unlink' | 'addDir' | 'unlinkDir';
relativePath: string;
};
export type FileWatcherCallback = (event: FileWatcherEvent) => void;
type FileWatcherOptions = {
shouldIgnore?: (relativePath: string) => boolean;
onError?: (error: unknown) => void;
};
export class FileWatcher {
private watcher: FSWatcher | null = null;
constructor(
private readonly projectRoot: string,
private readonly onEvent: FileWatcherCallback,
private readonly options: FileWatcherOptions = {},
) {}
private normalizeRelativePath(filePath: string): string {
const relativeOrOriginal = path.isAbsolute(filePath)
? path.relative(this.projectRoot, filePath)
: filePath;
const normalized = relativeOrOriginal.replaceAll('\\', '/');
if (normalized === '' || normalized === '.') {
return '';
}
if (normalized.startsWith('./')) {
return normalized.slice(2);
}
return normalized;
}
start(): void {
if (this.watcher) {
return;
}
this.watcher = watch(this.projectRoot, {
cwd: this.projectRoot,
ignoreInitial: true,
awaitWriteFinish: false,
followSymlinks: false,
persistent: true,
ignored: (filePath: string) => {
if (!this.options.shouldIgnore) {
return false;
}
const relativePath = this.normalizeRelativePath(filePath);
if (!relativePath) {
return false;
}
return this.options.shouldIgnore(relativePath);
},
});
this.watcher
.on('add', (relativePath: string) => {
this.onEvent({
eventType: 'add',
relativePath: this.normalizeRelativePath(relativePath),
});
})
.on('unlink', (relativePath: string) => {
this.onEvent({
eventType: 'unlink',
relativePath: this.normalizeRelativePath(relativePath),
});
})
.on('addDir', (relativePath: string) => {
this.onEvent({
eventType: 'addDir',
relativePath: this.normalizeRelativePath(relativePath),
});
})
.on('unlinkDir', (relativePath: string) => {
this.onEvent({
eventType: 'unlinkDir',
relativePath: this.normalizeRelativePath(relativePath),
});
})
.on('error', (error: unknown) => {
this.options.onError?.(error);
});
}
async close(): Promise<void> {
await this.watcher?.close();
this.watcher = null;
}
}
|