@spyglassmc/core 0.1.0 → 0.1.1

package/lib/node/StringNode.d.ts

@@ -7,7 +7,7 @@ export declare type EscapeChar = typeof EscapeChars[number];
 export declare namespace EscapeChar {
     function is(expected: EscapeChar[] | undefined, c: string): c is EscapeChar;
 }
-export declare const EscapeTable: Map<"b" | "f" | "'" | "\"" | "n" | "r" | "t" | "\\", string>;
+export declare const EscapeTable: Map<"\"" | "'" | "b" | "f" | "n" | "r" | "t" | "\\", string>;
 export declare type Quote = "'" | '"';
 export interface StringOptions {
     colorTokenType?: ColorTokenType;

package/lib/parser/string.d.ts

@@ -6,11 +6,11 @@ import type { Parser, Result, Returnable } from './Parser';
 export declare function string(options: StringOptions): InfallibleParser<StringNode>;
 export declare function parseStringValue<T extends Returnable>(parser: Parser<T>, value: string, map: IndexMap, ctx: ParserContext): Result<T>;
 export declare const BrigadierUnquotableCharacters: readonly ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "_", ".", "+", "-"];
-export declare const BrigadierUnquotableCharacterSet: Set<"0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "b" | "B" | "d" | "D" | "f" | "F" | "l" | "L" | "s" | "S" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "c" | "g" | "h" | "j" | "k" | "m" | "n" | "o" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "_" | "A" | "C" | "E" | "G" | "H" | "I" | "J" | "K" | "M" | "N" | "O" | "P" | "Q" | "R" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
+export declare const BrigadierUnquotableCharacterSet: Set<"0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "k" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
 export declare const BrigadierUnquotablePattern: RegExp;
 export declare const BrigadierUnquotableOption: {
     allowEmpty: boolean;
-    allowList: Set<"0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "b" | "B" | "d" | "D" | "f" | "F" | "l" | "L" | "s" | "S" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "c" | "g" | "h" | "j" | "k" | "m" | "n" | "o" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "_" | "A" | "C" | "E" | "G" | "H" | "I" | "J" | "K" | "M" | "N" | "O" | "P" | "Q" | "R" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
+    allowList: Set<"0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "k" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
 };
 export declare const BrigadierStringOptions: StringOptions;
 export declare const brigadierString: InfallibleParser<StringNode>;

package/lib/processor/checker/builtin.d.ts

@@ -17,6 +17,7 @@ export declare const noop: SyncChecker<AstNode>;
  * Use the shallowest children that have their own checker to validate.
  */
 export declare const fallback: Checker<AstNode>;
+export declare const dispatchSync: SyncChecker<AstNode>;
 export declare const resourceLocation: Checker<ResourceLocationNode>;
 export declare const symbol: Checker<SymbolBaseNode>;
 export declare function registerCheckers(meta: MetaRegistry): void;

package/lib/processor/checker/builtin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerCheckers = exports.symbol = exports.resourceLocation = exports.fallback = exports.noop = exports.any = exports.attempt = void 0;
+exports.registerCheckers = exports.symbol = exports.resourceLocation = exports.dispatchSync = exports.fallback = exports.noop = exports.any = exports.attempt = void 0;
 const lib_1 = require("../../../../locales/lib");
 const node_1 = require("../../node");
 const service_1 = require("../../service");
@@ -61,6 +61,15 @@ const fallback = async (node, ctx) => {
     await Promise.allSettled(promises);
 };
 exports.fallback = fallback;
