@spyglassmc/core 0.4.27 → 0.4.28

package/lib/node/StringNode.d.ts

@@ -2,12 +2,12 @@ import type { Parser } from '../parser/index.js';
 import type { ColorTokenType } from '../processor/index.js';
 import type { IndexMap, RangeLike } from '../source/index.js';
 import type { AstNode } from './AstNode.js';
-export declare const EscapeChars: readonly ["\"", "'", "\\", "b", "f", "n", "r", "t"];
+export declare const EscapeChars: readonly ["\"", "'", "\\", "b", "f", "n", "r", "s", "t"];
 export 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" | "s" | "t", string>;
 export type Quote = "'" | '"';
 export interface StringOptions {
     colorTokenType?: ColorTokenType;

package/lib/node/StringNode.js

@@ -1,5 +1,5 @@
 import { Range } from '../source/index.js';
-export const EscapeChars = ['"', "'", '\\', 'b', 'f', 'n', 'r', 't'];
+export const EscapeChars = ['"', "'", '\\', 'b', 'f', 'n', 'r', 's', 't'];
 export var EscapeChar;
 (function (EscapeChar) {
     /* istanbul ignore next */
@@ -16,6 +16,7 @@ export const EscapeTable = new Map([
     ['f', '\f'],
     ['n', '\n'],
     ['r', '\r'],
+    ['s', ' '],
     ['t', '\t'],
 ]);
 export var StringBaseNode;

package/lib/service/CacheService.js

@@ -1,5 +1,6 @@
 import { Uri } from '../common/index.js';
 import { SymbolTable } from '../symbol/index.js';
+import { ArchiveUriSupporter } from './FileService.js';
 import { fileUtil } from './fileUtil.js';
 /**
  * The format version of the cache. Should be increased when any changes that
@@ -27,7 +28,10 @@ export class CacheService {
         this.cacheRoot = cacheRoot;
         this.project = project;
         this.project.on('documentUpdated', async ({ doc }) => {
-            if (!this.#hasValidatedFiles) {
+            if (!this.#hasValidatedFiles
+                // Do not save checksums for file schemes that we cannot map to disk (e.g. 'untitled:'
+                // for untitled files in VS Code)
+                || !(doc.uri.startsWith(ArchiveUriSupporter.Protocol) || doc.uri.startsWith('file:'))) {
                 return;
             }
             try {

package/lib/service/Context.d.ts

@@ -153,5 +153,10 @@ export interface UriBinderContext extends ContextBase {
 export declare namespace UriBinderContext {
     function create(project: ProjectData): UriBinderContext;
 }
+export interface UriPredicateContext extends ContextBase {
+}
+export declare namespace UriPredicateContext {
+    function create(project: ProjectData): UriPredicateContext;
+}
 export {};
 //# sourceMappingURL=Context.d.ts.map

package/lib/service/Context.js

@@ -143,4 +143,11 @@ export var UriBinderContext;
     }
     UriBinderContext.create = create;
 })(UriBinderContext || (UriBinderContext = {}));
+export var UriPredicateContext;
+(function (UriPredicateContext) {
+    function create(project) {
+        return { ...ContextBase.create(project) };
+    }
+    UriPredicateContext.create = create;
+})(UriPredicateContext || (UriPredicateContext = {}));
 //# sourceMappingURL=Context.js.map

package/lib/service/FileService.js

@@ -200,10 +200,12 @@ export class ArchiveUriSupporter {
         return entry.data;
     }
     *listFiles() {
-        for (const [archiveName, files] of this.entries.entries()) {
-            this.logger.info(`[ArchiveUriSupporter#listFiles] Listing ${files.size} files from ${archiveName}`);
-            for (const file of files.values()) {
-                yield ArchiveUriSupporter.getUri(archiveName, file.path);
+        for (const [archiveName, entries] of this.entries.entries()) {
+            this.logger.info(`[ArchiveUriSupporter#listFiles] Listing ${entries.size} entries from ${archiveName}`);
+            for (const entry of entries.values()) {
+                if (entry.type === 'file') {
+                    yield ArchiveUriSupporter.getUri(archiveName, entry.path);
+                }
             }
         }
     }

package/lib/service/MetaRegistry.d.ts

@@ -6,6 +6,7 @@ import type { Formatter } from '../processor/formatter/index.js';
 import type { Binder, Checker, CodeActionProvider, Colorizer, Completer, InlayHintProvider } from '../processor/index.js';
 import type { Linter } from '../processor/linter/Linter.js';
 import type { SignatureHelpProvider } from '../processor/SignatureHelpProvider.js';
+import type { UriPredicateContext } from '../service/index.js';
 import type { DependencyKey, DependencyProvider } from './Dependency.js';
 import type { FileExtension } from './fileUtil.js';
 import type { SymbolRegistrar } from './SymbolRegistrar.js';
@@ -16,10 +17,16 @@ export interface LanguageOptions {
      * An array of extensions of files corresponding to the language. Each extension should include the leading dot (`.`).
      */
     extensions: FileExtension[];
+    /**
+     * If specified, the URI of the file must pass the predicate for it to be considered to be a file
+     * of this language.
+     */
+    uriPredicate?: UriPredicate;
     triggerCharacters?: string[];
     parser?: Parser<AstNode>;
     completer?: Completer<any>;
 }
+export type UriPredicate = (uri: string, ctx: UriPredicateContext) => boolean;
 interface LinterRegistration {
     configValidator: (ruleName: string, ruleValue: unknown, logger: Logger) => unknown;
     linter: Linter<AstNode>;
@@ -50,11 +57,7 @@ export declare class MetaRegistry {
      * An array of all registered language IDs.
      */
     getLanguages(): string[];
-    isSupportedLanguage(language: string): boolean;
-    /**
-     * An array of file extensions (including the leading dot (`.`)) that are supported.
-     */
-    getSupportedFileExtensions(): FileExtension[];
+    getLanguageOptions(language: string): LanguageOptions | undefined;
     /**
      * An array of characters that trigger a completion request.
      */

package/lib/service/MetaRegistry.js

@@ -48,14 +48,8 @@ export class MetaRegistry {
     getLanguages() {
         return Array.from(this.#languages.keys());
     }
-    isSupportedLanguage(language) {
-        return this.#languages.has(language);
-    }
-    /**
-     * An array of file extensions (including the leading dot (`.`)) that are supported.
-     */
-    getSupportedFileExtensions() {
-        return [...this.#languages.values()].flatMap((v) => v.extensions);
+    getLanguageOptions(language) {
+        return this.#languages.get(language);
     }
     /**
      * An array of characters that trigger a completion request.

package/lib/service/Project.d.ts

@@ -199,7 +199,19 @@ export declare class Project implements ExternalEventEmitter {
     ensureClientManagedChecked(uri: string): Promise<DocAndNode | undefined>;
     getClientManaged(uri: string): DocAndNode | undefined;
     showCacheRoot(): Promise<void>;
-    shouldExclude(uri: string): boolean;
+    /**
+     * Returns true iff the URI should be excluded from all Spyglass language support.
+     *
+     * @param language Optional. If ommitted, a language will be derived from the URI according to
+     *                 its file extension.
+     */
+    shouldExclude(uri: string, language?: string): boolean;
+    private isSupportedLanguage;
+    /**
+     * Guess a language ID from a URI. The guessed language ID may or may not actually be supported.
+     */
+    private guessLanguageID;
+    private isUserExcluded;
     private tryClearingCache;
     private shouldRemove;
     private isOnlyWatched;

package/lib/service/Project.js

@@ -14,7 +14,7 @@ import { LanguageError, Range, 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, UriPredicateContext, } from './Context.js';
 import { DependencyKey } from './Dependency.js';
 import { Downloader } from './Downloader.js';
 import { LinterErrorReporter } from './ErrorReporter.js';
@@ -152,10 +152,7 @@ export class Project {
      * are not loaded into the memory.
      */
     getTrackedFiles() {
-        const extensions = this.meta.getSupportedFileExtensions();
-        this.logger.info(`[Project#getTrackedFiles] Supported file extensions: ${extensions}`);
-        const supportedFiles = [...this.#dependencyFiles ?? [], ...this.#watchedFiles]
-            .filter((file) => extensions.includes(fileUtil.extname(file) ?? ''));
+        const supportedFiles = [...this.#dependencyFiles ?? [], ...this.#watchedFiles];
         this.logger.info(`[Project#getTrackedFiles] Listed ${supportedFiles.length} supported files`);
         return supportedFiles;
     }
@@ -334,7 +331,8 @@ export class Project {
             await this.init();
             const __profiler = this.profilers.get('project#ready');
             await Promise.all([listDependencyFiles(), listProjectFiles()]);
-            this.#dependencyFiles = new Set(this.fs.listFiles());
+            this.#dependencyFiles = new Set([...this.fs.listFiles()]
+                .filter((uri) => !this.shouldExclude(uri)));
             this.#dependencyRoots = new Set(this.fs.listRoots());
             this.updateRoots();
             __profiler.task('List URIs');
@@ -451,13 +449,9 @@ export class Project {
         this.#textDocumentCache.delete(uri);
     }
     async read(uri) {
-        const getLanguageID = (uri) => {
-            const ext = fileUtil.extname(uri) ?? '.plaintext';
-            return this.meta.getLanguageID(ext) ?? ext.slice(1);
-        };
         const createTextDocument = async (uri) => {
-            const languageId = getLanguageID(uri);
-            if (!this.meta.isSupportedLanguage(languageId)) {
+            const languageId = this.guessLanguageID(uri);
+            if (!this.isSupportedLanguage(uri, languageId)) {
                 return undefined;
             }
             try {
@@ -642,10 +636,10 @@ export class Project {
      */
     async onDidOpen(uri, languageID, version, content) {
         uri = this.normalizeUri(uri);
-        if (!fileUtil.isFileUri(uri)) {
-            return; // We only accept `file:` scheme for client-managed URIs.
+        if (uri.startsWith(ArchiveUriSupporter.Protocol)) {
+            return; // We do not accept `archive:` scheme for client-managed URIs.
         }
-        if (this.shouldExclude(uri)) {
+        if (this.shouldExclude(uri, languageID)) {
             return;
         }
         const doc = TextDocument.create(uri, languageID, version, content);
@@ -664,15 +658,16 @@ export class Project {
     async onDidChange(uri, changes, version) {
         uri = this.normalizeUri(uri);
         this.#symbolUpToDateUris.delete(uri);
-        if (!fileUtil.isFileUri(uri)) {
-            return; // We only accept `file:` scheme for client-managed URIs.
-        }
-        if (this.shouldExclude(uri)) {
-            return;
+        if (uri.startsWith(ArchiveUriSupporter.Protocol)) {
+            return; // We do not accept `archive:` scheme for client-managed URIs.
         }
         const doc = this.#clientManagedDocAndNodes.get(uri)?.doc;
-        if (!doc) {
-            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?`);
+        if (!doc || this.shouldExclude(uri, doc.languageId)) {
+            // If doc is undefined, it means the document was previously excluded by onDidOpen()
+            // based on the language ID supplied by the client, in which case we should return early.
+            // Otherwise, we perform the shouldExclude() check with the URI and the saved language ID
+            // as usual.
+            return;
         }
         TextDocument.update(doc, changes, version);
         const node = this.parse(doc);
@@ -687,8 +682,8 @@ export class Project {
      */
     onDidClose(uri) {
         uri = this.normalizeUri(uri);
-        if (!fileUtil.isFileUri(uri)) {
-            return; // We only accept `file:` scheme for client-managed URIs.
+        if (uri.startsWith(ArchiveUriSupporter.Protocol)) {
+            return; // We do not accept `archive:` scheme for client-managed URIs.
         }
         this.#clientManagedUris.delete(uri);
         this.#clientManagedDocAndNodes.delete(uri);
@@ -724,7 +719,33 @@ export class Project {
             this.logger.error('[Service#showCacheRoot]', e);
         }
     }
-    shouldExclude(uri) {
+    /**
+     * Returns true iff the URI should be excluded from all Spyglass language support.
+     *
+     * @param language Optional. If ommitted, a language will be derived from the URI according to
+     *                 its file extension.
+     */
+    shouldExclude(uri, language) {
+        return !this.isSupportedLanguage(uri, language) || this.isUserExcluded(uri);
+    }
+    isSupportedLanguage(uri, language) {
+        language ??= this.guessLanguageID(uri);
+        const languageOptions = this.meta.getLanguageOptions(language);
+        if (!languageOptions) {
+            // Unsupported language.
+            return false;
+        }
+        const { uriPredicate } = languageOptions;
+        return uriPredicate?.(uri, UriPredicateContext.create(this)) ?? true;
+    }
+    /**
+     * Guess a language ID from a URI. The guessed language ID may or may not actually be supported.
+     */
+    guessLanguageID(uri) {
+        const ext = fileUtil.extname(uri) ?? '.spyglassmc-unknown';
+        return this.meta.getLanguageID(ext) ?? ext.slice(1);
+    }
+    isUserExcluded(uri) {
         if (this.config.env.exclude.length === 0) {
             return false;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.4.27",
+  "version": "0.4.28",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -24,7 +24,7 @@
     "rfdc": "^1.3.0",
     "vscode-languageserver-textdocument": "^1.0.4",
     "whatwg-url": "^14.0.0",
-    "@spyglassmc/locales": "0.3.13"
+    "@spyglassmc/locales": "0.3.14"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.3",