@spyglassmc/core 0.4.8 → 0.4.10

package/lib/service/CacheService.d.ts

@@ -7,7 +7,7 @@ import type { Project } from './Project.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export declare const LatestCacheVersion = 4;
+export declare const LatestCacheVersion = 5;
 /**
  * Checksums of cached files or roots.
  */

package/lib/service/CacheService.js

@@ -5,7 +5,7 @@ import { fileUtil } from './fileUtil.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export const LatestCacheVersion = 4;
+export const LatestCacheVersion = 5;
 var Checksums;
 (function (Checksums) {
     function create() {
@@ -82,7 +82,7 @@ export class CacheService {
         let filePath;
         try {
             filePath = await this.getCacheFileUri();
-            this.project.logger.info(`[CacheService#load] symbolCachePath = “${filePath}”`);
+            this.project.logger.info(`[CacheService#load] symbolCachePath = ${filePath}`);
             const cache = (await fileUtil.readGzippedJson(this.project.externals, filePath));
             __profiler.task('Read File');
             if (cache.version === LatestCacheVersion) {
@@ -187,7 +187,7 @@ export class CacheService {
             return true;
         }
         catch (e) {
-            this.project.logger.error(`[CacheService#save] path = “${filePath}”`, e);
+            this.project.logger.error(`[CacheService#save] path = ${filePath}`, e);
         }
         return false;
     }

package/lib/service/Downloader.js

@@ -57,7 +57,7 @@ export class Downloader {
                             return ans;
                         }
                         catch (e) {
-                            this.logger.error(`[Downloader] [${id}] Loading cached file “${cacheUri}”`, e);
+                            this.logger.error(`[Downloader] [${id}] Loading cached file ${cacheUri}`, e);
                             if (this.externals.error.isKind(e, 'ENOENT')) {
                                 // Cache checksum exists, but cached file doesn't.
                                 // Remove the invalid cache checksum.
@@ -65,7 +65,7 @@ export class Downloader {
                                     await this.externals.fs.unlink(cacheChecksumUri);
                                 }
                                 catch (e) {
-                                    this.logger.error(`[Downloader] [${id}] Removing invalid cache checksum “${cacheChecksumUri}”`, e);
+                                    this.logger.error(`[Downloader] [${id}] Removing invalid cache checksum ${cacheChecksumUri}`, e);
                                 }
                             }
                         }
@@ -73,12 +73,12 @@ export class Downloader {
                 }
                 catch (e) {
                     if (!this.externals.error.isKind(e, 'ENOENT')) {
-                        this.logger.error(`[Downloader] [${id}] Loading cache checksum “${cacheChecksumUri}”`, e);
+                        this.logger.error(`[Downloader] [${id}] Loading cache checksum ${cacheChecksumUri}`, e);
                     }
                 }
             }
             catch (e) {
-                this.logger.error(`[Downloader] [${id}] Fetching latest checksum “${checksumJob.uri}”`, e);
+                this.logger.error(`[Downloader] [${id}] Fetching latest checksum ${checksumJob.uri}`, e);
             }
         }
         try {
@@ -92,7 +92,7 @@ export class Downloader {
                         await fileUtil.writeFile(this.externals, cacheChecksumUri, `${checksum}\n`);
                     }
                     catch (e) {
-                        this.logger.error(`[Downloader] [${id}] Saving cache checksum “${cacheChecksumUri}”`, e);
+                        this.logger.error(`[Downloader] [${id}] Saving cache checksum ${cacheChecksumUri}`, e);
                     }
                 }
                 try {
@@ -100,24 +100,24 @@ export class Downloader {
                     await fileUtil.writeFile(this.externals, cacheUri, serializer(buffer));
                 }
                 catch (e) {
-                    this.logger.error(`[Downloader] [${id}] Caching file “${cacheUri}”`, e);
+                    this.logger.error(`[Downloader] [${id}] Caching file ${cacheUri}`, e);
                 }
             }
-            this.logger.info(`[Downloader] [${id}] Downloaded from “${uri}”`);
+            this.logger.info(`[Downloader] [${id}] Downloaded from ${uri}`);
             return await transformer(buffer);
         }
         catch (e) {
-            this.logger.error(`[Downloader] [${id}] Downloading “${uri}”`, e);
+            this.logger.error(`[Downloader] [${id}] Downloading ${uri}`, e);
             if (cache && cacheUri) {
                 try {
                     const cachedBuffer = await fileUtil.readFile(this.externals, cacheUri);
                     const deserializer = cache.deserializer ?? ((b) => b);
                     const ans = await transformer(deserializer(cachedBuffer));
-                    this.logger.warn(`[Downloader] [${id}] Fell back to cached file “${cacheUri}”`);
+                    this.logger.warn(`[Downloader] [${id}] Fell back to cached file ${cacheUri}`);
                     return ans;
                 }
                 catch (e) {
-                    this.logger.error(`[Downloader] [${id}] Fallback: loading cached file “${cacheUri}”`, e);
+                    this.logger.error(`[Downloader] [${id}] Fallback: loading cached file ${cacheUri}`, e);
                 }
             }
         }

package/lib/service/FileService.js

@@ -146,7 +146,7 @@ export class FileUriSupporter {
                 }
             }
             catch (e) {
-                logger.error(`[FileUriSupporter#create] Bad dependency “${uri}”`, e);
+                logger.error(`[FileUriSupporter#create] Bad dependency ${uri}`, e);
             }
         }
         return new FileUriSupporter(externals, roots, files);