+const dispatchSync = (node, ctx) => {
+    for (const child of node.children ?? []) {
+        if (ctx.meta.hasChecker(child.type)) {
+            const checker = ctx.meta.getChecker(child.type);
+            checker(child, ctx);
+        }
+    }
+};
+exports.dispatchSync = dispatchSync;
 const resourceLocation = (node, ctx) => {
     const full = node_1.ResourceLocationNode.toString(node, 'full');
     if (node.options.pool) {

package/lib/processor/linter/builtin.js

@@ -85,11 +85,6 @@ var configValidator;
     configValidator.symbolLinterConfig = symbolLinterConfig;
 })(configValidator = exports.configValidator || (exports.configValidator = {}));
 function registerLinters(meta) {
-    meta.registerLinter('nameOfNbtKey', {
-        configValidator: configValidator.nameConvention,
-        linter: nameConvention('value'),
-        nodePredicate: n => n.parent?.parent?.type === 'nbt:compound' && n.parent.type === 'pair' && n.type === 'string',
-    });
     meta.registerLinter('nameOfObjective', {
         configValidator: configValidator.nameConvention,
         linter: nameConvention('value'),

package/lib/service/CacheService.js

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _CacheService_cacheFilePath;
+var _CacheService_hasValidatedFiles, _CacheService_cacheFilePath;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheService = exports.LatestCacheVersion = void 0;
 const path_1 = __importDefault(require("path"));
@@ -45,8 +45,17 @@ class CacheService {
         this.cacheRoot = cacheRoot;
         this.project = project;
         this.checksums = Checksums.create();
+        _CacheService_hasValidatedFiles.set(this, false
+        /**
+         * @param cacheRoot File path to the directory where cache files by Spyglass should be stored.
+         * @param project
+         */
+        );
         _CacheService_cacheFilePath.set(this, void 0);
         this.project.on('documentUpdated', ({ doc }) => {
+            if (!__classPrivateFieldGet(this, _CacheService_hasValidatedFiles, "f")) {
+                return;
+            }
             try {
                 // TODO: Don't update this for every single change.
                 this.checksums.files[doc.uri] = (0, common_1.getSha1)(doc.getText());
@@ -58,6 +67,9 @@ class CacheService {
             }
         });
         this.project.on('rootsUpdated', async ({ roots }) => {
+            if (!__classPrivateFieldGet(this, _CacheService_hasValidatedFiles, "f")) {
+                return;
+            }
             for (const root of roots) {
                 try {
                     this.checksums.roots[root] = await this.project.fs.hash(root);
@@ -89,6 +101,7 @@ class CacheService {
         let filePath;
         try {
             filePath = this.getCacheFilePath();
+            this.project.logger.info(`[CacheService#load] symbolCachePath = “${filePath}”`);
             const cache = await fileUtil_1.fileUtil.readGzippedJson(filePath);
             __profiler.task('Read File');
             if (cache.version === exports.LatestCacheVersion) {
@@ -102,7 +115,7 @@ class CacheService {
         }
         catch (e) {
             if (!(0, common_1.isEnoent)(e)) {
-                this.project.logger.error(`[CacheService#load] path = “${filePath}”`, e);
+                this.project.logger.error('[CacheService#load] ', e);
             }
         }
         __profiler.finalize();
@@ -160,6 +173,7 @@ class CacheService {
                 ans.addedFiles.push(uri);
             }
         }
+        __classPrivateFieldSet(this, _CacheService_hasValidatedFiles, true, "f");
         return ans;
     }
     /**
@@ -191,5 +205,5 @@ class CacheService {
     }
 }
 exports.CacheService = CacheService;
-_CacheService_cacheFilePath = new WeakMap();
+_CacheService_hasValidatedFiles = new WeakMap(), _CacheService_cacheFilePath = new WeakMap();
 //# sourceMappingURL=CacheService.js.map

package/lib/service/Project.d.ts

@@ -84,6 +84,7 @@ export declare class Project extends EventEmitter {
     #private;
     private static readonly RootSuffix;
     readonly cacheService: CacheService;
+    get isReady(): boolean;
     config: Config;
     readonly downloader: Downloader;
     readonly fs: FileService;
@@ -150,6 +151,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.

package/lib/service/Project.js

@@ -19,7 +19,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _Project_cacheSaverIntervalId, _Project_clientManagedUris, _Project_configService, _Project_docAndNodes, _Project_initializers, _Project_initPromise, _Project_readyPromise, _Project_watchedFiles, _Project_watcher, _Project_watcherReady, _Project_dependencyRoots, _Project_dependencyFiles, _Project_roots, _Project_ctx, _Project_cacheRoot;
+var _Project_cacheSaverIntervalId, _Project_clientManagedUris, _Project_configService, _Project_docAndNodes, _Project_initializers, _Project_initPromise, _Project_readyPromise, _Project_watchedFiles, _Project_watcher, _Project_watcherReady, _Project_isReady, _Project_dependencyRoots, _Project_dependencyFiles, _Project_roots, _Project_ctx, _Project_cacheRoot;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Project = exports.ProjectData = void 0;
 const chokidar_1 = __importDefault(require("chokidar"));
@@ -89,6 +89,7 @@ class Project extends events_1.default {
         _Project_watchedFiles.set(this, new Set());
         _Project_watcher.set(this, void 0);
         _Project_watcherReady.set(this, false);
+        _Project_isReady.set(this, false);
         this.meta = new MetaRegistry_1.MetaRegistry();
         _Project_dependencyRoots.set(this, void 0);
         _Project_dependencyFiles.set(this, void 0);
@@ -129,6 +130,9 @@ class Project extends events_1.default {
         __classPrivateFieldSet(this, _Project_cacheSaverIntervalId, setInterval(() => this.cacheService.save(), CacheAutoSaveInterval), "f");
         this
             .on('documentUpdated', ({ doc, node }) => {
+            if (!__classPrivateFieldGet(this, _Project_isReady, "f")) {
+                return;
+            }
             this.emit('documentErrorred', {
                 doc,
                 errors: node_1.FileNode.getErrors(node),
@@ -136,7 +140,6 @@ class Project extends events_1.default {
             });
         })
             .on('fileCreated', async ({ uri }) => {
-            __classPrivateFieldGet(this, _Project_watchedFiles, "f").add(uri);
             if (uri.endsWith(Project.RootSuffix)) {
                 this.updateRoots();
             }
@@ -150,14 +153,28 @@ class Project extends events_1.default {
             }
         })
             .on('fileDeleted', ({ uri }) => {
-            __classPrivateFieldGet(this, _Project_watchedFiles, "f").delete(uri);
             if (uri.endsWith(Project.RootSuffix)) {
                 this.updateRoots();
             }
             this.symbols.clear({ uri });
             this.tryClearingCache(uri);
+        })
+            .on('ready', () => {
+            __classPrivateFieldSet(this, _Project_isReady, true, "f");
+            // Recheck client managed files.
+            const promises = [];
+            for (const uri of __classPrivateFieldGet(this, _Project_clientManagedUris, "f")) {
+                const result = __classPrivateFieldGet(this, _Project_docAndNodes, "f").get(uri);
+                if (result) {
+                    promises.push(this.check(result.doc, result.node));
+                }
+            }
+            Promise.all(promises).catch(e => this.logger.error('[Project#ready] Error occurred when rechecking client managed files after ready', e));
         });
     }
+    get isReady() {
+        return __classPrivateFieldGet(this, _Project_isReady, "f");
+    }
     /**
      * All tracked root URIs. Each URI in this array is guaranteed to end with a slash (`/`).
      *
@@ -360,7 +377,6 @@ class Project extends events_1.default {
         return this;
     }
     async ready() {
-        await __classPrivateFieldGet(this, _Project_initPromise, "f");
         await __classPrivateFieldGet(this, _Project_readyPromise, "f");
         return this;
     }
@@ -507,11 +523,18 @@ class Project extends events_1.default {
         }
         return result;
     }
+    async ensureParsedAndCheckedOnlyWhenReady(uri) {
+        const result = await this.ensureParsed(uri);
+        if (__classPrivateFieldGet(this, _Project_isReady, "f") && result) {
+            await this.ensureChecked(result.doc, result.node);
+        }
+        return result;
+    }
     bind(param) {
         const ctx = Context_1.UriBinderContext.create(this);
-        // Remove all symbol locations contributed by URI binders if the parameter is an array.
-        // Otherwise only remove the ones associated with the specified URI.
-        ctx.symbols.clear({ contributor: 'uri_binder', uri: Array.isArray(param) ? undefined : param });
+        if (typeof param === 'string') {
+            ctx.symbols.clear({ contributor: 'uri_binder', uri: param });
+        }
         ctx.symbols.contributeAs('uri_binder', () => {
             const uris = Array.isArray(param) ? param : [param];
             for (const binder of this.meta.uriBinders) {
@@ -527,7 +550,9 @@ class Project extends events_1.default {
         __classPrivateFieldGet(this, _Project_clientManagedUris, "f").add(uri);
         const doc = vscode_languageserver_textdocument_1.TextDocument.create(uri, languageID, version, content);
         const { node } = this.parseAndCache(doc);
-        this.check(doc, node);
+        if (__classPrivateFieldGet(this, _Project_isReady, "f")) {
+            this.check(doc, node);
+        }
     }
     /**
      * Notify that an existing document was changed in the editor.
@@ -541,7 +566,9 @@ class Project extends events_1.default {
         }
         vscode_languageserver_textdocument_1.TextDocument.update(result.doc, changes, version);
         const { node } = this.parseAndCache(result.doc);
-        this.check(result.doc, node);
+        if (__classPrivateFieldGet(this, _Project_isReady, "f")) {
+            this.check(result.doc, node);
+        }
     }
     /**
      * Notify that an existing document was closed in the editor.
@@ -575,7 +602,7 @@ class Project extends events_1.default {
         return __classPrivateFieldGet(this, _Project_watchedFiles, "f").has(uri) && !__classPrivateFieldGet(this, _Project_clientManagedUris, "f").has(uri) && !__classPrivateFieldGet(this, _Project_dependencyFiles, "f").has(uri);
     }
 }
-_Project_cacheSaverIntervalId = new WeakMap(), _Project_clientManagedUris = new WeakMap(), _Project_configService = new WeakMap(), _Project_docAndNodes = new WeakMap(), _Project_initializers = new WeakMap(), _Project_initPromise = new WeakMap(), _Project_readyPromise = new WeakMap(), _Project_watchedFiles = new WeakMap(), _Project_watcher = new WeakMap(), _Project_watcherReady = new WeakMap(), _Project_dependencyRoots = new WeakMap(), _Project_dependencyFiles = new WeakMap(), _Project_roots = new WeakMap(), _Project_ctx = new WeakMap(), _Project_cacheRoot = new WeakMap();
+_Project_cacheSaverIntervalId = new WeakMap(), _Project_clientManagedUris = new WeakMap(), _Project_configService = new WeakMap(), _Project_docAndNodes = new WeakMap(), _Project_initializers = new WeakMap(), _Project_initPromise = new WeakMap(), _Project_readyPromise = new WeakMap(), _Project_watchedFiles = new WeakMap(), _Project_watcher = new WeakMap(), _Project_watcherReady = new WeakMap(), _Project_isReady = new WeakMap(), _Project_dependencyRoots = new WeakMap(), _Project_dependencyFiles = new WeakMap(), _Project_roots = new WeakMap(), _Project_ctx = new WeakMap(), _Project_cacheRoot = new WeakMap();
 Project.RootSuffix = '/pack.mcmeta';
 __decorate([
     (0, common_1.CachePromise)()
@@ -589,5 +616,8 @@ __decorate([
 __decorate([
     (0, common_1.CachePromise)()
 ], Project.prototype, "ensureParsedAndChecked", null);
+__decorate([
+    (0, common_1.CachePromise)()
+], Project.prototype, "ensureParsedAndCheckedOnlyWhenReady", null);
 exports.Project = Project;
 //# sourceMappingURL=Project.js.map

package/lib/source/Source.d.ts

@@ -38,6 +38,9 @@ export declare class ReadonlySource {
      * @see {@link Source.trySkip}
      */
     tryPeek(expectedValue: string): boolean;
+    peekUntil(...terminators: string[]): string;
+    peekLine(): string;
+    hasNonSpaceAheadInLine(): boolean;
     slice(start: number, end?: number): string;
     slice(rangeLike: Range | RangeContainer): string;
     sliceToCursor(start: number): string;

package/lib/source/Source.js

@@ -45,6 +45,34 @@ class ReadonlySource {
     tryPeek(expectedValue) {
         return this.peek(expectedValue.length) === expectedValue;
     }
+    peekUntil(...terminators) {
+        let ans = '';
+        for (let cursor = this.innerCursor; cursor < this.string.length; cursor++) {
+            const c = this.string.charAt(cursor);
+            if (terminators.includes(c)) {
+                return ans;
+            }
+            else {
+                ans += c;
+            }
+        }
+        return ans;
+    }
+    peekLine() {
+        return this.peekUntil(exports.CR, exports.LF);
+    }
+    hasNonSpaceAheadInLine() {
+        for (let cursor = this.innerCursor; cursor < this.string.length; cursor++) {
+            const c = this.string.charAt(cursor);
+            if (c === exports.CR || c === exports.LF) {
+                break;
+            }
+            if (!(c === ' ' || c === '\t')) {
+                return true;
+            }
+        }
+        return false;
+    }
     slice(param0, end) {
         if (typeof param0 === 'number') {
             const innerStart = _1.IndexMap.toInnerOffset(this.indexMap, param0);