@spyglassmc/core 0.3.0 → 0.4.0

package/lib/parser/util.d.ts

@@ -111,6 +111,7 @@ declare type ExtractFromGettableParser<T extends GettableParser> = T extends {
 declare type Case = {
     predicate?: (this: void, src: ReadonlySource) => boolean;
     prefix?: string;
+    regex?: RegExp;
     parser: GettableParser;
 };
 /**

package/lib/parser/util.js

@@ -150,8 +150,8 @@ export function recover(parser, defaultValue) {
 }
 export function select(cases) {
     return (src, ctx) => {
-        for (const { predicate, prefix, parser } of cases) {
-            if (predicate?.(src) ?? (prefix !== undefined ? src.tryPeek(prefix) : undefined) ?? true) {
+        for (const { predicate, prefix, parser, regex } of cases) {
+            if (predicate?.(src) ?? (prefix !== undefined ? src.tryPeek(prefix) : undefined) ?? (regex && src.matchPattern(regex)) ?? true) {
                 const callableParser = typeof parser === 'object' ? parser.get() : parser;
                 return callableParser(src, ctx);
             }

package/lib/processor/colorizer/builtin.js

@@ -20,7 +20,8 @@ export const comment = node => {
     return [ColorToken.create(node, 'comment')];
 };
 export const error = node => {
-    return [ColorToken.create(node, 'error')];
+    // return [ColorToken.create(node, 'error')]
+    return [];
 };
 export const literal = node => {
     return [ColorToken.create(node, node.options.colorTokenType ?? 'literal')];

package/lib/service/CacheService.d.ts

@@ -1,4 +1,5 @@
 import type { TextDocument } from 'vscode-languageserver-textdocument';
+import type { PosRangeLanguageError } from '../source/index.js';
 import { SymbolTable } from '../symbol/index.js';
 import type { RootUriString } from './fileUtil.js';
 import type { Project } from './Project.js';
@@ -6,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 = 1;
+export declare const LatestCacheVersion = 2;
 /**
  * Checksums of cached files or roots.
  */
@@ -18,6 +19,7 @@ interface Checksums {
 declare namespace Checksums {
     function create(): Checksums;
 }
+declare type ErrorCache = Record<string, readonly PosRangeLanguageError[]>;
 interface LoadResult {
     symbols: SymbolTable;
 }
@@ -32,6 +34,7 @@ export declare class CacheService {
     private readonly cacheRoot;
     private readonly project;
     checksums: Checksums;
+    errors: ErrorCache;
     /**
      * @param cacheRoot File path to the directory where cache files by Spyglass should be stored.
      * @param project
@@ -50,7 +53,7 @@ export declare class CacheService {
      */
     save(): Promise<boolean>;
     hasFileChangedSinceCache(doc: TextDocument): Promise<boolean>;
-    reset(): void;
+    reset(): LoadResult;
 }
 export {};
 //# sourceMappingURL=CacheService.d.ts.map

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 = 1;
+export const LatestCacheVersion = 2;
 var Checksums;
 (function (Checksums) {
     function create() {
@@ -21,6 +21,7 @@ export class CacheService {
     cacheRoot;
     project;
     checksums = Checksums.create();
+    errors = {};
     #hasValidatedFiles = false;
     /**
      * @param cacheRoot File path to the directory where cache files by Spyglass should be stored.
@@ -63,6 +64,9 @@ export class CacheService {
                 this.checksums.symbolRegistrars[id] = checksum;
             }
         });
+        this.project.on('documentErrored', ({ uri, errors }) => {
+            this.errors[uri] = errors;
+        });
     }
     #cacheFilePath;
     /**
@@ -84,6 +88,7 @@ export class CacheService {
             __profiler.task('Read File');
             if (cache.version === LatestCacheVersion) {
                 this.checksums = cache.checksums;
+                this.errors = cache.errors;
                 ans.symbols = SymbolTable.link(cache.symbols);
                 __profiler.task('Link Symbols');
             }
@@ -163,10 +168,11 @@ export class CacheService {
         try {
             filePath = await this.getCacheFileUri();
             const cache = {
-                checksums: this.checksums,
+                version: LatestCacheVersion,
                 projectRoot: this.project.projectRoot,
+                checksums: this.checksums,
                 symbols: SymbolTable.unlink(this.project.symbols.global),
-                version: LatestCacheVersion,
+                errors: this.errors,
             };
             __profiler.task('Unlink Symbols');
             await fileUtil.writeGzippedJson(this.project.externals, filePath, cache);
@@ -182,7 +188,10 @@ export class CacheService {
         return this.checksums.files[doc.uri] !== await this.project.externals.crypto.getSha1(doc.getText());
     }
     reset() {
+        this.#hasValidatedFiles = false;
         this.checksums = Checksums.create();
+        this.errors = {};
+        return { symbols: {} };
     }
 }
 //# sourceMappingURL=CacheService.js.map

package/lib/service/MetaRegistry.d.ts

@@ -26,6 +26,11 @@ interface LinterRegistration {
 }
 interface SymbolRegistrarRegistration {
     registrar: SymbolRegistrar;
+    /**
+     * A checksum associated with this symbol registrar.
+     * If the cached checksum is equal to this provided checksum,
+     * the symbol registrar is not executed.
+     */
     checksum: string | undefined;
 }
 /**

package/lib/service/Project.d.ts

@@ -4,7 +4,7 @@ import type { ExternalEventEmitter, Externals } from '../common/index.js';
 import { Logger } from '../common/index.js';
 import type { AstNode } from '../node/index.js';
 import { FileNode } from '../node/index.js';
-import type { LanguageError } from '../source/index.js';
+import type { PosRangeLanguageError } from '../source/index.js';
 import { SymbolUtil } from '../symbol/index.js';
 import { CacheService } from './CacheService.js';
 import type { Config } from './Config.js';
@@ -38,8 +38,10 @@ export interface DocAndNode {
 }
 interface DocumentEvent extends DocAndNode {
 }
-interface DocumentErrorEvent extends DocumentEvent {
-    errors: LanguageError[];
+interface DocumentErrorEvent {
+    errors: readonly PosRangeLanguageError[];
+    uri: string;
+    version?: number;
 }
 interface FileEvent {
     uri: string;
@@ -124,21 +126,21 @@ export declare class Project implements ExternalEventEmitter {
      */
     get cacheRoot(): RootUriString;
     private updateRoots;
-    on(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
+    on(event: 'documentErrored', callbackFn: (data: DocumentErrorEvent) => void): this;
     on(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
     on(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
     on(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
     on(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
     on(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
     on(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
-    once(event: 'documentErrorred', callbackFn: (data: DocumentErrorEvent) => void): this;
+    once(event: 'documentErrored', callbackFn: (data: DocumentErrorEvent) => void): this;
     once(event: 'documentUpdated', callbackFn: (data: DocumentEvent) => void): this;
     once(event: 'documentRemoved', callbackFn: (data: FileEvent) => void): this;
     once(event: `file${'Created' | 'Modified' | 'Deleted'}`, callbackFn: (data: FileEvent) => void): this;
     once(event: 'ready', callbackFn: (data: EmptyEvent) => void): this;
     once(event: 'rootsUpdated', callbackFn: (data: RootsEvent) => void): this;
     once(event: 'symbolRegistrarExecuted', callbackFn: (data: SymbolRegistrarEvent) => void): this;
-    emit(event: 'documentErrorred', data: DocumentErrorEvent): boolean;
+    emit(event: 'documentErrored', data: DocumentErrorEvent): boolean;
     emit(event: 'documentUpdated', data: DocumentEvent): boolean;
     emit(event: 'documentRemoved', data: FileEvent): boolean;
     emit(event: `file${'Created' | 'Modified' | 'Deleted'}`, data: FileEvent): boolean;
@@ -168,7 +170,7 @@ export declare class Project implements ExternalEventEmitter {
      */
     close(): Promise<void>;
     restart(): Promise<void>;
-    resetCache(): void;
+    resetCache(): Promise<void>;
     normalizeUri(uri: string): string;
     private static readonly TextDocumentCacheMaxLength;
     private removeCachedTextDocument;

package/lib/service/Project.js

@@ -9,7 +9,7 @@ import { bufferToString, Logger, SingletonPromise, StateProxy } from '../common/
 import { FileNode } from '../node/index.js';
 import { file } from '../parser/index.js';
 import { traversePreOrder } from '../processor/index.js';
-import { Source } from '../source/index.js';
+import { LanguageError, Source } from '../source/index.js';
 import { SymbolUtil } from '../symbol/index.js';
 import { CacheService } from './CacheService.js';
 import { ConfigService, LinterConfigValue } from './Config.js';
@@ -183,11 +183,14 @@ export class Project {
             // if (!this.#isReady) {
             // 	return
             // }
-            this.emit('documentErrorred', {
-                doc,
-                errors: FileNode.getErrors(node),
-                node,
+            this.emit('documentErrored', {
+                errors: FileNode.getErrors(node).map(e => LanguageError.withPosRange(e, doc)),
+                uri: doc.uri,
+                version: doc.version,
             });
+        })
+            .on('documentRemoved', ({ uri }) => {
+            this.emit('documentErrored', { errors: [], uri });
         })
             .on('fileCreated', async ({ uri }) => {
             if (uri.endsWith(Project.RootSuffix)) {
@@ -292,6 +295,7 @@ export class Project {
             this.fs.register(ArchiveUriSupporter.Protocol, archiveUriSupporter, true);
         };
         const listProjectFiles = () => new Promise(resolve => {
+            this.#watchedFiles.clear();
             this.#watcherReady = false;
             this.#watcher = this.externals.fs
                 .watch(this.projectRoot)
@@ -345,9 +349,13 @@ export class Project {
                 }
             }
             __profiler.task('Register Symbols');
+            for (const [uri, values] of Object.entries(this.cacheService.errors)) {
+                this.emit('documentErrored', { errors: values, uri });
+            }
+            __profiler.task('Pop Errors');
             const { addedFiles, changedFiles, removedFiles } = await this.cacheService.validate();
             for (const uri of removedFiles) {
-                this.symbols.clear({ uri });
+                this.emit('fileDeleted', { uri });
             }
             __profiler.task('Validate Cache');
             if (addedFiles.length > 0) {
@@ -366,6 +374,7 @@ export class Project {
             __profiler.finalize();
             this.emit('ready', {});
         };
+        this.#isReady = false;
         this.#readyPromise = ready();
     }
     /**
@@ -393,6 +402,8 @@ export class Project {
     async restart() {
         try {
             await this.#watcher.close();
+            this.#bindingInProgressUris.clear();
+            this.#symbolUpToDateUris.clear();
             this.setReadyPromise();
             await this.ready();
         }
@@ -401,7 +412,16 @@ export class Project {
         }
     }
     resetCache() {
-        return this.cacheService.reset();
+        this.logger.info('[Project#resetCache] Initiated...');
+        // Clear existing errors.
+        for (const uri of Object.keys(this.cacheService.errors)) {
+            this.emit('documentErrored', { errors: [], uri });
+        }
+        // Reset cache.
+        const { symbols } = this.cacheService.reset();
+        this.symbols = new SymbolUtil(symbols, this.externals.event.EventEmitter);
+        this.symbols.buildCache();
+        return this.restart();
     }
     normalizeUri(uri) {
         return this.fs.mapFromDisk(this.externals.uri.normalize(uri));

package/lib/source/LanguageError.d.ts

@@ -1,14 +1,28 @@
+import type { TextDocument } from 'vscode-languageserver-textdocument';
 import type { Location } from './Location.js';
+import { PositionRange } from './PositionRange.js';
 import type { Range } from './Range.js';
-export interface LanguageError {
+export interface LanguageErrorData {
     message: string;
-    range: Range;
     severity: ErrorSeverity;
     info?: LanguageErrorInfo;
 }
-export declare namespace LanguageError {
-    function create(message: string, range: Range, severity?: ErrorSeverity, info?: LanguageErrorInfo): LanguageError;
+export interface LanguageError extends LanguageErrorData {
+    range: Range;
+}
+/**
+ * A language error that uses {@link PositionRange} instead of {@link Range} to represent the span of the error.
+ */
+export interface PosRangeLanguageError extends LanguageErrorData {
+    posRange: PositionRange;
 }
+export declare const LanguageError: Readonly<{
+    create(message: string, range: Range, severity?: ErrorSeverity, info?: LanguageErrorInfo): LanguageError;
+    /**
+     * @returns A {@link PosRangeLanguageError}.
+     */
+    withPosRange(error: LanguageError, doc: TextDocument): PosRangeLanguageError;
+}>;
 export declare const enum ErrorSeverity {
     Hint = 0,
     Information = 1,

package/lib/source/LanguageError.js

@@ -1,12 +1,22 @@
-export var LanguageError;
-(function (LanguageError) {
-    function create(message, range, severity = 3 /* ErrorSeverity.Error */, info) {
+import { PositionRange } from './PositionRange.js';
+export const LanguageError = Object.freeze({
+    create(message, range, severity = 3 /* ErrorSeverity.Error */, info) {
         const ans = { range, message, severity };
         if (info) {
             ans.info = info;
         }
         return ans;
-    }
-    LanguageError.create = create;
-})(LanguageError || (LanguageError = {}));
+    },
+    /**
+     * @returns A {@link PosRangeLanguageError}.
+     */
+    withPosRange(error, doc) {
+        return {
+            posRange: PositionRange.from(error.range, doc),
+            message: error.message,
+            severity: error.severity,
+            ...error.info && { info: error.info },
+        };
+    },
+});
 //# sourceMappingURL=LanguageError.js.map

package/lib/source/PositionRange.d.ts

@@ -12,7 +12,7 @@ export declare namespace PositionRange {
     /**
      * @returns A `PositionRange` converted from a `RangeLike`.
      */
-    function from(range: RangeLike, doc: TextDocument): PositionRange;
+    function from(rangeLike: RangeLike, doc: TextDocument): PositionRange;
     /**
      * ```typescript
      * {

package/lib/source/PositionRange.js

@@ -27,11 +27,11 @@ export var PositionRange;
     /**
      * @returns A `PositionRange` converted from a `RangeLike`.
      */
-    function from(range, doc) {
-        const _range = Range.get(range);
+    function from(rangeLike, doc) {
+        const range = Range.get(rangeLike);
         const ans = {
-            start: doc.positionAt(_range.start),
-            end: doc.positionAt(_range.end),
+            start: doc.positionAt(range.start),
+            end: doc.positionAt(range.end),
         };
         return ans;
     }

package/lib/source/Source.d.ts

@@ -43,6 +43,8 @@ export declare class ReadonlySource {
     tryPeekAfterWhitespace(expectedValue: string): boolean;
     peekUntil(...terminators: string[]): string;
     peekLine(): string;
+    peekRemaining(): string;
+    matchPattern(regex: RegExp): boolean;
     hasNonSpaceAheadInLine(): boolean;
     slice(start: number, end?: number): string;
     slice(rangeLike: Range | RangeContainer): string;

package/lib/source/Source.js

@@ -70,6 +70,12 @@ export class ReadonlySource {
     peekLine() {
         return this.peekUntil(CR, LF);
     }
+    peekRemaining() {
+        return this.string.slice(this.innerCursor);
+    }
+    matchPattern(regex) {
+        return regex.test(this.peekRemaining());
+    }
     hasNonSpaceAheadInLine() {
         for (let cursor = this.innerCursor; cursor < this.string.length; cursor++) {
             const c = this.string.charAt(cursor);

package/package.json

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