@spyglassmc/core 0.4.42 → 0.4.44

package/lib/service/Project.js

@@ -6,7 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import picomatch from 'picomatch';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { bufferToString, Logger, normalizeUri, SingletonPromise, StateProxy, } from '../common/index.js';
+import { bufferToString, Logger, normalizeUri, SingletonPromise, StateProxy, UriStore, } from '../common/index.js';
 import { FileNode } from '../node/index.js';
 import { file } from '../parser/index.js';
 import { traversePreOrder } from '../processor/index.js';
@@ -73,11 +73,13 @@ export class Project {
     #symbolUpToDateUris = new Set();
     #eventEmitter;
     #initializers;
+    #watcher;
+    get watchedFiles() {
+        return this.#watcher?.watchedFiles ?? new UriStore();
+    }
     #initPromise;
     #readyPromise;
-    #watchedFiles = new Set();
-    #watcher;
-    #watcherReady = false;
+    #isInitialized = false;
     #isReady = false;
     get isReady() {
         return this.#isReady;
@@ -150,7 +152,7 @@ export class Project {
      * are not loaded into the memory.
      */
     getTrackedFiles() {
-        const supportedFiles = [...this.#dependencyFiles ?? [], ...this.#watchedFiles];
+        const supportedFiles = [...this.#dependencyFiles ?? [], ...this.watchedFiles];
         this.logger.info(`[Project#getTrackedFiles] Listed ${supportedFiles.length} supported files`);
         return supportedFiles;
     }
@@ -171,12 +173,11 @@ export class Project {
         this.logger.info(`[Project] [init] cacheRoot = ${cacheRoot}`);
         this.logger.info(`[Project] [init] projectRoots = ${projectRoots.join(' ')}`);
         this.#configService.on('changed', ({ config }) => {
+            const oldConfig = this.config;
             this.config = config;
             this.logger.info('[Project] [Config] Changed');
-            this.emit('configChanged', config);
+            this.emit('configChanged', { oldConfig, newConfig: config });
         }).on('error', ({ error, uri }) => this.logger.error(`[Project] [Config] Failed loading ${uri}`, error));
-        this.setInitPromise();
-        this.setReadyPromise();
         this.#cacheSaverIntervalId = setInterval(() => this.cacheService.save(), CacheAutoSaveInterval);
         this.on('documentUpdated', ({ doc, node }) => {
             // if (!this.#isReady) {
@@ -212,12 +213,19 @@ export class Project {
             // Recheck client managed files after the READY process, as they may have incomplete results and are user-facing.
             const promises = [];
             for (const { doc, node } of this.#clientManagedDocAndNodes.values()) {
-                promises.push(this.check(doc, node));
+                promises.push(this.bind(doc, node).then(() => this.check(doc, node)));
             }
             Promise.all(promises).catch(e => this.logger.error('[Project#ready] Error occurred when rechecking client managed files after READY', e));
         });
     }
-    setInitPromise() {
+    /**
+     * Load the config file and initialize parsers and processors.
+     */
+    async init() {
+        return (this.#initPromise ??= this.#init());
+    }
+    async #init() {
+        this.#isInitialized = false;
         const callIntializers = async () => {
             const initCtx = {
                 cacheRoot: this.cacheRoot,
@@ -240,20 +248,30 @@ export class Project {
             });
             this.#ctx = ctx;
         };
-        const init = async () => {
-            const __profiler = this.profilers.get('project#init');
-            const { symbols } = await this.cacheService.load();
-            this.symbols = new SymbolUtil(symbols, this.externals.event.EventEmitter);
-            this.symbols.buildCache();
-            __profiler.task('Load Cache');
-            this.config = await this.#configService.load();
-            __profiler.task('Load Config');
-            await callIntializers();
-            __profiler.task('Initialize').finalize();
-        };
-        this.#initPromise = init();
+        const __profiler = this.profilers.get('project#init');
+        const { symbols } = await this.cacheService.load();
+        this.symbols = new SymbolUtil(symbols, this.externals.event.EventEmitter);
+        this.symbols.buildCache();
+        __profiler.task('Load Cache');
+        this.config = await this.#configService.load();
+        __profiler.task('Load Config');
+        await callIntializers();
+        __profiler.task('Initialize').finalize();
+        this.#isInitialized = true;
+        return this;
+    }
+    /**
+     * Finish the initial run of parsing, binding, and checking the entire project.
+     */
+    async ready(options = {}) {
+        return (this.#readyPromise ??= this.#ready(options));
     }
-    setReadyPromise() {
+    async #ready({ projectRootsWatcher } = {}) {
+        if (!this.#isInitialized) {
+            throw new Error('Project.ready() must be called after Project.init() resolves');
+        }
+        this.#isReady = false;
+        this.#watcher = projectRootsWatcher;
         const getDependencies = async () => {
             const dependencies = [];
             for (const input of this.config.env.dependencies) {
@@ -292,119 +310,92 @@ export class Project {
             this.fs.register('file:', fileUriSupporter, true);
             this.fs.register(ArchiveUriSupporter.Protocol, archiveUriSupporter, true);
         };
-        const listProjectFiles = () => new Promise((resolve) => {
-            if (this.projectRoots.length === 0) {
-                resolve();
+        const listProjectFiles = async () => {
+            if (!this.#watcher) {
                 return;
             }
-            this.#watchedFiles.clear();
-            this.#watcherReady = false;
-            this.#watcher = this.externals.fs.watch(this.projectRoots, {
-                usePolling: this.config.env.useFilePolling,
-            }).once('ready', () => {
-                this.#watcherReady = true;
-                resolve();
-            }).on('add', (uri) => {
-                if (this.shouldExclude(uri)) {
-                    return;
-                }
-                this.#watchedFiles.add(uri);
-                if (this.#watcherReady) {
-                    this.emit('fileCreated', { uri });
-                }
-            }).on('change', (uri) => {
+            this.#watcher
+                .on('add', (uri) => {
                 if (this.shouldExclude(uri)) {
                     return;
                 }
-                if (this.#watcherReady) {
-                    this.emit('fileModified', { uri });
-                }
-            }).on('unlink', (uri) => {
+                this.emit('fileCreated', { uri });
+            })
+                .on('change', (uri) => {
                 if (this.shouldExclude(uri)) {
                     return;
                 }
-                this.#watchedFiles.delete(uri);
-                if (this.#watcherReady) {
-                    this.emit('fileDeleted', { uri });
-                }
-            }).on('error', (e) => {
-                this.logger.error('[Project] [chokidar]', e);
-            });
-        });
-        const ready = async () => {
-            await this.init();
-            const __profiler = this.profilers.get('project#ready');
-            await Promise.all([listDependencyFiles(), listProjectFiles()]);
-            this.#dependencyFiles = new Set([...this.fs.listFiles()]
-                .filter((uri) => !this.shouldExclude(uri)));
-            this.#dependencyRoots = new Set(this.fs.listRoots());
-            this.updateRoots();
-            __profiler.task('List URIs');
-            for (const [id, { checksum, registrar }] of this.meta.symbolRegistrars) {
-                const cacheChecksum = this.cacheService.checksums.symbolRegistrars[id];
-                if (cacheChecksum === undefined || checksum !== cacheChecksum) {
-                    this.symbols.clear({ contributor: `symbol_registrar/${id}` });
-                    this.symbols.contributeAs(`symbol_registrar/${id}`, () => {
-                        registrar(this.symbols, { logger: this.logger });
-                    });
-                    this.emit('symbolRegistrarExecuted', { id, checksum });
-                }
-                else {
-                    this.logger.info(`[SymbolRegistrar] Skipped “${id}” thanks to cache ${checksum}`);
-                }
-            }
-            __profiler.task('Register Symbols');
-            for (const [uri, values] of Object.entries(this.cacheService.errors)) {
-                this.emit('documentErrored', { errors: values, uri });
-            }
-            __profiler.task('Pop Errors');
-            const { addedFiles, changedFiles, removedFiles } = await this.cacheService.validate();
-            for (const uri of removedFiles) {
+                this.emit('fileModified', { uri });
+            })
+                .on('unlink', (uri) => {
+                // No `this.shouldExclude(uri)` check here as `unlink` events may be sent for
+                // hot-reload file exclusions. We want to be able to clean up the symbols for these
+                // excluded files.
                 this.emit('fileDeleted', { uri });
+            })
+                .on('error', (e) => {
+                this.logger.error('[Project#watcher]', e);
+            });
+            await this.#watcher.ready();
+        };
+        const __profiler = this.profilers.get('project#ready');
+        await Promise.all([listDependencyFiles(), listProjectFiles()]);
+        this.#dependencyFiles = new Set([...this.fs.listFiles()]
+            .filter((uri) => !this.shouldExclude(uri)));
+        this.#dependencyRoots = new Set(this.fs.listRoots());
+        this.updateRoots();
+        __profiler.task('List URIs');
+        for (const [id, { checksum, registrar }] of this.meta.symbolRegistrars) {
+            const cacheChecksum = this.cacheService.checksums.symbolRegistrars[id];
+            if (cacheChecksum === undefined || checksum !== cacheChecksum) {
+                this.symbols.clear({ contributor: `symbol_registrar/${id}` });
+                this.symbols.contributeAs(`symbol_registrar/${id}`, () => {
+                    registrar(this.symbols, { logger: this.logger });
+                });
+                this.emit('symbolRegistrarExecuted', { id, checksum });
             }
-            __profiler.task('Validate Cache');
-            if (addedFiles.length > 0) {
-                this.bindUri(addedFiles);
-            }
-            __profiler.task('Bind URIs');
-            const files = [...addedFiles, ...changedFiles].sort(this.meta.uriSorter);
-            __profiler.task('Sort URIs');
-            const fileCountByExtension = new Map();
-            for (const file of files) {
-                const ext = fileUtil.extname(file)?.replace(/^\./, '');
-                if (ext) {
-                    fileCountByExtension.set(ext, (fileCountByExtension.get(ext) ?? 0) + 1);
-                }
-            }
-            this.logger.info(`[Project#ready] == Files to bind ==`);
-            for (const [ext, count] of fileCountByExtension.entries()) {
-                this.logger.info(`[Project#ready] File extension ${ext}: ${count}`);
+            else {
+                this.logger.info(`[SymbolRegistrar] Skipped “${id}” thanks to cache ${checksum}`);
             }
-            const __bindProfiler = this.profilers.get('project#ready#bind', 'top-n', 50);
-            for (const uri of files) {
-                await this.ensureBindingStarted(uri);
-                __bindProfiler.task(uri);
+        }
+        __profiler.task('Register Symbols');
+        for (const [uri, values] of Object.entries(this.cacheService.errors)) {
+            this.emit('documentErrored', { errors: values, uri });
+        }
+        __profiler.task('Pop Errors');
+        const { addedFiles, changedFiles, removedFiles } = await this.cacheService.validate();
+        this.logger.info(`[Project#ready] Files added/changed/removed: ${addedFiles.length}/${changedFiles.length}/${removedFiles.length}`);
+        for (const uri of removedFiles) {
+            this.emit('fileDeleted', { uri });
+        }
+        __profiler.task('Validate Cache');
+        if (addedFiles.length > 0) {
+            this.bindUri(addedFiles);
+        }
+        __profiler.task('Bind URIs');
+        const files = [...addedFiles, ...changedFiles].sort(this.meta.uriSorter);
+        __profiler.task('Sort URIs');
+        const fileCountByExtension = new Map();
+        for (const file of files) {
+            const ext = fileUtil.extname(file)?.replace(/^\./, '');
+            if (ext) {
+                fileCountByExtension.set(ext, (fileCountByExtension.get(ext) ?? 0) + 1);
             }
-            __bindProfiler.finalize();
-            __profiler.task('Bind Files');
-            __profiler.finalize();
-            this.emit('ready', {});
-        };
-        this.#isReady = false;
-        this.#readyPromise = ready();
-    }
-    /**
-     * Load the config file and initialize parsers and processors.
-     */
-    async init() {
-        await this.#initPromise;
-        return this;
-    }
-    /**
-     * Finish the initial run of parsing, binding, and checking the entire project.
-     */
-    async ready() {
-        await this.#readyPromise;
+        }
+        this.logger.info(`[Project#ready] == Files to bind ==`);
+        for (const [ext, count] of fileCountByExtension.entries()) {
+            this.logger.info(`[Project#ready] File extension ${ext}: ${count}`);
+        }
+        const __bindProfiler = this.profilers.get('project#ready#bind', 'top-n', 50);
+        for (const uri of files) {
+            await this.ensureBindingStarted(uri);
+            __bindProfiler.task(uri);
+        }
+        __bindProfiler.finalize();
+        __profiler.task('Bind Files');
+        __profiler.finalize();
+        this.emit('ready', {});
+        this.#isReady = true;
         return this;
     }
     /**
@@ -412,15 +403,14 @@ export class Project {
      */
     async close() {
         clearInterval(this.#cacheSaverIntervalId);
-        await this.#watcher.close();
+        await this.#watcher?.close();
         await this.cacheService.save();
     }
     async restart() {
         try {
-            await this.#watcher.close();
             this.#bindingInProgressUris.clear();
             this.#symbolUpToDateUris.clear();
-            this.setReadyPromise();
+            this.#readyPromise = undefined;
             await this.ready();
         }
         catch (e) {
@@ -770,13 +760,16 @@ export class Project {
     shouldRemove(uri) {
         return (!this.#clientManagedUris.has(uri)
             && !this.#dependencyFiles?.has(uri)
-            && !this.#watchedFiles.has(uri));
+            && !this.watchedFiles.has(uri));
     }
     isOnlyWatched(uri) {
-        return (this.#watchedFiles.has(uri)
+        return (this.watchedFiles.has(uri)
             && !this.#clientManagedUris.has(uri)
             && !this.#dependencyFiles?.has(uri));
     }
+    async onEditorConfigurationUpdate(editorConfiguration) {
+        await this.#configService.onEditorConfigurationUpdate(editorConfiguration);
+    }
 }
 __decorate([
     SingletonPromise()

package/lib/service/Service.d.ts

@@ -28,7 +28,7 @@ export declare class Service {
     getCodeActions(node: FileNode<AstNode>, doc: TextDocument, range: Range): readonly CodeAction[];
     getColorInfo(node: FileNode<AstNode>, doc: TextDocument): ColorInfo[];
     getColorPresentation(file: FileNode<AstNode>, doc: TextDocument, range: Range, color: Color): ColorPresentation[];
-    complete(node: FileNode<AstNode>, doc: TextDocument, offset: number, triggerCharacter?: string): import("../index.js").CompletionItem[];
+    complete(node: FileNode<AstNode>, doc: TextDocument, offset: number, triggerCharacter?: string): import("../processor/index.js").CompletionItem[];
     dataHackPubify(initialism: string): string;
     format(node: FileNode<AstNode>, doc: TextDocument, tabSize: number, insertSpaces: boolean): string;
     getHover(file: FileNode<AstNode>, doc: TextDocument, offset: number): Hover | undefined;

package/lib/service/fileUtil.d.ts

@@ -1,4 +1,5 @@
 import type { Externals, FsLocation } from '../common/index.js';
+import { Uri } from '../common/index.js';
 export type RootUriString = `${string}/`;
 export type FileExtension = `.${string}`;
 export declare namespace fileUtil {
@@ -35,6 +36,7 @@ export declare namespace fileUtil {
     function getRoot(uri: string, rootUris: readonly RootUriString[]): string | undefined;
     function isRootUri(uri: string): uri is RootUriString;
     function ensureEndingSlash(uri: string): RootUriString;
+    function trimEndingSlash(uri: string): string;
     function join(fromUri: string, toUri: string): string;
     function isFileUri(uri: string): boolean;
     /**
@@ -49,7 +51,7 @@ export declare namespace fileUtil {
      * @returns The part from the beginning of the URI to the last `/`.
      */
     function dirname(uri: string): string;
-    function getParentOfFile(externals: Externals, path: FsLocation): FsLocation;
+    function getParentOfUri(uri: FsLocation): Uri;
     /**
      * @throws
      *

package/lib/service/fileUtil.js

@@ -82,6 +82,10 @@ export var fileUtil;
         return isRootUri(uri) ? uri : `${uri}/`;
     }
     fileUtil.ensureEndingSlash = ensureEndingSlash;
+    function trimEndingSlash(uri) {
+        return isRootUri(uri) ? uri.slice(0, -1) : uri;
+    }
+    fileUtil.trimEndingSlash = trimEndingSlash;
     function join(fromUri, toUri) {
         return (ensureEndingSlash(fromUri) + (toUri.startsWith('/') ? toUri.slice(1) : toUri));
     }
@@ -115,10 +119,10 @@ export var fileUtil;
     }
     fileUtil.dirname = dirname;
     /* istanbul ignore next */
-    function getParentOfFile(externals, path) {
-        return new Uri('.', path);
+    function getParentOfUri(uri) {
+        return new Uri('.', trimEndingSlash(uri.toString()));
     }
-    fileUtil.getParentOfFile = getParentOfFile;
+    fileUtil.getParentOfUri = getParentOfUri;
     /* istanbul ignore next */
     /**
      * @throws
@@ -145,7 +149,7 @@ export var fileUtil;
      * @param mode Default to `0o777` (`rwxrwxrwx`)
      */
     async function ensureParentOfFile(externals, path, mode = 0o777) {
-        return ensureDir(externals, getParentOfFile(externals, path), mode);
+        return ensureDir(externals, getParentOfUri(path), mode);
     }
     fileUtil.ensureParentOfFile = ensureParentOfFile;
     async function chmod(externals, path, mode) {

package/lib/service/index.d.ts

@@ -6,6 +6,7 @@ export * from './ErrorReporter.js';
 export * from './fetcher.js';
 export { FileService, UriProtocolSupporter } from './FileService.js';
 export * from './fileUtil.js';
+export * from './FileWatcher.js';
 export * from './Hover.js';
 export * from './MetaRegistry.js';
 export * from './Profiler.js';

package/lib/service/index.js

@@ -7,6 +7,7 @@ export * from './ErrorReporter.js';
 export * from './fetcher.js';
 export { FileService } from './FileService.js';
 export * from './fileUtil.js';
+export * from './FileWatcher.js';
 export * from './Hover.js';
 export * from './MetaRegistry.js';
 export * from './Profiler.js';