@spyglassmc/core 0.4.0 → 0.4.2

package/lib/service/Project.js

@@ -5,7 +5,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { bufferToString, Logger, SingletonPromise, StateProxy } from '../common/index.js';
+import { bufferToString, Logger, normalizeUri, SingletonPromise, StateProxy, } from '../common/index.js';
 import { FileNode } from '../node/index.js';
 import { file } from '../parser/index.js';
 import { traversePreOrder } from '../processor/index.js';
@@ -13,11 +13,11 @@ import { LanguageError, Source } from '../source/index.js';
 import { SymbolUtil } from '../symbol/index.js';
 import { CacheService } from './CacheService.js';
 import { ConfigService, LinterConfigValue } from './Config.js';
-import { BinderContext, CheckerContext, LinterContext, ParserContext, UriBinderContext } from './Context.js';
+import { BinderContext, CheckerContext, LinterContext, ParserContext, UriBinderContext, } from './Context.js';
 import { DependencyKey } from './Dependency.js';
 import { Downloader } from './Downloader.js';
 import { LinterErrorReporter } from './ErrorReporter.js';
-import { ArchiveUriSupporter, FileService, FileUriSupporter } from './FileService.js';
+import { ArchiveUriSupporter, FileService, FileUriSupporter, } from './FileService.js';
 import { fileUtil } from './fileUtil.js';
 import { MetaRegistry } from './MetaRegistry.js';
 import { ProfilerFactory } from './Profiler.js';
@@ -60,7 +60,7 @@ const CacheAutoSaveInterval = 600000; // 10 Minutes.
  *
  * After the READY process is complete, editing text documents as signaled by the client or the file watcher results in the file being re-processed.
  */