@@ -217,11 +217,11 @@ export class ArchiveUriSupporter {
      */
     static decodeUri(uri) {
         if (uri.protocol !== ArchiveUriSupporter.Protocol) {
-            throw new Error(`Expected protocol “${ArchiveUriSupporter.Protocol}” in “${uri}”`);
+            throw new Error(`Expected protocol “${ArchiveUriSupporter.Protocol}” in ${uri}`);
         }
         const path = uri.pathname;
         if (!path) {
-            throw new Error(`Missing path in archive uri “${uri.toString()}”`);
+            throw new Error(`Missing path in archive uri ${uri}`);
         }
         return { archiveName: uri.host, pathInArchive: path.charAt(0) === '/' ? path.slice(1) : path };
     }
@@ -241,7 +241,7 @@ export class ArchiveUriSupporter {
                 }
             }
             catch (e) {
-                logger.error(`[SpyglassUriSupporter#create] Bad dependency “${uri}”`, e);
+                logger.error(`[SpyglassUriSupporter#create] Bad dependency ${uri}`, e);
             }
         }
         return new ArchiveUriSupporter(externals, entries);

package/lib/service/Project.js

@@ -175,11 +175,12 @@ export class Project {
         this.downloader = downloader ?? new Downloader(cacheRoot, externals, logger);
         this.symbols = new SymbolUtil({}, externals.event.EventEmitter);
         this.#ctx = {};
-        this.logger.info(`[Project] [init] cacheRoot = “${cacheRoot}”`);
+        this.logger.info(`[Project] [init] cacheRoot = ${cacheRoot}`);
+        this.logger.info(`[Project] [init] projectRoots = ${projectRoots.join(' ')}`);
         this.#configService.on('changed', ({ config }) => {
             this.config = config;
             this.logger.info('[Project] [Config] Changed');
-        }).on('error', ({ error, uri }) => this.logger.error(`[Project] [Config] Failed loading “${uri}”`, error));
+        }).on('error', ({ error, uri }) => this.logger.error(`[Project] [Config] Failed loading ${uri}`, error));
         this.setInitPromise();
         this.setReadyPromise();
         this.#cacheSaverIntervalId = setInterval(() => this.cacheService.save(), CacheAutoSaveInterval);
@@ -474,7 +475,7 @@ export class Project {
                 return TextDocument.create(uri, languageId, -1, content);
             }
             catch (e) {
-                this.logger.warn(`[Project] [read] Failed creating TextDocument for “${uri}”`, e);
+                this.logger.warn(`[Project] [read] Failed creating TextDocument for ${uri}`, e);
                 return undefined;
             }
         };
@@ -524,7 +525,7 @@ export class Project {
             if (result) {
                 return result.doc;
             }
-            throw new Error(`[Project] [read] Client-managed URI “${uri}” does not have a TextDocument in the cache`);
+            throw new Error(`[Project] [read] Client-managed URI ${uri} does not have a TextDocument in the cache`);
         }
         return getCacheHandlingPromise(uri);
     }
@@ -561,7 +562,7 @@ export class Project {
             this.#symbolUpToDateUris.add(doc.uri);
         }
         catch (e) {
-            this.logger.error(`[Project] [bind] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Project] [bind] Failed for ${doc.uri} # ${doc.version}`, e);
         }
     }
     async check(doc, node) {
@@ -579,7 +580,7 @@ export class Project {
             });
         }
         catch (e) {
-            this.logger.error(`[Project] [check] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Project] [check] Failed for ${doc.uri} # ${doc.version}`, e);
         }
     }
     lint(doc, node) {
@@ -616,7 +617,7 @@ export class Project {
             }
         }
         catch (e) {
-            this.logger.error(`[Project] [lint] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Project] [lint] Failed for ${doc.uri} # ${doc.version}`, e);
         }
     }
     // @SingletonPromise()
@@ -675,7 +676,7 @@ export class Project {
         }
         const doc = this.#clientManagedDocAndNodes.get(uri)?.doc;
         if (!doc) {
-            throw new Error(`TextDocument for “${uri}” is ${!doc ? 'not cached' : 'a Promise'}. This should not happen. Did the language client send a didChange notification without sending a didOpen one, or is there a logic error on our side resulting the 'read' function overriding the 'TextDocument' created in the 'didOpen' notification handler?`);
+            throw new Error(`TextDocument for ${uri} is not cached. This should not happen. Did the language client send a didChange notification without sending a didOpen one, or is there a logic error on our side resulting the 'read' function overriding the 'TextDocument' created in the 'didOpen' notification handler?`);
         }
         TextDocument.update(doc, changes, version);
         const node = this.parse(doc);

