Method watchFiles

src/helpViewer/helpPreviewer.ts:134–185

()

    // Is only called once as part of the constructor
    // It is expected that this instance will be disposed if this method returns false
    private watchFiles(): boolean {
        // Only watch any files, if both man dir and DESCRIPTION exist
        if(!isFileSafe(this.descriptionPath) || !isDirSafe(this.manDir)){
            return false;
        }

        // Prepare listeners
        const errorListener = () => {
            console.log(`Disposing previewer for pkgDir: ${this.packageDir}`);
            void this.dispose(true);
        };
        const descriptionListener: fs.WatchListener<string> = () => {
            this.cachedPackageInfo = undefined;
            this.callPreviewListener();
        };
        const manDirListener: fs.WatchListener<string | null> = (event: fs.WatchEventType, filename: string | null) => {
            if(this.isDisposed){
                return;
            }
            if(!isDirSafe(this.manDir)){
                this.dispose(true);
                return;
            }
            if (filename === null) {
                return;
            }
            const fullPath = path.join(this.manDir, filename);
            // The cache is only initialized when it is needed for the first time:
            if(this.cachedRdAliases){
                const rdAlias = getRdAlias(fullPath);
                if(rdAlias){
                    this.cachedRdAliases.set(fullPath, rdAlias);
                } else{
                    this.cachedRdAliases.delete(fullPath);
                }
            }
            this.callPreviewListener();
        };

        // Watch man dir/DESCRIPTION
        const descWatcher = fs.watch(this.descriptionPath, {encoding: 'utf-8'});
        descWatcher.on('change', descriptionListener);
        descWatcher.on('error', errorListener);
        this.fileWatchers.push(descWatcher);

        const manDirWatcher = fs.watch(this.manDir, {encoding: 'utf-8'});
        manDirWatcher.on('change', manDirListener);
        manDirWatcher.on('error', errorListener);
        this.fileWatchers.push(manDirWatcher);

        return true;
    }

    public getPackageInfo(): LocalPackageInfo | undefined {
        if(this.cachedPackageInfo){