-export class Project {
+class Project {
     static RootSuffix = '/pack.mcmeta';
     /** Prevent circular binding. */
     #bindingInProgressUris = new Set();
@@ -125,7 +125,8 @@ export class Project {
         const ans = new Set(rawRoots);
         // Identify roots indicated by `pack.mcmeta`.
         for (const file of this.getTrackedFiles()) {
-            if (file.endsWith(Project.RootSuffix) && rawRoots.some(r => file.startsWith(r))) {
+            if (file.endsWith(Project.RootSuffix) &&
+                rawRoots.some((r) => file.startsWith(r))) {
                 ans.add(file.slice(0, 1 - Project.RootSuffix.length));
             }
         }
@@ -151,8 +152,7 @@ export class Project {
      */
     getTrackedFiles() {
         const extensions = this.meta.getSupportedFileExtensions();
-        return [...this.#dependencyFiles, ...this.#watchedFiles]
-            .filter(file => extensions.includes(fileUtil.extname(file) ?? ''));
+        return [...this.#dependencyFiles, ...this.#watchedFiles].filter((file) => extensions.includes(fileUtil.extname(file) ?? ''));
     }
     constructor({ cacheRoot, defaultConfig, downloader, externals, fs = FileService.create(externals, cacheRoot), initializers = [], logger = Logger.create(), profilers = ProfilerFactory.noop(), projectRoot, }) {
         this.#cacheRoot = cacheRoot;
@@ -165,7 +165,8 @@ export class Project {
         this.projectRoot = projectRoot;
         this.cacheService = new CacheService(cacheRoot, this);
         this.#configService = new ConfigService(this, defaultConfig);
-        this.downloader = downloader ?? new Downloader(cacheRoot, externals, logger);
+        this.downloader = downloader ??
+            new Downloader(cacheRoot, externals, logger);
         this.symbols = new SymbolUtil({}, externals.event.EventEmitter);
         this.#ctx = {};
         this.logger.info(`[Project] [init] cacheRoot = “${cacheRoot}”`);
@@ -178,13 +179,12 @@ export class Project {
         this.setInitPromise();
         this.setReadyPromise();
         this.#cacheSaverIntervalId = setInterval(() => this.cacheService.save(), CacheAutoSaveInterval);
-        this
-            .on('documentUpdated', ({ doc, node }) => {
+        this.on('documentUpdated', ({ doc, node }) => {
             // if (!this.#isReady) {
             // 	return
             // }
             this.emit('documentErrored', {
-                errors: FileNode.getErrors(node).map(e => LanguageError.withPosRange(e, doc)),
+                errors: FileNode.getErrors(node).map((e) => LanguageError.withPosRange(e, doc)),
                 uri: doc.uri,
                 version: doc.version,
             });
@@ -237,7 +237,7 @@ export class Project {
                 meta: this.meta,
                 projectRoot: this.projectRoot,
             };
-            const results = await Promise.allSettled(this.#initializers.map(init => init(initCtx)));
+            const results = await Promise.allSettled(this.#initializers.map((init) => init(initCtx)));
             let ctx = {};
             results.forEach(async (r, i) => {
                 if (r.status === 'rejected') {
@@ -294,7 +294,7 @@ export class Project {
             this.fs.register('file:', fileUriSupporter, true);
             this.fs.register(ArchiveUriSupporter.Protocol, archiveUriSupporter, true);
         };
-        const listProjectFiles = () => new Promise(resolve => {
+        const listProjectFiles = () => new Promise((resolve) => {
             this.#watchedFiles.clear();
             this.#watcherReady = false;
             this.#watcher = this.externals.fs
@@ -303,34 +303,31 @@ export class Project {
                 this.#watcherReady = true;
                 resolve();
             })
-                .on('add', uri => {
+                .on('add', (uri) => {
                 this.#watchedFiles.add(uri);
                 if (this.#watcherReady) {
                     this.emit('fileCreated', { uri });
                 }
             })
-                .on('change', uri => {
+                .on('change', (uri) => {
                 if (this.#watcherReady) {
                     this.emit('fileModified', { uri });
                 }
             })
-                .on('unlink', uri => {
+                .on('unlink', (uri) => {
                 this.#watchedFiles.delete(uri);
                 if (this.#watcherReady) {
                     this.emit('fileDeleted', { uri });
                 }
             })
-                .on('error', e => {
+                .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(),
-            ]);
+            await Promise.all([listDependencyFiles(), listProjectFiles()]);
             this.#dependencyFiles = new Set(this.fs.listFiles());
             this.#dependencyRoots = new Set(this.fs.listRoots());
             this.updateRoots();
@@ -353,7 +350,9 @@ export class Project {
                 this.emit('documentErrored', { errors: values, uri });
             }
             __profiler.task('Pop Errors');
-            const { addedFiles, changedFiles, removedFiles } = await this.cacheService.validate();
+            const { addedFiles, changedFiles, removedFiles } = await this
+                .cacheService
+                .validate();
             for (const uri of removedFiles) {
                 this.emit('fileDeleted', { uri });
             }
@@ -424,7 +423,7 @@ export class Project {
         return this.restart();
     }
     normalizeUri(uri) {
-        return this.fs.mapFromDisk(this.externals.uri.normalize(uri));
+        return this.fs.mapFromDisk(normalizeUri(uri));
     }
     static TextDocumentCacheMaxLength = 268435456;
     #textDocumentCache = new Map();
@@ -563,7 +562,8 @@ export class Project {
                     continue;
                 }
                 const { ruleSeverity, ruleValue } = result;
-                const { configValidator, linter, nodePredicate } = this.meta.getLinter(ruleName);
+                const { configValidator, linter, nodePredicate } = this.meta
+                    .getLinter(ruleName);
                 if (!configValidator(ruleName, ruleValue, this.logger)) {
                     // Config value is invalid.
                     continue;
@@ -574,7 +574,7 @@ export class Project {
                     ruleName,
                     ruleValue,
                 });
-                traversePreOrder(node, () => true, () => true, node => {
+                traversePreOrder(node, () => true, () => true, (node) => {
                     if (nodePredicate(node)) {
                         const proxy = StateProxy.create(node);
                         linter(proxy, ctx);
@@ -589,7 +589,9 @@ export class Project {
     }
     // @SingletonPromise()
     async ensureBindingStarted(uri) {
-        if (this.#symbolUpToDateUris.has(uri) || this.#bindingInProgressUris.has(uri)) {
+        uri = this.normalizeUri(uri);
+        if (this.#symbolUpToDateUris.has(uri) ||
+            this.#bindingInProgressUris.has(uri)) {
             return;
         }
         this.#bindingInProgressUris.add(uri);
@@ -635,8 +637,8 @@ export class Project {
      * @throws If there is no `TextDocument` corresponding to the URI.
      */
     async onDidChange(uri, changes, version) {
-        this.#symbolUpToDateUris.delete(uri);
         uri = this.normalizeUri(uri);
+        this.#symbolUpToDateUris.delete(uri);
         if (!fileUtil.isFileUri(uri)) {
             return; // We only accept `file:` scheme for client-managed URIs.
         }
@@ -665,17 +667,21 @@ export class Project {
         this.tryClearingCache(uri);
     }
     async ensureClientManagedChecked(uri) {
+        uri = this.normalizeUri(uri);
         const result = this.#clientManagedDocAndNodes.get(uri);
-        if (result && this.#isReady) {
+        if (result) {
             const { doc, node } = result;
-            await this.bind(doc, node);
-            await this.check(doc, node);
-            this.emit('documentUpdated', { doc, node });
-            return { doc, node };
+            if (this.#isReady) {
+                await this.bind(doc, node);
+                await this.check(doc, node);
+                this.emit('documentUpdated', result);
+            }
+            return result;
         }
         return undefined;
     }
     getClientManaged(uri) {
+        uri = this.normalizeUri(uri);
         return this.#clientManagedDocAndNodes.get(uri);
     }
     async showCacheRoot() {
@@ -696,10 +702,14 @@ export class Project {
         }
     }
     shouldRemove(uri) {
-        return !this.#clientManagedUris.has(uri) && !this.#dependencyFiles.has(uri) && !this.#watchedFiles.has(uri);
+        return (!this.#clientManagedUris.has(uri) &&
+            !this.#dependencyFiles.has(uri) &&
+            !this.#watchedFiles.has(uri));
     }
     isOnlyWatched(uri) {
-        return this.#watchedFiles.has(uri) && !this.#clientManagedUris.has(uri) && !this.#dependencyFiles.has(uri);
+        return (this.#watchedFiles.has(uri) &&
+            !this.#clientManagedUris.has(uri) &&
+            !this.#dependencyFiles.has(uri));
     }
 }
 __decorate([
@@ -711,4 +721,5 @@ __decorate([
 __decorate([
     SingletonPromise()
 ], Project.prototype, "ensureClientManagedChecked", null);
+export { Project };
 //# sourceMappingURL=Project.js.map

package/lib/service/Service.js

@@ -1,8 +1,8 @@
 import { AstNode } from '../node/index.js';
-import { ColorPresentation, completer, traversePreOrder } from '../processor/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 { ColorizerContext, CompleterContext, FormatterContext, ProcessorContext, SignatureHelpProviderContext, } from './Context.js';
 import { fileUtil } from './fileUtil.js';
 import { Hover } from './Hover.js';
 import { ProfilerFactory } from './Profiler.js';
@@ -44,9 +44,13 @@ export class Service {
         try {
             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,
-                range: Array.isArray(node.color) ? node.range : (node.color.range ?? node.range),
+            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,
             }));
             return ans;
         }
@@ -58,12 +62,15 @@ export class Service {
     getColorPresentation(file, doc, range, color) {
         try {
             this.debug(`Getting color presentation for '${doc.uri}' # ${doc.version} @ ${Range.toString(range)}`);
-            let node = AstNode.findDeepestChild({ node: file, needle: range.start });
+            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 => ColorPresentation.fromColorFormat(format, color, colorRange));
+                    return nodeColor.format.map((format) => ColorPresentation.fromColorFormat(format, color, colorRange));
                 }
                 node = node.parent;
             }
@@ -78,7 +85,11 @@ export class Service {
             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 }));
+                return completer.file(node, CompleterContext.create(this.project, {
+                    doc,
+                    offset,
+                    triggerCharacter,
+                }));
             }
         }
         catch (e) {
@@ -107,7 +118,11 @@ export class Service {
         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 }));
+            return formatter(node, FormatterContext.create(this.project, {
+                doc,
+                tabSize,
+                insertSpaces,
+            }));
         }
         catch (e) {
             this.logger.error(`[Service] [format] Failed for “${doc.uri}” #${doc.version}`, e);
@@ -121,7 +136,8 @@ export class Service {
             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}` : '');
+                    const hover = `\`\`\`typescript\n(${symbol.category}${symbol.subcategory ? `/${symbol.subcategory}` : ''}) ${symbol.identifier}\n\`\`\`` +
+                        (symbol.desc ? `\n******\n${symbol.desc}` : '');
                     return Hover.create(node.range, hover);
                 }
                 if (node.hover) {
@@ -154,7 +170,10 @@ export class Service {
     getSignatureHelp(node, doc, offset) {
         try {
             this.debug(`Getting signature help for '${doc.uri}' # ${doc.version} @ ${offset}`);
-            const ctx = 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) {
@@ -184,7 +203,7 @@ export class Service {
                     for (const usage of searchedUsages) {
                         let locs = symbol[usage] ?? [];
                         if (currentFileOnly) {
-                            locs = locs.filter(l => l.uri === doc.uri);
+                            locs = locs.filter((l) => l.uri === doc.uri);
                         }
                         rawLocations.push(...locs);
                     }

package/lib/service/SymbolRegistrar.d.ts

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

package/lib/service/UriProcessor.d.ts

@@ -1,5 +1,5 @@
 import type { UriBinderContext } from './Context.js';
-export declare type UriBinder = (uris: readonly string[], ctx: UriBinderContext) => void;
-export declare type UriSorterRegistration = (this: void, a: string, b: string, next: UriSorter) => number;
-export declare type UriSorter = (this: void, a: string, b: string) => number;
+export type UriBinder = (uris: readonly string[], ctx: UriBinderContext) => void;
+export type UriSorterRegistration = (this: void, a: string, b: string, next: UriSorter) => number;
+export type UriSorter = (this: void, a: string, b: string) => number;
 //# sourceMappingURL=UriProcessor.d.ts.map

package/lib/service/fileUtil.d.ts

@@ -1,6 +1,6 @@
 import type { Externals, FsLocation } from '../common/index.js';
-export declare type RootUriString = `${string}/`;
-export declare type FileExtension = `.${string}`;
+export type RootUriString = `${string}/`;
+export type FileExtension = `.${string}`;
 export declare namespace fileUtil {
     /**
      * @param rootUris The root URIs. Each URI in this array must end with a slash (`/`).

package/lib/service/fileUtil.js

@@ -43,7 +43,8 @@ export var fileUtil;
     }
     fileUtil.ensureEndingSlash = ensureEndingSlash;
     function join(fromUri, toUri) {
-        return ensureEndingSlash(fromUri) + (toUri.startsWith('/') ? toUri.slice(1) : toUri);
+        return (ensureEndingSlash(fromUri) +
+            (toUri.startsWith('/') ? toUri.slice(1) : toUri));
     }
     fileUtil.join = join;
     /**

package/lib/source/IndexMap.d.ts

@@ -2,7 +2,7 @@ import { Range } from './Range.js';
 /**
  * The pairs should be in ascending order.
  */
-export declare type IndexMap = {
+export type IndexMap = {
     outer: Range;
     inner: Range;
 }[];

package/lib/source/IndexMap.js

@@ -33,7 +33,7 @@ export var IndexMap;
     }
     IndexMap.toOuterRange = toOuterRange;
     function merge(outerMap, innerMap) {
-        return innerMap.map(p => ({
+        return innerMap.map((p) => ({
             inner: p.inner,
             outer: toOuterRange(outerMap, p.outer),
         }));

package/lib/source/LanguageError.js

@@ -15,7 +15,7 @@ export const LanguageError = Object.freeze({
             posRange: PositionRange.from(error.range, doc),
             message: error.message,
             severity: error.severity,
-            ...error.info && { info: error.info },
+            ...(error.info && { info: error.info }),
         };
     },
 });

package/lib/source/Location.d.ts

@@ -7,7 +7,7 @@ export interface Location {
     range: Range;
     posRange: PositionRange;
 }
-export declare type LocationLike = Partial<{
+export type LocationLike = Partial<{
     uri: string;
     range: RangeLike;
     posRange: PositionRange;

package/lib/source/Location.js

@@ -6,7 +6,10 @@ export var Location;
         return {
             uri: partial.uri ?? '',
             range: Range.get(partial.range ?? { start: 0, end: 0 }),
-            posRange: partial.posRange ?? { start: { line: 0, character: 0 }, end: { line: 0, character: 0 } },
+            posRange: partial.posRange ?? {
+                start: { line: 0, character: 0 },
+                end: { line: 0, character: 0 },
+            },
         };
     }
     Location.get = get;

package/lib/source/Offset.d.ts

@@ -1,5 +1,5 @@
 import { ReadonlySource } from './Source.js';
-export declare type OffsetLike = number | ReadonlySource | ((this: void) => number | ReadonlySource);
+export type OffsetLike = number | ReadonlySource | ((this: void) => number | ReadonlySource);
 export declare namespace Offset {
     /**
      * Get an offset from a `OffsetLike`.

package/lib/source/Range.d.ts

@@ -1,5 +1,5 @@
 import type { OffsetLike } from './Offset.js';
-export declare type RangeLike = Range | RangeContainer | OffsetLike | ((this: void) => Range | RangeContainer | OffsetLike);
+export type RangeLike = Range | RangeContainer | OffsetLike | ((this: void) => Range | RangeContainer | OffsetLike);
 export interface Range {
     start: number;
     end: number;

package/lib/source/Range.js

@@ -42,7 +42,8 @@ export var Range;
     }
     Range.span = span;
     function is(obj) {
-        return (!!obj && typeof obj === 'object' &&
+        return (!!obj &&
+            typeof obj === 'object' &&
             typeof obj.start === 'number' &&
             typeof obj.end === 'number');
     }
@@ -65,7 +66,8 @@ export var Range;
     Range.toString = toString;
     function contains(range, offset, endInclusive = false) {
         range = get(range);
-        return range.start <= offset && (endInclusive ? offset <= range.end : offset < range.end);
+        return (range.start <= offset &&
+            (endInclusive ? offset <= range.end : offset < range.end));
     }
     Range.contains = contains;
     function containsRange(a, b, endInclusive = false) {
@@ -144,7 +146,8 @@ export var Range;
 export var RangeContainer;
 (function (RangeContainer) {
     function is(obj) {
-        return (!!obj && typeof obj === 'object' &&
+        return (!!obj &&
+            typeof obj === 'object' &&
             Range.is(obj.range));
     }
     RangeContainer.is = is;

package/lib/source/Source.d.ts

@@ -1,10 +1,10 @@
 import { IndexMap } from './IndexMap.js';
 import type { RangeContainer } from './Range.js';
 import { Range } from './Range.js';
-declare type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
-declare type Space = ' ' | '\t';
-declare type Newline = '\r\n' | '\r' | '\n';
-declare type Whitespace = Space | Newline;
+type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+type Space = ' ' | '\t';
+type Newline = '\r\n' | '\r' | '\n';
+type Whitespace = Space | Newline;
 export declare const CRLF = "\r\n";
 export declare const CR = "\r";
 export declare const LF = "\n";

package/lib/source/Source.js

@@ -91,7 +91,9 @@ export class ReadonlySource {
     slice(param0, end) {
         if (typeof param0 === 'number') {
             const innerStart = IndexMap.toInnerOffset(this.indexMap, param0);
-            const innerEnd = end !== undefined ? IndexMap.toInnerOffset(this.indexMap, end) : undefined;
+            const innerEnd = end !== undefined
+                ? IndexMap.toInnerOffset(this.indexMap, end)
+                : undefined;
             return this.string.slice(innerStart, innerEnd);
         }
         const range = IndexMap.toInnerRange(this.indexMap, Range.get(param0));