94f0cadea3
Partially fixes https://github.com/microsoft/playwright/issues/31337 by supporting ignoring node_modules on windows. When I debug the function it gets a unix style path filename on windows, so the function never ignores node_modules. The ignore path globs are expected to use the unix path seperator and I've tested this fix works on windows and I assume that since mac uses unix style, it also works there (this is a pretty standard glob construct (chokidar points at any match https://github.com/micromatch/anymatch and anymatch has this exact example in their readme.md) Signed-off-by: Luke Page <137174537+lukpsaxo@users.noreply.github.com>
77 lines
2.6 KiB
TypeScript
77 lines
2.6 KiB
TypeScript
/**
|
|
* Copyright (c) Microsoft Corporation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { chokidar } from './utilsBundle';
|
|
import type { FSWatcher } from 'chokidar';
|
|
|
|
export type FSEvent = { event: 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir', file: string };
|
|
|
|
export class Watcher {
|
|
private _onChange: (events: FSEvent[]) => void;
|
|
private _watchedFiles: string[] = [];
|
|
private _ignoredFolders: string[] = [];
|
|
private _collector: FSEvent[] = [];
|
|
private _fsWatcher: FSWatcher | undefined;
|
|
private _throttleTimer: NodeJS.Timeout | undefined;
|
|
private _mode: 'flat' | 'deep';
|
|
|
|
constructor(mode: 'flat' | 'deep', onChange: (events: FSEvent[]) => void) {
|
|
this._mode = mode;
|
|
this._onChange = onChange;
|
|
}
|
|
|
|
update(watchedFiles: string[], ignoredFolders: string[], reportPending: boolean) {
|
|
if (JSON.stringify([this._watchedFiles, this._ignoredFolders]) === JSON.stringify(watchedFiles, ignoredFolders))
|
|
return;
|
|
|
|
if (reportPending)
|
|
this._reportEventsIfAny();
|
|
|
|
this._watchedFiles = watchedFiles;
|
|
this._ignoredFolders = ignoredFolders;
|
|
void this._fsWatcher?.close();
|
|
this._fsWatcher = undefined;
|
|
this._collector.length = 0;
|
|
clearTimeout(this._throttleTimer);
|
|
this._throttleTimer = undefined;
|
|
|
|
if (!this._watchedFiles.length)
|
|
return;
|
|
|
|
const ignored = [...this._ignoredFolders, '**/node_modules/**'];
|
|
this._fsWatcher = chokidar.watch(watchedFiles, { ignoreInitial: true, ignored }).on('all', async (event, file) => {
|
|
if (this._throttleTimer)
|
|
clearTimeout(this._throttleTimer);
|
|
if (this._mode === 'flat' && event !== 'add' && event !== 'change')
|
|
return;
|
|
if (this._mode === 'deep' && event !== 'add' && event !== 'change' && event !== 'unlink' && event !== 'addDir' && event !== 'unlinkDir')
|
|
return;
|
|
this._collector.push({ event, file });
|
|
this._throttleTimer = setTimeout(() => this._reportEventsIfAny(), 250);
|
|
});
|
|
}
|
|
|
|
async close() {
|
|
await this._fsWatcher?.close();
|
|
}
|
|
|
|
private _reportEventsIfAny() {
|
|
if (this._collector.length)
|
|
this._onChange(this._collector.slice());
|
|
this._collector.length = 0;
|
|
}
|
|
}
|