@spyglassmc/core 0.1.0 → 0.2.0

package/lib/service/Service.d.ts

@@ -1,44 +1,35 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
-import type { FileNode } from '../node';
-import { AstNode } from '../node';
-import type { Color, ColorInfo, ColorToken, InlayHint, SignatureHelp } from '../processor';
-import { ColorPresentation } from '../processor';
-import { Range } from '../source';
-import type { SymbolUsageType } from '../symbol';
-import { Downloader } from './Downloader';
-import { FileService } from './FileService';
-import { Hover } from './Hover';
-import { Logger } from './Logger';
-import { ProfilerFactory } from './Profiler';
-import type { ProjectInitializer } from './Project';
-import { Project } from './Project';
-import { SymbolLocations } from './SymbolLocations';
+import type { FileNode } from '../node/index.js';
+import { AstNode } from '../node/index.js';
+import type { Color, ColorInfo, ColorToken, InlayHint, SignatureHelp } from '../processor/index.js';
+import { ColorPresentation } from '../processor/index.js';
+import { Range } from '../source/index.js';
+import type { SymbolUsageType } from '../symbol/index.js';
+import { Hover } from './Hover.js';
+import type { Logger } from './Logger.js';
+import { ProfilerFactory } from './Profiler.js';
+import type { ProjectOptions } from './Project.js';
+import { Project } from './Project.js';
+import { SymbolLocations } from './SymbolLocations.js';
 interface Options {
-    cacheRoot: string;
-    downloader?: Downloader;
-    fs?: FileService;
-    initializers?: readonly ProjectInitializer[];
     isDebugging?: boolean;
-    logger?: Logger;
+    logger: Logger;
     profilers?: ProfilerFactory;
-    projectPath: string;
+    project: ProjectOptions;
 }