package/lib/service/Service.js

@@ -27,18 +27,18 @@ export class Service {
     }
     colorize(node, doc, range) {
         try {
-            this.debug(`Colorizing '${doc.uri}' # ${doc.version}`);
+            this.debug(`Colorizing ${doc.uri} # ${doc.version}`);
             const colorizer = this.project.meta.getColorizer(node.type);
             return colorizer(node, ColorizerContext.create(this.project, { doc, range }));
         }
         catch (e) {
-            this.logger.error(`[Service] [colorize] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [colorize] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return [];
     }
     getColorInfo(node, doc) {
         try {
-            this.debug(`Getting color info for '${doc.uri}' # ${doc.version}`);
+            this.debug(`Getting color info for ${doc.uri} # ${doc.version}`);
             const ans = [];
             traversePreOrder(node, (_) => true, (node) => node.color, (node) => ans.push({
                 color: Array.isArray(node.color) ? node.color : node.color.value,
@@ -47,13 +47,13 @@ export class Service {
             return ans;
         }
         catch (e) {
-            this.logger.error(`[Service] [getColorInfo] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getColorInfo] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return [];
     }
     getColorPresentation(file, doc, range, color) {
         try {
-            this.debug(`Getting color presentation for '${doc.uri}' # ${doc.version} @ ${Range.toString(range)}`);
+            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;
@@ -65,20 +65,20 @@ export class Service {
             }
         }
         catch (e) {
-            this.logger.error(`[Service] [getColorPresentation] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getColorPresentation] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return [];
     }
     complete(node, doc, offset, triggerCharacter) {
         try {
-            this.debug(`Getting completion for '${doc.uri}' # ${doc.version} @ ${offset}`);
+            this.debug(`Getting completion for ${doc.uri} # ${doc.version} @ ${offset}`);
             const shouldComplete = this.project.meta.shouldComplete(doc.languageId, triggerCharacter);
             if (shouldComplete) {
                 return completer.file(node, CompleterContext.create(this.project, { doc, offset, triggerCharacter }));
             }
         }
         catch (e) {
-            this.logger.error(`[Service] [complete] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [complete] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return [];
     }
@@ -99,18 +99,18 @@ export class Service {
     }
     format(node, doc, tabSize, insertSpaces) {
         try {
-            this.debug(`Formatting '${doc.uri}' # ${doc.version}`);
+            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);
+            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}`);
+            this.debug(`Getting hover for ${doc.uri} # ${doc.version} @ ${offset}`);
             let node = AstNode.findDeepestChild({ node: file, needle: offset });
             while (node) {
                 const symbol = this.project.symbols.resolveAlias(node.symbol);
@@ -125,14 +125,14 @@ export class Service {
             }
         }
         catch (e) {
-            this.logger.error(`[Service] [getHover] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getHover] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return undefined;
     }
     getInlayHints(node, doc, range) {
         try {
             // TODO: `range` argument is not used.
-            this.debug(`Getting inlay hints for '${doc.uri}' # ${doc.version}`);
+            this.debug(`Getting inlay hints for ${doc.uri} # ${doc.version}`);
             const ans = [];
             const ctx = ProcessorContext.create(this.project, { doc });
             for (const provider of this.project.meta.inlayHintProviders) {
@@ -141,13 +141,13 @@ export class Service {
             return ans;
         }
         catch (e) {
-            this.logger.error(`[Service] [getInlayHints] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getInlayHints] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return [];
     }
     getSignatureHelp(node, doc, offset) {
         try {
-            this.debug(`Getting signature help for '${doc.uri}' # ${doc.version} @ ${offset}`);
+            this.debug(`Getting signature help for ${doc.uri} # ${doc.version} @ ${offset}`);
             const ctx = SignatureHelpProviderContext.create(this.project, { doc, offset });
             for (const provider of this.project.meta.signatureHelpProviders) {
                 const result = provider(node, ctx);
@@ -157,7 +157,7 @@ export class Service {
             }
         }
         catch (e) {
-            this.logger.error(`[Service] [getSignatureHelp] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getSignatureHelp] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return undefined;
     }
@@ -169,7 +169,7 @@ export class Service {
      */
     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}`);
+            this.debug(`Getting symbol locations of usage '${searchedUsages.join(',')}' for ${doc.uri} # ${doc.version} @ ${offset} with currentFileOnly=${currentFileOnly}`);
             let node = AstNode.findDeepestChild({ node: file, needle: offset });
             while (node) {
                 const symbol = this.project.symbols.resolveAlias(node.symbol);
@@ -197,7 +197,7 @@ export class Service {
             }
         }
         catch (e) {
-            this.logger.error(`[Service] [getSymbolLocations] Failed for “${doc.uri}” #${doc.version}`, e);
+            this.logger.error(`[Service] [getSymbolLocations] Failed for ${doc.uri} # ${doc.version}`, e);
         }
         return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.4.8",
+  "version": "0.4.10",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",