@spyglassmc/core 0.1.0 → 0.2.0

package/lib/service/Profiler.js

@@ -1,66 +1,52 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _ProfilerImpl_finalized, _ProfilerImpl_startTime, _ProfilerImpl_lastTime, _ProfilerImpl_tasks, _ProfilerImpl_longestTaskNameLength, _ProfilerFactory_enabledProfilers;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProfilerFactory = void 0;
-const perf_hooks_1 = require("perf_hooks");
-const Logger_1 = require("./Logger");
+import { Logger } from './Logger.js';
 const TotalTaskName = 'Total';
 class ProfilerImpl {
+    id;
+    logger;
+    #finalized = false;
+    #startTime;
+    #lastTime;
+    #tasks = [];
+    #longestTaskNameLength = 0;
     constructor(id, logger) {
         this.id = id;
         this.logger = logger;
-        _ProfilerImpl_finalized.set(this, false);
-        _ProfilerImpl_startTime.set(this, void 0);
-        _ProfilerImpl_lastTime.set(this, void 0);
-        _ProfilerImpl_tasks.set(this, []);
-        _ProfilerImpl_longestTaskNameLength.set(this, 0);
-        __classPrivateFieldSet(this, _ProfilerImpl_startTime, __classPrivateFieldSet(this, _ProfilerImpl_lastTime, perf_hooks_1.performance.now(), "f"), "f");
+        this.#startTime = this.#lastTime = performance.now();
     }
     task(name) {
-        if (__classPrivateFieldGet(this, _ProfilerImpl_finalized, "f")) {
+        if (this.#finalized) {
             throw new Error('The profiler is finalized.');
         }
-        const time = perf_hooks_1.performance.now();
-        __classPrivateFieldGet(this, _ProfilerImpl_tasks, "f").push([name, time - __classPrivateFieldGet(this, _ProfilerImpl_lastTime, "f")]);
-        __classPrivateFieldSet(this, _ProfilerImpl_lastTime, time, "f");
-        __classPrivateFieldSet(this, _ProfilerImpl_longestTaskNameLength, Math.max(__classPrivateFieldGet(this, _ProfilerImpl_longestTaskNameLength, "f"), name.length), "f");
+        const time = performance.now();
+        this.#tasks.push([name, time - this.#lastTime]);
+        this.#lastTime = time;
+        this.#longestTaskNameLength = Math.max(this.#longestTaskNameLength, name.length);
         this.logger.info(`[Profiler: ${this.id}] Done: ${name}`);
         return this;
     }
     finalize() {
-        __classPrivateFieldSet(this, _ProfilerImpl_finalized, true, "f");
-        __classPrivateFieldGet(this, _ProfilerImpl_tasks, "f").push([TotalTaskName, __classPrivateFieldGet(this, _ProfilerImpl_lastTime, "f") - __classPrivateFieldGet(this, _ProfilerImpl_startTime, "f")]);
-        __classPrivateFieldSet(this, _ProfilerImpl_longestTaskNameLength, Math.max(__classPrivateFieldGet(this, _ProfilerImpl_longestTaskNameLength, "f"), TotalTaskName.length), "f");
+        this.#finalized = true;
+        this.#tasks.push([TotalTaskName, this.#lastTime - this.#startTime]);
+        this.#longestTaskNameLength = Math.max(this.#longestTaskNameLength, TotalTaskName.length);
         this.logger.info(`[Profiler: ${this.id}] == Summary ==`);
-        for (const [name, time] of __classPrivateFieldGet(this, _ProfilerImpl_tasks, "f")) {
-            this.logger.info(`[Profiler: ${this.id}] ${name}${' '.repeat(__classPrivateFieldGet(this, _ProfilerImpl_longestTaskNameLength, "f") - name.length)} - ${time} ms`);
+        for (const [name, time] of this.#tasks) {
+            this.logger.info(`[Profiler: ${this.id}] ${name}${' '.repeat(this.#longestTaskNameLength - name.length)} - ${time} ms`);
         }
     }
 }
-_ProfilerImpl_finalized = new WeakMap(), _ProfilerImpl_startTime = new WeakMap(), _ProfilerImpl_lastTime = new WeakMap(), _ProfilerImpl_tasks = new WeakMap(), _ProfilerImpl_longestTaskNameLength = new WeakMap();
 class NoopImpl {
     task() { return this; }
     finalize() { }
 }
-class ProfilerFactory {
+export class ProfilerFactory {
+    logger;
+    #enabledProfilers;
     constructor(logger, enabledProfilers) {
         this.logger = logger;
-        _ProfilerFactory_enabledProfilers.set(this, void 0);
-        __classPrivateFieldSet(this, _ProfilerFactory_enabledProfilers, new Set(enabledProfilers), "f");
+        this.#enabledProfilers = new Set(enabledProfilers);
     }
     get(id) {
-        if (__classPrivateFieldGet(this, _ProfilerFactory_enabledProfilers, "f").has(id)) {
+        if (this.#enabledProfilers.has(id)) {
             return new ProfilerImpl(id, this.logger);
         }
         else {
@@ -68,9 +54,7 @@ class ProfilerFactory {
         }
     }
     static noop() {
-        return new ProfilerFactory(Logger_1.Logger.noop(), []);
+        return new ProfilerFactory(Logger.noop(), []);
     }
 }
-exports.ProfilerFactory = ProfilerFactory;
-_ProfilerFactory_enabledProfilers = new WeakMap();
 //# sourceMappingURL=Profiler.js.map

package/lib/service/Project.d.ts

@@ -1,32 +1,33 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
 import type { TextDocumentContentChangeEvent } from 'vscode-languageserver-textdocument';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import type { AstNode } from '../node';
-import { FileNode } from '../node';
-import type { LanguageError } from '../source';
-import { SymbolUtil } from '../symbol';
-import { CacheService } from './CacheService';
-import type { Config } from './Config';
-import { Downloader } from './Downloader';
-import { FileService } from './FileService';
-import type { RootUriString } from './fileUtil';
-import { Logger } from './Logger';
-import { MetaRegistry } from './MetaRegistry';
-import { ProfilerFactory } from './Profiler';
-export declare type ProjectInitializerContext = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'logger' | 'meta' | 'projectRoot'>;
+import type { ExternalEventEmitter, Externals } from '../common/index.js';
+import type { AstNode } from '../node/index.js';
+import { FileNode } from '../node/index.js';
+import type { LanguageError } from '../source/index.js';
+import { SymbolUtil } from '../symbol/index.js';
+import { CacheService } from './CacheService.js';
+import type { Config } from './Config.js';
+import { Downloader } from './Downloader.js';
+import { FileService } from './FileService.js';
+import type { RootUriString } from './fileUtil.js';
+import { Logger } from './Logger.js';
+import { MetaRegistry } from './MetaRegistry.js';
+import { ProfilerFactory } from './Profiler.js';
+export declare type ProjectInitializerContext = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'externals' | 'logger' | 'meta' | 'projectRoot'>;
 export declare type ProjectInitializer = (this: void, ctx: ProjectInitializerContext) => PromiseLike<Record<string, string> | void> | Record<string, string> | void;
-interface Options {
-    cacheRoot: string;
+export interface ProjectOptions {
+    cacheRoot: RootUriString;
+    defaultConfig?: Config;
     downloader?: Downloader;
+    externals: Externals;
     fs?: FileService;
     initializers?: readonly ProjectInitializer[];
     logger?: Logger;
     profilers?: ProfilerFactory;
     /**
-     * A file path to the root of this project.
+     * A file URI to the root of this project.
      */
-    projectPath: string;
+    projectRoot: RootUriString;
     symbols?: SymbolUtil;
 }
 export interface DocAndNode {
@@ -50,47 +51,22 @@ interface SymbolRegistrarEvent {
     id: string;
     checksum: string | undefined;
 }
-export declare type ProjectData = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'ensureParsedAndChecked' | 'fs' | 'get' | 'logger' | 'meta' | 'profilers' | 'projectRoot' | 'roots' | 'symbols' | 'ctx'>;
-export declare namespace ProjectData {
-    function mock(data?: Partial<ProjectData>): ProjectData;
-}
-export interface Project extends EventEmitter {
-    on(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
-    on(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
-    on(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
-    on(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
-    on(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
-    on(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
-    on(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
-    once(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
-    once(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
-    once(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
-    once(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
-    once(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
-    once(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
-    once(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
-    emit(event: 'documentErrorred', data: DocumentErrorEvent): boolean;
-    emit(event: 'documentUpdated', data: DocumentEvent): boolean;
-    emit(event: 'documentRemoved', data: FileEvent): boolean;
-    emit(event: `file${'Created' | 'Modified' | 'Deleted'}`, data: FileEvent): boolean;
-    emit(event: 'ready', data: EmptyEvent): boolean;
-    emit(event: 'rootsUpdated', data: RootsEvent): boolean;
-    emit(event: 'symbolRegistrarExecuted', data: SymbolRegistrarEvent): boolean;
-}
+export declare type ProjectData = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'ensureParsedAndChecked' | 'externals' | 'fs' | 'get' | 'logger' | 'meta' | 'profilers' | 'projectRoot' | 'roots' | 'symbols' | 'ctx'>;
 /**
  * Manage all tracked documents and errors.
  */
-export declare class Project extends EventEmitter {
+export declare class Project implements ExternalEventEmitter {
     #private;
     private static readonly RootSuffix;
     readonly cacheService: CacheService;
+    get isReady(): boolean;
     config: Config;
     readonly downloader: Downloader;
+    readonly externals: Externals;
     readonly fs: FileService;
     readonly logger: Logger;
     readonly meta: MetaRegistry;
     readonly profilers: ProfilerFactory;
-    readonly projectPath: string;
     readonly projectRoot: RootUriString;
     symbols: SymbolUtil;
     /**
@@ -108,10 +84,31 @@ export declare class Project extends EventEmitter {
      */
     get ctx(): Record<string, string>;
     /**
-     * File path to a directory where all cache files of Spyglass should be stored.
+     * File URI to a directory where all cache files of Spyglass should be stored.
      */
-    get cacheRoot(): string;
+    get cacheRoot(): RootUriString;
     private updateRoots;
+    on(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
+    on(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
+    on(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
+    on(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
+    on(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
+    on(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
+    on(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
+    once(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
+    once(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
+    once(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
+    once(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
+    once(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
+    once(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
+    once(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
+    emit(event: 'documentErrorred', data: DocumentErrorEvent): boolean;
+    emit(event: 'documentUpdated', data: DocumentEvent): boolean;
+    emit(event: 'documentRemoved', data: FileEvent): boolean;
+    emit(event: `file${'Created' | 'Modified' | 'Deleted'}`, data: FileEvent): boolean;
+    emit(event: 'ready', data: EmptyEvent): boolean;
+    emit(event: 'rootsUpdated', data: RootsEvent): boolean;
+    emit(event: 'symbolRegistrarExecuted', data: SymbolRegistrarEvent): boolean;
     /**
      * Get all files that are tracked and supported.
      *
@@ -119,7 +116,7 @@ export declare class Project extends EventEmitter {
      * are not loaded into the memory.
      */
     getTrackedFiles(): string[];
-    constructor({ cacheRoot, downloader, fs, initializers, logger, profilers, projectPath, }: Options);
+    constructor({ cacheRoot, defaultConfig, downloader, externals, fs, initializers, logger, profilers, projectRoot, }: ProjectOptions);
     private setInitPromise;
     private setReadyPromise;
     init(): Promise<this>;
@@ -130,6 +127,7 @@ export declare class Project extends EventEmitter {
     close(): Promise<void>;
     restart(): Promise<void>;
     resetCache(): void;
+    normalizeUri(uri: string): string;
     /**
      * @returns The language ID of the file, or the file extension without the leading dot.
      */
@@ -150,6 +148,7 @@ export declare class Project extends EventEmitter {
     private lint;
     ensureLinted(doc: TextDocument, node: FileNode<AstNode>): void;
     ensureParsedAndChecked(uri: string): Promise<DocAndNode | undefined>;
+    ensureParsedAndCheckedOnlyWhenReady(uri: string): Promise<DocAndNode | undefined>;
     private bind;
     /**
      * Notify that a new document was opened in the editor.