-export declare class Service extends EventEmitter {
-    readonly downloader: Downloader;
-    readonly fs: FileService;
+export declare class Service {
     readonly isDebugging: boolean;
     readonly logger: Logger;
     readonly profilers: ProfilerFactory;
     readonly project: Project;
-    constructor({ cacheRoot, downloader, fs, initializers, isDebugging, logger, profilers, projectPath, }: Options);
+    constructor({ isDebugging, logger, profilers, project, }: Options);
     private debug;
     colorize(node: FileNode<AstNode>, doc: TextDocument, range?: Range): readonly ColorToken[];
     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("../processor").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;
     getInlayHints(node: FileNode<AstNode>, doc: TextDocument, range?: Range): InlayHint[];
     getSignatureHelp(node: FileNode<AstNode>, doc: TextDocument, offset: number): SignatureHelp | undefined;
@@ -48,8 +39,7 @@ export declare class Service extends EventEmitter {
      *
      * @returns Symbol locations of the selected symbol at `offset`, or `undefined` if there's no symbol at `offset`.
      */
-    getSymbolLocations(file: FileNode<AstNode>, doc: TextDocument, offset: number, searchedUsages?: readonly SymbolUsageType[], currentFileOnly?: boolean): SymbolLocations | undefined;
-    format(node: FileNode<AstNode>, doc: TextDocument, tabSize: number, insertSpaces: boolean): string;
+    getSymbolLocations(file: FileNode<AstNode>, doc: TextDocument, offset: number, searchedUsages?: readonly SymbolUsageType[], currentFileOnly?: boolean): Promise<SymbolLocations | undefined>;
 }
 export {};
 //# sourceMappingURL=Service.d.ts.map

package/lib/service/Service.js

@@ -1,32 +1,28 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Service = void 0;
-const events_1 = __importDefault(require("events"));
-const node_1 = require("../node");
-const processor_1 = require("../processor");
-const source_1 = require("../source");
-const symbol_1 = require("../symbol");
-const Context_1 = require("./Context");
-const Downloader_1 = require("./Downloader");
-const FileService_1 = require("./FileService");
-const Hover_1 = require("./Hover");
-const Logger_1 = require("./Logger");
-const Profiler_1 = require("./Profiler");
-const Project_1 = require("./Project");
-const SymbolLocations_1 = require("./SymbolLocations");
+import { AstNode } from '../node/index.js';
+import { ColorPresentation, completer, traversePreOrder } from '../processor/index.js';
+import { Range } from '../source/index.js';
+import { SymbolUsageTypes } from '../symbol/index.js';
+import { ColorizerContext, CompleterContext, FormatterContext, ProcessorContext, SignatureHelpProviderContext } from './Context.js';
+import { fileUtil } from './fileUtil.js';
+import { Hover } from './Hover.js';
+import { ProfilerFactory } from './Profiler.js';
+import { Project } from './Project.js';
+import { SymbolLocations } from './SymbolLocations.js';
 /* istanbul ignore next */
-class Service extends events_1.default {
-    constructor({ cacheRoot, downloader, fs = FileService_1.FileService.create(), initializers = [], isDebugging = false, logger = Logger_1.Logger.create(), profilers = Profiler_1.ProfilerFactory.noop(), projectPath, }) {
-        super();
-        this.downloader = (downloader ?? (downloader = new Downloader_1.Downloader(cacheRoot, logger)));
-        this.fs = fs;
+export class Service {
+    isDebugging;
+    logger;
+    profilers;
+    project;
+    constructor({ isDebugging = false, logger, profilers = ProfilerFactory.noop(), project, }) {
         this.isDebugging = isDebugging;
         this.logger = logger;
         this.profilers = profilers;
-        this.project = new Project_1.Project({ cacheRoot, downloader, fs, initializers, logger, profilers, projectPath });
+        this.project = new Project({
+            logger,
+            profilers,
+            ...project,
+        });
     }
     debug(message) {
         if (this.isDebugging) {
@@ -37,7 +33,7 @@ class Service extends events_1.default {
         try {
             this.debug(`Colorizing '${doc.uri}' # ${doc.version}`);
             const colorizer = this.project.meta.getColorizer(node.type);
-            return colorizer(node, Context_1.ColorizerContext.create(this.project, { doc, range }));
+            return colorizer(node, ColorizerContext.create(this.project, { doc, range }));
         }
         catch (e) {
             this.logger.error(`[Service] [colorize] Failed for “${doc.uri}” #${doc.version}`, e);
@@ -48,7 +44,7 @@ class Service extends events_1.default {
         try {
             this.debug(`Getting color info for '${doc.uri}' # ${doc.version}`);
             const ans = [];
-            (0, processor_1.traversePreOrder)(node, _ => true, node => node.color, node => ans.push({
+            traversePreOrder(node, _ => true, node => node.color, node => ans.push({
                 color: Array.isArray(node.color) ? node.color : node.color.value,
                 range: Array.isArray(node.color) ? node.range : (node.color.range ?? node.range),
             }));
@@ -61,13 +57,13 @@ class Service extends events_1.default {
     }
     getColorPresentation(file, doc, range, color) {
         try {
-            this.debug(`Getting color presentation for '${doc.uri}' # ${doc.version} @ ${source_1.Range.toString(range)}`);
-            let node = node_1.AstNode.findDeepestChild({ node: file, needle: range.start });
+            this.debug(`Getting color presentation for '${doc.uri}' # ${doc.version} @ ${Range.toString(range)}`);
+            let node = AstNode.findDeepestChild({ node: file, needle: range.start });
             while (node) {
                 const nodeColor = node.color;
                 if (nodeColor && !Array.isArray(nodeColor)) {
                     const colorRange = nodeColor.range ?? node.range;
-                    return nodeColor.format.map(format => processor_1.ColorPresentation.fromColorFormat(format, color, colorRange));
+                    return nodeColor.format.map(format => ColorPresentation.fromColorFormat(format, color, colorRange));
                 }
                 node = node.parent;
             }
@@ -82,7 +78,7 @@ class Service extends events_1.default {
             this.debug(`Getting completion for '${doc.uri}' # ${doc.version} @ ${offset}`);
             const shouldComplete = this.project.meta.shouldComplete(doc.languageId, triggerCharacter);
             if (shouldComplete) {
-                return processor_1.completer.file(node, Context_1.CompleterContext.create(this.project, { doc, offset, triggerCharacter }));
+                return completer.file(node, CompleterContext.create(this.project, { doc, offset, triggerCharacter }));
             }
         }
         catch (e) {
@@ -107,18 +103,29 @@ class Service extends events_1.default {
             .map((c, i) => `${c.toUpperCase()}${secrets[i % secrets.length]}`)
             .join(' ');
     }
+    format(node, doc, tabSize, insertSpaces) {
+        try {
+            this.debug(`Formatting '${doc.uri}' # ${doc.version}`);
+            const formatter = this.project.meta.getFormatter(node.type);
+            return formatter(node, FormatterContext.create(this.project, { doc, tabSize, insertSpaces }));
+        }
+        catch (e) {
+            this.logger.error(`[Service] [format] Failed for “${doc.uri}” #${doc.version}`, e);
+            throw e;
+        }
+    }
     getHover(file, doc, offset) {
         try {
             this.debug(`Getting hover for '${doc.uri}' # ${doc.version} @ ${offset}`);
-            let node = node_1.AstNode.findDeepestChild({ node: file, needle: offset });
+            let node = AstNode.findDeepestChild({ node: file, needle: offset });
             while (node) {
                 const symbol = this.project.symbols.resolveAlias(node.symbol);
                 if (symbol) {
                     const hover = `\`\`\`typescript\n(${symbol.category}${symbol.subcategory ? `/${symbol.subcategory}` : ''}) ${symbol.identifier}\n\`\`\`` + (symbol.desc ? `\n******\n${symbol.desc}` : '');
-                    return Hover_1.Hover.create(node.range, hover);
+                    return Hover.create(node.range, hover);
                 }
                 if (node.hover) {
-                    return Hover_1.Hover.create(node.range, node.hover);
+                    return Hover.create(node.range, node.hover);
                 }
                 node = node.parent;
             }
@@ -133,7 +140,7 @@ class Service extends events_1.default {
             // TODO: `range` argument is not used.
             this.debug(`Getting inlay hints for '${doc.uri}' # ${doc.version}`);
             const ans = [];
-            const ctx = Context_1.ProcessorContext.create(this.project, { doc });
+            const ctx = ProcessorContext.create(this.project, { doc });
             for (const provider of this.project.meta.inlayHintProviders) {
                 ans.push(...provider(node, ctx));
             }
@@ -147,7 +154,7 @@ class Service extends events_1.default {
     getSignatureHelp(node, doc, offset) {
         try {
             this.debug(`Getting signature help for '${doc.uri}' # ${doc.version} @ ${offset}`);
-            const ctx = Context_1.SignatureHelpProviderContext.create(this.project, { doc, offset });
+            const ctx = SignatureHelpProviderContext.create(this.project, { doc, offset });
             for (const provider of this.project.meta.signatureHelpProviders) {
                 const result = provider(node, ctx);
                 if (result) {
@@ -166,22 +173,31 @@ class Service extends events_1.default {
      *
      * @returns Symbol locations of the selected symbol at `offset`, or `undefined` if there's no symbol at `offset`.
      */
-    getSymbolLocations(file, doc, offset, searchedUsages = symbol_1.SymbolUsageTypes, currentFileOnly = false) {
+    async getSymbolLocations(file, doc, offset, searchedUsages = SymbolUsageTypes, currentFileOnly = false) {
         try {
             this.debug(`Getting symbol locations of usage '${searchedUsages.join(',')}' for '${doc.uri}' # ${doc.version} @ ${offset} with currentFileOnly=${currentFileOnly}`);
-            let node = node_1.AstNode.findDeepestChild({ node: file, needle: offset });
+            let node = AstNode.findDeepestChild({ node: file, needle: offset });
             while (node) {
                 const symbol = this.project.symbols.resolveAlias(node.symbol);
                 if (symbol) {
-                    const locations = [];
+                    const rawLocations = [];
                     for (const usage of searchedUsages) {
                         let locs = symbol[usage] ?? [];
                         if (currentFileOnly) {
                             locs = locs.filter(l => l.uri === doc.uri);
                         }
-                        locations.push(...locs);
+                        rawLocations.push(...locs);
+                    }
+                    const locations = [];
+                    for (const loc of rawLocations) {
+                        const mappedUri = fileUtil.isFileUri(loc.uri)
+                            ? loc.uri
+                            : await this.project.fs.mapToDisk(loc.uri);
+                        if (mappedUri) {
+                            locations.push({ ...loc, uri: mappedUri });
+                        }
                     }
-                    return SymbolLocations_1.SymbolLocations.create(node.range, locations.length ? locations : undefined);
+                    return SymbolLocations.create(node.range, locations.length ? locations : undefined);
                 }
                 node = node.parent;
             }
@@ -191,17 +207,5 @@ class Service extends events_1.default {
         }
         return undefined;
     }
-    format(node, doc, tabSize, insertSpaces) {
-        try {
-            this.debug(`Formatting '${doc.uri}' # ${doc.version}`);
-            const formatter = this.project.meta.getFormatter(node.type);
-            return formatter(node, Context_1.FormatterContext.create(this.project, { doc, tabSize, insertSpaces }));
-        }
-        catch (e) {
-            this.logger.error(`[Service] [format] Failed for “${doc.uri}” #${doc.version}`, e);
-            throw e;
-        }
-    }
 }
-exports.Service = Service;
 //# sourceMappingURL=Service.js.map

package/lib/service/SymbolLocations.d.ts

@@ -1,6 +1,6 @@
-import type { RangeLike } from '../source';
-import { Range } from '../source';
-import type { SymbolLocation } from '../symbol';
+import type { RangeLike } from '../source/index.js';
+import { Range } from '../source/index.js';
+import type { SymbolLocation } from '../symbol/index.js';
 export interface SymbolLocations {
     /**
      * The range of the currently selected symbol.

package/lib/service/SymbolLocations.js

@@ -1,16 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SymbolLocations = void 0;
-const source_1 = require("../source");
-var SymbolLocations;
+import { Range } from '../source/index.js';
+export var SymbolLocations;
 (function (SymbolLocations) {
     /* istanbul ignore next */
     function create(range, locations) {
         return {
-            range: source_1.Range.get(range),
+            range: Range.get(range),
             locations,
         };
     }
     SymbolLocations.create = create;
-})(SymbolLocations = exports.SymbolLocations || (exports.SymbolLocations = {}));
+})(SymbolLocations || (SymbolLocations = {}));
 //# sourceMappingURL=SymbolLocations.js.map

package/lib/service/SymbolRegistrar.d.ts

@@ -1,4 +1,4 @@
-import type { SymbolUtil } from '../symbol';
+import type { SymbolUtil } from '../symbol/index.js';
 export declare type SymbolRegistrar = (this: void, symbols: SymbolUtil, ctx: SymbolRegistrarContext) => void;
 export interface SymbolRegistrarContext {
 }

package/lib/service/SymbolRegistrar.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=SymbolRegistrar.js.map

package/lib/service/fileUtil.d.ts

@@ -1,12 +1,6 @@
-/// <reference types="node" />
-import type fs from 'fs';
-import { URL as Uri } from 'url';
+import type { Externals, FsLocation } from '../common/index.js';
 export declare type RootUriString = `${string}/`;
 export declare type FileExtension = `.${string}`;
-/**
- * A string file path, string file URI, or a file URI object.
- */
-export declare type PathLike = string | Uri;
 export declare namespace fileUtil {
     /**
      * @param rootUris The root URIs. Each URI in this array must end with a slash (`/`).
@@ -42,24 +36,16 @@ export declare namespace fileUtil {
      */
     function extname(value: string): FileExtension | undefined;
     /**
-     * @param fileUri A file URI.
-     * @returns The corresponding file path of the `fileUri` in platform-specific format.
-     * @throws If the URI is not a file schema URI.
+     * @returns The part from the last `/` to the end of the URI.
      */
-    function fileUriToPath(fileUri: string): string;
-    /**
-     * @param path A file path.
-     * @returns The corresponding file URI of the `path`.
-     */
-    function pathToFileUri(path: string): string;
-    function normalize(uri: string): string;
-    function getParentOfFile(path: PathLike): PathLike;
+    function basename(uri: string): string;
+    function getParentOfFile(externals: Externals, path: FsLocation): FsLocation;
     /**
      * @throws
      *
      * @param mode Default to `0o777` (`rwxrwxrwx`)
      */
-    function ensureDir(path: PathLike, mode?: fs.Mode): Promise<void>;
+    function ensureDir(externals: Externals, path: FsLocation, mode?: number): Promise<void>;
     /**
      * @throws
      *
@@ -67,55 +53,49 @@ export declare namespace fileUtil {
      *
      * @param mode Default to `0o777` (`rwxrwxrwx`)
      */
-    function ensureParentOfFile(path: PathLike, mode?: fs.Mode): Promise<void>;
-    function readFile(path: PathLike): Promise<Buffer>;
+    function ensureParentOfFile(externals: Externals, path: FsLocation, mode?: number): Promise<void>;
+    function chmod(externals: Externals, path: FsLocation, mode: number): Promise<void>;
+    function ensureWritable(externals: Externals, path: FsLocation): Promise<void>;
+    function markReadOnly(externals: Externals, path: FsLocation): Promise<void>;
+    function readFile(externals: Externals, path: FsLocation): Promise<Uint8Array>;
     /**
      * @throws
      *
-     * The directory of the file will be created recursively if it doesn'texist.
+     * The directory of the file will be created recursively if it doesn't exist.
+     *
+     * The target file will be given permission `0o666` (`rw-rw-rw-`) before being written into, and changed back to the
+     * specified `mode`.
      *
      * * Encoding: `utf-8`
      * * Mode: `0o666` (`rw-rw-rw-`)
      * * Flag: `w`
      */
-    function writeFile(path: PathLike, data: Buffer | string): Promise<void>;
+    function writeFile(externals: Externals, path: FsLocation, data: Uint8Array | string, mode?: number): Promise<void>;
     /**
      * @throws
      */
-    function readJson<T = any>(path: PathLike): Promise<T>;
+    function readJson(externals: Externals, path: FsLocation): Promise<unknown>;
     /**
      * @throws
      *
      * @see {@link writeFile}
      */
-    function writeJson(path: PathLike, data: any): Promise<void>;
+    function writeJson(externals: Externals, path: FsLocation, data: any): Promise<void>;
     /**
      * @throws
      */
-    function readGzippedFile(path: PathLike): Promise<Buffer>;
+    function readGzippedFile(externals: Externals, path: FsLocation): Promise<Uint8Array>;
     /**
      * @throws
      */
-    function writeGzippedFile(path: PathLike, buffer: Buffer | string): Promise<void>;
+    function writeGzippedFile(externals: Externals, path: FsLocation, buffer: Uint8Array | string): Promise<void>;
     /**
      * @throws
      */
-    function readGzippedJson<T = any>(path: PathLike): Promise<T>;
+    function readGzippedJson(externals: Externals, path: FsLocation): Promise<unknown>;
     /**
      * @throws
      */
-    function writeGzippedJson(path: PathLike, data: any): Promise<void>;
-    /**
-     * Show the file/directory in the platform-specific explorer program.
-     *
-     * Should not be called with unsanitized user-input path due to the possibility of
-     * arbitrary code execution.
-     *
-     * @returns The `stdout` from the spawned child process.
-     */
-    function showFile(path: string): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
+    function writeGzippedJson(externals: Externals, path: FsLocation, data: any): Promise<void>;
 }
 //# sourceMappingURL=fileUtil.d.ts.map