@spyglassmc/core 0.1.1 → 0.1.2

package/lib/service/Project.js

@@ -57,7 +57,7 @@ var ProjectData;
             ctx: data.ctx ?? {},
             downloader,
             ensureParsedAndChecked: data.ensureParsedAndChecked,
-            fs: data.fs ?? FileService_1.FileService.create(),
+            fs: data.fs ?? FileService_1.FileService.create('file:///cache/'),
             get: data.get ?? (() => undefined),
             logger,
             meta: data.meta ?? new MetaRegistry_1.MetaRegistry(),
@@ -74,7 +74,7 @@ var ProjectData;
  * Manage all tracked documents and errors.
  */
 class Project extends events_1.default {
-    constructor({ cacheRoot, downloader, fs = FileService_1.FileService.create(), initializers = [], logger = Logger_1.Logger.create(), profilers = Profiler_1.ProfilerFactory.noop(), projectPath, }) {
+    constructor({ cacheRoot, downloader, fs = FileService_1.FileService.create(cacheRoot), initializers = [], logger = Logger_1.Logger.create(), profilers = Profiler_1.ProfilerFactory.noop(), projectPath, }) {
         super();
         _Project_cacheSaverIntervalId.set(this, void 0);
         /**
@@ -288,9 +288,9 @@ class Project extends events_1.default {
         const listDependencyFiles = async () => {
             const dependencies = await getDependencies();
             const fileUriSupporter = await FileService_1.FileUriSupporter.create(dependencies, this.logger);
-            const spyglassUriSupporter = await FileService_1.SpyglassUriSupporter.create(dependencies, this.logger, this.cacheService.checksums.roots);
+            const archiveUriSupporter = await FileService_1.ArchiveUriSupporter.create(dependencies, this.logger, this.cacheService.checksums.roots);
             this.fs.register('file:', fileUriSupporter, true);
-            this.fs.register(common_1.SpyglassUri.Protocol, spyglassUriSupporter, true);
+            this.fs.register(FileService_1.ArchiveUriSupporter.Protocol, archiveUriSupporter, true);
         };
         const listProjectFiles = () => new Promise(resolve => {
             __classPrivateFieldSet(this, _Project_watcherReady, false, "f");
@@ -361,7 +361,7 @@ class Project extends events_1.default {
                 this.bind(addedFiles);
             }
             __profiler.task('Bind URIs');
-            const files = [...addedFiles, ...changedFiles]; // FIXME: nbtdoc files might need to be parsed and checked before others.
+            const files = [...addedFiles, ...changedFiles]; // FIXME: mcdoc files might need to be parsed and checked before others.
             // const docAndNodes = (await Promise.all(files.map(uri => limit(ensureParsed, uri)))).filter((r): r is DocAndNode => !!r)
             const docAndNodes = (await Promise.all(files.map(uri => ensureParsed(uri)))).filter((r) => !!r);
             __profiler.task('Parse Files');
@@ -401,11 +401,14 @@ class Project extends events_1.default {
     resetCache() {
         return this.cacheService.reset();
     }
+    normalizeUri(uri) {
+        return this.fs.mapFromDisk(fileUtil_1.fileUtil.normalize(uri));
+    }
     /**
      * @returns The language ID of the file, or the file extension without the leading dot.
      */
     getLanguageID(uri) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
         const ext = fileUtil_1.fileUtil.extname(uri) ?? '.plaintext';
         return this.meta.getLanguageID(ext) ?? ext.slice(1);
     }
@@ -413,14 +416,14 @@ class Project extends events_1.default {
      * @returns The cached `TextDocument` and `AstNode` for the URI, or `undefined` when such data isn't available in cache.
      */
     get(uri) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
         return __classPrivateFieldGet(this, _Project_docAndNodes, "f").get(uri);
     }
     /**
      * @throws FS-related errors
      */
     async ensureParsed(uri) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
         if (__classPrivateFieldGet(this, _Project_docAndNodes, "f").has(uri)) {
             return __classPrivateFieldGet(this, _Project_docAndNodes, "f").get(uri);
         }
@@ -546,7 +549,10 @@ class Project extends events_1.default {
      * Notify that a new document was opened in the editor.
      */
     onDidOpen(uri, languageID, version, content) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
+        if (!fileUtil_1.fileUtil.isFileUri(uri)) {
+            return; // We only accept `file:` scheme for client-managed URIs.
+        }
         __classPrivateFieldGet(this, _Project_clientManagedUris, "f").add(uri);
         const doc = vscode_languageserver_textdocument_1.TextDocument.create(uri, languageID, version, content);
         const { node } = this.parseAndCache(doc);
@@ -559,7 +565,10 @@ class Project extends events_1.default {
      * @throws If there is no `TextDocument` corresponding to the URI.
      */
     onDidChange(uri, changes, version) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
+        if (!fileUtil_1.fileUtil.isFileUri(uri)) {
+            return; // We only accept `file:` scheme for client-managed URIs.
+        }
         const result = this.get(uri);
         if (!result) {
             throw new Error(`Document for “${uri}” is not cached. This should not happen. Did the language client send a didChange notification without sending a didOpen one?`);
@@ -574,7 +583,10 @@ class Project extends events_1.default {
      * Notify that an existing document was closed in the editor.
      */
     onDidClose(uri) {
-        uri = fileUtil_1.fileUtil.normalize(uri);
+        uri = this.normalizeUri(uri);
+        if (!fileUtil_1.fileUtil.isFileUri(uri)) {
+            return; // We only accept `file:` scheme for client-managed URIs.
+        }
         __classPrivateFieldGet(this, _Project_clientManagedUris, "f").delete(uri);
         this.tryClearingCache(uri);
     }

package/lib/service/Service.d.ts

@@ -39,6 +39,7 @@ export declare class Service extends EventEmitter {
     getColorPresentation(file: FileNode<AstNode>, doc: TextDocument, range: Range, color: Color): ColorPresentation[];
     complete(node: FileNode<AstNode>, doc: TextDocument, offset: number, triggerCharacter?: string): import("../processor").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 +49,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

@@ -12,6 +12,7 @@ const symbol_1 = require("../symbol");
 const Context_1 = require("./Context");
 const Downloader_1 = require("./Downloader");
 const FileService_1 = require("./FileService");
+const fileUtil_1 = require("./fileUtil");
 const Hover_1 = require("./Hover");
 const Logger_1 = require("./Logger");
 const Profiler_1 = require("./Profiler");
@@ -19,7 +20,7 @@ const Project_1 = require("./Project");
 const SymbolLocations_1 = require("./SymbolLocations");
 /* 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, }) {
+    constructor({ cacheRoot, downloader, fs = FileService_1.FileService.create(cacheRoot), 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;
@@ -107,6 +108,17 @@ 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, 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;
+        }
+    }
     getHover(file, doc, offset) {
         try {
             this.debug(`Getting hover for '${doc.uri}' # ${doc.version} @ ${offset}`);
@@ -166,20 +178,29 @@ 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 = symbol_1.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 });
             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_1.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);
                 }
@@ -191,17 +212,6 @@ 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/fileUtil.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import type fs from 'fs';
+/// <reference types="node" />
 import { URL as Uri } from 'url';
 export declare type RootUriString = `${string}/`;
 export declare type FileExtension = `.${string}`;
@@ -41,6 +41,10 @@ export declare namespace fileUtil {
      * @returns The part from the last `.` to the end of the URI, or `undefined` if no dots exist. No special treatment for leading dots.
      */
     function extname(value: string): FileExtension | undefined;
+    /**
+     * @returns The part from the last `/` to the end of the URI.
+     */
+    function basename(uri: string): string;
     /**
      * @param fileUri A file URI.
      * @returns The corresponding file path of the `fileUri` in platform-specific format.
@@ -59,7 +63,7 @@ export declare namespace fileUtil {
      *
      * @param mode Default to `0o777` (`rwxrwxrwx`)
      */
-    function ensureDir(path: PathLike, mode?: fs.Mode): Promise<void>;
+    function ensureDir(path: PathLike, mode?: number): Promise<void>;
     /**
      * @throws
      *
@@ -67,18 +71,24 @@ export declare namespace fileUtil {
      *
      * @param mode Default to `0o777` (`rwxrwxrwx`)
      */
-    function ensureParentOfFile(path: PathLike, mode?: fs.Mode): Promise<void>;
+    function ensureParentOfFile(path: PathLike, mode?: number): Promise<void>;
+    function chmod(path: PathLike, mode: number): Promise<void>;
+    function ensureWritable(path: PathLike): Promise<void>;
+    function markReadOnly(path: PathLike): Promise<void>;
     function readFile(path: PathLike): Promise<Buffer>;
     /**
      * @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(path: PathLike, data: Buffer | string, mode?: number): Promise<void>;
     /**
      * @throws
      */

package/lib/service/fileUtil.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -93,6 +97,14 @@ var fileUtil;
         return i >= 0 ? value.slice(i) : undefined;
     }
     fileUtil.extname = extname;
+    /**
+     * @returns The part from the last `/` to the end of the URI.
+     */
+    function basename(uri) {
+        const i = uri.lastIndexOf('/');
+        return i >= 0 ? uri.slice(i + 1) : uri;
+    }
+    fileUtil.basename = basename;
     /* istanbul ignore next */
     /**
      * @param fileUri A file URI.
@@ -172,6 +184,25 @@ var fileUtil;
         return ensureDir(getParentOfFile(path), mode);
     }
     fileUtil.ensureParentOfFile = ensureParentOfFile;
+    async function chmod(path, mode) {
+        return fs_1.promises.chmod(toFsPathLike(path), mode);
+    }
+    fileUtil.chmod = chmod;
+    async function ensureWritable(path) {
+        try {
+            await chmod(path, 0o666);
+        }
+        catch (e) {
+            if (!(0, common_1.isEnoent)(e)) {
+                throw e;
+            }
+        }
+    }
+    fileUtil.ensureWritable = ensureWritable;
+    async function markReadOnly(path) {
+        return chmod(path, 0o444);
+    }
+    fileUtil.markReadOnly = markReadOnly;
     async function readFile(path) {
         return fs_1.promises.readFile(toFsPathLike(path));
     }
@@ -180,15 +211,19 @@ var fileUtil;
     /**
      * @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`
      */
-    async function writeFile(path, data) {
+    async function writeFile(path, data, mode = 0o666) {
         await ensureParentOfFile(path);
-        return fs_1.promises.writeFile(toFsPathLike(path), data);
+        await ensureWritable(path);
+        return fs_1.promises.writeFile(toFsPathLike(path), data, { mode });
     }
     fileUtil.writeFile = writeFile;
     /* istanbul ignore next */

package/lib/service/index.js

@@ -2,7 +2,11 @@
 /* istanbul ignore file */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/source/LanguageError.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LanguageError = void 0;
 var LanguageError;
 (function (LanguageError) {
-    function create(message, range, severity = 3 /* Error */, info) {
+    function create(message, range, severity = 3 /* ErrorSeverity.Error */, info) {
         const ans = { range, message, severity };
         if (info) {
             ans.info = info;

package/lib/source/Source.d.ts

@@ -35,9 +35,12 @@ export declare class ReadonlySource {
     /**
      * If the `expectedValue` is right after the cursor, returns `true`. Otherwise returns `false`.
      *
+     * @param offset Defaults to 0.
+     *
      * @see {@link Source.trySkip}
      */
-    tryPeek(expectedValue: string): boolean;
+    tryPeek(expectedValue: string, offset?: number): boolean;
+    tryPeekAfterWhitespace(expectedValue: string): boolean;
     peekUntil(...terminators: string[]): string;
     peekLine(): string;
     hasNonSpaceAheadInLine(): boolean;
@@ -91,6 +94,8 @@ export declare class Source extends ReadonlySource {
     skipSpace(): this;
     readWhitespace(): string;
     skipWhitespace(): this;
+    readIf(predicate: (this: void, char: string) => boolean): string;
+    skipIf(predicate: (this: void, char: string) => boolean): this;
     /**
      * @param terminators Ending character. Will not be skipped or included in the result.
      */

package/lib/source/Source.js

@@ -40,10 +40,20 @@ class ReadonlySource {
     /**
      * If the `expectedValue` is right after the cursor, returns `true`. Otherwise returns `false`.
      *
+     * @param offset Defaults to 0.
+     *
      * @see {@link Source.trySkip}
      */
-    tryPeek(expectedValue) {
-        return this.peek(expectedValue.length) === expectedValue;
+    tryPeek(expectedValue, offset = 0) {
+        return this.peek(expectedValue.length, offset) === expectedValue;
+    }
+    tryPeekAfterWhitespace(expectedValue) {
+        const maxOffset = this.string.length - this.innerCursor;
+        let offset = 0;
+        while (offset < maxOffset && Source.isWhitespace(this.peek(1, offset))) {
+            offset++;
+        }
+        return this.tryPeek(expectedValue, offset);
     }
     peekUntil(...terminators) {
         let ans = '';
@@ -191,6 +201,24 @@ class Source extends ReadonlySource {
         }
         return this;
     }
+    readIf(predicate) {
+        let ans = '';
+        while (this.canRead()) {
+            const c = this.peek();
+            if (predicate(c)) {
+                this.skip();
+                ans += c;
+            }
+            else {
+                break;
+            }
+        }
+        return ans;
+    }
+    skipIf(predicate) {
+        this.readIf(predicate);
+        return this;
+    }
     /**
      * @param terminators Ending character. Will not be skipped or included in the result.
      */

package/lib/source/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];