@spyglassmc/core 0.4.7 → 0.4.8

package/lib/common/externals/BrowserExternals.js

@@ -122,7 +122,7 @@ class BrowserFileSystem {
         delete this.states[location];
         this.saveStates();
     }
-    watch(_location) {
+    watch(_locations) {
         return new BrowserFsWatcher();
     }
     async writeFile(location, data, _options) {

package/lib/common/externals/NodeJsExternals.js

@@ -105,8 +105,8 @@ export const NodeJsExternals = {
         unlink(location) {
             return fsp.unlink(toFsPathLike(location));
         },
-        watch(location) {
-            return new ChokidarWatcherWrapper(chokidar.watch(toPath(location)));
+        watch(locations) {
+            return new ChokidarWatcherWrapper(chokidar.watch(locations.map(toPath)));
         },
         writeFile(location, data, options) {
             return fsp.writeFile(toFsPathLike(location), data, options);

package/lib/common/externals/index.d.ts

@@ -72,7 +72,7 @@ export interface ExternalFileSystem {
         isFile(): boolean;
     }>;
     unlink(location: FsLocation): Promise<void>;
-    watch(location: FsLocation): FsWatcher;
+    watch(locations: FsLocation[]): FsWatcher;
     /**
      * @param options `mode` - File mode bit mask (e.g. `0o775`).
      */

package/lib/node/StringNode.d.ts

@@ -54,6 +54,9 @@ export interface StringBaseNode extends AstNode {
     value: string;
     readonly valueMap: IndexMap;
 }
+export declare namespace StringBaseNode {
+    function is(obj: object | undefined): obj is StringBaseNode;
+}
 export interface StringNode extends StringBaseNode {
     readonly type: 'string';
 }

package/lib/node/StringNode.js

@@ -18,6 +18,14 @@ export const EscapeTable = new Map([
     ['r', '\r'],
     ['t', '\t'],
 ]);
+export var StringBaseNode;
+(function (StringBaseNode) {
+    function is(obj) {
+        return Array.isArray(obj?.valueMap)
+            && typeof obj?.options === 'object';
+    }
+    StringBaseNode.is = is;
+})(StringBaseNode || (StringBaseNode = {}));
 export var StringNode;
 (function (StringNode) {
     /* istanbul ignore next */

package/lib/node/SymbolNode.d.ts

@@ -3,6 +3,7 @@ import type { SymbolAccessType, SymbolUsageType } from '../symbol/index.js';
 import type { AstNode } from './AstNode.js';
 export interface SymbolOptions {
     category: string;
+    subcategory?: string;
     parentPath?: string[];
     accessType?: SymbolAccessType;
     usageType?: SymbolUsageType;

package/lib/parser/string.js

@@ -12,15 +12,15 @@ export function string(options) {
             value: '',
             valueMap: [],
         };
-        let start = src.cursor;
+        let start;
         if (options.quotes?.length && (src.peek() === '"' || src.peek() === "'")) {
             const currentQuote = src.read();
             ans.quote = currentQuote;
-            const contentStart = src.cursor;
+            let cStart = src.cursor;
+            start = cStart;
             while (src.canRead() && src.peek() !== currentQuote) {
                 const c = src.peek();
                 if (options.escapable && c === '\\') {
-                    const cStart = src.cursor;
                     src.skip();
                     const c2 = src.read();
                     if (c2 === '\\'
@@ -61,10 +61,19 @@ export function string(options) {
                         });
                         ans.value += c2;
                     }
+                    cStart = src.cursor;
                 }
                 else {
                     src.skip();
+                    const cEnd = src.cursor;
+                    if (cEnd - cStart > 1) {
+                        ans.valueMap.push({
+                            inner: Range.create(ans.value.length, ans.value.length + 1),
+                            outer: Range.create(cStart, cEnd),
+                        });
+                    }
                     ans.value += c;
+                    cStart = cEnd;
                 }
             }
             if (!src.trySkip(currentQuote)) {
@@ -73,9 +82,9 @@ export function string(options) {
             if (!options.quotes.includes(currentQuote)) {
                 ctx.err.report(localize('parser.string.illegal-quote', options.quotes), ans);
             }
-            start = contentStart;
         }
         else if (options.unquotable) {
+            start = src.cursor;
             while (src.canRead() && isAllowedCharacter(src.peek(), options.unquotable)) {
                 ans.value += src.read();
             }
@@ -84,6 +93,7 @@ export function string(options) {
             }
         }
         else {
+            start = src.cursor;
             ctx.err.report(localize('expected', options.quotes), src);
         }
         ans.valueMap.unshift({ inner: Range.create(0), outer: Range.create(start) });

package/lib/parser/util.js

@@ -1,7 +1,7 @@
 import { localize } from '@spyglassmc/locales';
 import { SequenceUtil, SequenceUtilDiscriminator } from '../node/index.js';
 import { ErrorReporter } from '../service/index.js';
-import { IndexMap, Range, Source } from '../source/index.js';
+import { Range, Source } from '../source/index.js';
 import { Failure } from './Parser.js';
 export function attempt(parser, src, ctx) {
     const tmpSrc = src.clone();
@@ -227,7 +227,7 @@ export function concatOnTrailingBackslash(parser) {
             const to = src.getCharRange(-1);
             indexMap.push({ inner: Range.create(wrappedStr.length), outer: Range.span(from, to) });
         }
-        const wrappedSrc = new Source(wrappedStr, IndexMap.merge(src.indexMap, indexMap));
+        const wrappedSrc = new Source(wrappedStr, indexMap);
         wrappedSrc.innerCursor = wrappedSrcCursor;
         const ans = parser(wrappedSrc, ctx);
         src.cursor = wrappedSrc.cursor;

package/lib/processor/ColorInfoProvider.d.ts

@@ -10,6 +10,7 @@ export type Color = [number, number, number, number];
 export declare namespace Color {
     const NamedColors: Map<string, number>;
     const ColorNames: string[];
+    function fromNamed(value: string): Color | undefined;
     /**
      * @param r A decimal within [0.0, 1.0].
      * @param g A decimal within [0.0, 1.0].
@@ -36,10 +37,18 @@ export declare namespace Color {
      * @param b An integer within [0, 255].
      */
     function fromIntRGB(r: number, g: number, b: number): Color;
+    /**
+     * @param value A string in the format `#rrggbb`
+     */
+    function fromHexRGB(value: string): Color;
     /**
      * @param value `R << 16 + G << 8 + B`. Negative values result in white.
      */
-    function fromCompositeInt(value: number): Color;
+    function fromCompositeRGB(value: number): Color;
+    /**
+     * @param value `A << 24 + R << 16 + G << 8 + B`.
+     */
+    function fromCompositeARGB(value: number): Color;
 }
 export declare enum ColorFormat {
     /**
@@ -69,7 +78,11 @@ export declare enum ColorFormat {
     /**
      * `16620441`
      */
-    CompositeInt = 6
+    CompositeRGB = 6,
+    /**
+     * `4294945365`
+     */
+    CompositeARGB = 7
 }
 export type FormattableColor = {
     value: Color;

package/lib/processor/ColorInfoProvider.js

@@ -19,6 +19,14 @@ export var Color;
         ['yellow', 0xffff55],
     ]);
     Color.ColorNames = [...Color.NamedColors.keys()];
+    function fromNamed(value) {
+        const composite = Color.NamedColors.get(value);
+        if (composite === undefined) {
+            return undefined;
+        }
+        return fromCompositeRGB(composite);
+    }
+    Color.fromNamed = fromNamed;
     /**
      * @param r A decimal within [0.0, 1.0].
      * @param g A decimal within [0.0, 1.0].
@@ -57,21 +65,46 @@ export var Color;
         return fromIntRGBA(r, g, b, 255);
     }
     Color.fromIntRGB = fromIntRGB;
+    /**
+     * @param value A string in the format `#rrggbb`
+     */
+    function fromHexRGB(value) {
+        var bigint = parseInt(value.slice(1), 16);
+        var r = (bigint >> 16) & 255;
+        var g = (bigint >> 8) & 255;
+        var b = bigint & 255;
+        return fromIntRGB(r, g, b);
+    }
+    Color.fromHexRGB = fromHexRGB;
     /**
      * @param value `R << 16 + G << 8 + B`. Negative values result in white.
      */
-    function fromCompositeInt(value) {
+    function fromCompositeRGB(value) {
         if (value < 0) {
             return fromDecRGB(1.0, 1.0, 1.0);
         }
         const b = value % 256;
-        value >>= 8;
+        value >>>= 8;
         const g = value % 256;
-        value >>= 8;
+        value >>>= 8;
         const r = value % 256;
         return fromIntRGB(r, g, b);
     }
-    Color.fromCompositeInt = fromCompositeInt;
+    Color.fromCompositeRGB = fromCompositeRGB;
+    /**
+     * @param value `A << 24 + R << 16 + G << 8 + B`.
+     */
+    function fromCompositeARGB(value) {
+        const b = value % 256;
+        value >>>= 8;
+        const g = value % 256;
+        value >>>= 8;
+        const r = value % 256;
+        value >>>= 8;
+        const a = value % 256;
+        return fromIntRGBA(r, g, b, a);
+    }
+    Color.fromCompositeARGB = fromCompositeARGB;
 })(Color || (Color = {}));
 export var ColorFormat;
 (function (ColorFormat) {
@@ -102,7 +135,11 @@ export var ColorFormat;
     /**
      * `16620441`
      */
-    ColorFormat[ColorFormat["CompositeInt"] = 6] = "CompositeInt";
+    ColorFormat[ColorFormat["CompositeRGB"] = 6] = "CompositeRGB";
+    /**
+     * `4294945365`
+     */
+    ColorFormat[ColorFormat["CompositeARGB"] = 7] = "CompositeARGB";
 })(ColorFormat || (ColorFormat = {}));
 export var ColorPresentation;
 (function (ColorPresentation) {
@@ -128,8 +165,13 @@ export var ColorPresentation;
             case ColorFormat.HexRGB:
                 return `#${Math.round(((color[0] * 255) << 16) + ((color[1] * 255) << 8) + color[2] * 255)
                     .toString(16).padStart(6, '0')}`;
-            case ColorFormat.CompositeInt:
+            case ColorFormat.CompositeRGB:
                 return `${Math.round(((color[0] * 255) << 16) + ((color[1] * 255) << 8) + color[2] * 255)}`;
+            case ColorFormat.CompositeARGB:
+                return `${(BigInt(Math.round(color[3] * 255)) << 24n)
+                    + (BigInt(Math.round(color[0] * 255)) << 16n)
+                    + (BigInt(Math.round(color[1] * 255)) << 8n)
+                    + BigInt(Math.round(color[2] * 255))}`;
         }
     }
 })(ColorPresentation || (ColorPresentation = {}));

package/lib/processor/binder/builtin.js

@@ -107,6 +107,7 @@ export const symbol = SyncBinder.create((node, ctx) => {
     if (node.value) {
         const path = node.options.parentPath ? [...node.options.parentPath, node.value] : [node.value];
         ctx.symbols.query(ctx.doc, node.options.category, ...path).enter({
+            data: { subcategory: node.options.subcategory },
             usage: { type: node.options.usageType, node, accessType: node.options.accessType },
         });
     }

package/lib/processor/completer/Completer.d.ts

@@ -35,6 +35,7 @@ export interface CompletionItem {
     label: string;
     range: Range;
     kind?: CompletionKind;
+    labelSuffix?: string;
     detail?: string;
     documentation?: string;
     deprecated?: boolean;

package/lib/processor/completer/builtin.js

@@ -150,7 +150,7 @@ export const resourceLocation = (node, ctx) => {
     if (node.options.category) {
         const symbols = ctx.symbols.getVisibleSymbols(node.options.category, ctx.doc.uri);
         const thisKey = Object.entries(symbols).flatMap(([key, symbol]) => {
-            if ((symbol.declaration?.[0] ?? symbol.definition?.[0])?.uri == ctx.doc.uri) {
+            if ((symbol.declaration?.[0] ?? symbol.definition?.[0])?.uri === ctx.doc.uri) {
                 return [key];
             }
             return [];

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 = 3;
+export declare const LatestCacheVersion = 4;
 /**
  * Checksums of cached files or roots.
  */
@@ -40,11 +40,6 @@ export declare class CacheService {
      * @param project
      */
     constructor(cacheRoot: RootUriString, project: Project);
-    /**
-     * @throws
-     *
-     * @returns `${cacheRoot}symbols/${sha1(projectRoot)}.json`
-     */
     private getCacheFileUri;
     load(): Promise<LoadResult>;
     validate(): Promise<ValidateResult>;

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 = 3;
+export const LatestCacheVersion = 4;
 var Checksums;
 (function (Checksums) {
     function create() {
@@ -65,17 +65,20 @@ export class CacheService {
         });
     }
     #cacheFilePath;
-    /**
-     * @throws
-     *
-     * @returns `${cacheRoot}symbols/${sha1(projectRoot)}.json`
-     */
     async getCacheFileUri() {
-        return (this.#cacheFilePath ??= new Uri(`symbols/${await this.project.externals.crypto.getSha1(this.project.projectRoot)}.json.gz`, this.cacheRoot).toString());
+        if (!this.#cacheFilePath) {
+            const sortedRoots = [...this.project.projectRoots].sort();
+            const hash = await this.project.externals.crypto.getSha1(sortedRoots.join(':'));
+            this.#cacheFilePath = new Uri(`symbols/${hash}.json.gz`, this.cacheRoot).toString();
+        }
+        return this.#cacheFilePath;
     }
     async load() {
-        const __profiler = this.project.profilers.get('cache#load');
         const ans = { symbols: {} };
+        if (this.project.projectRoots.length === 0) {
+            return ans;
+        }
+        const __profiler = this.project.profilers.get('cache#load');
         let filePath;
         try {
             filePath = await this.getCacheFileUri();
@@ -164,13 +167,16 @@ export class CacheService {
      * @returns If the cache file was saved successfully.
      */
     async save() {
+        if (this.project.projectRoots.length === 0) {
+            return false;
+        }
         const __profiler = this.project.profilers.get('cache#save');
         let filePath;
         try {
             filePath = await this.getCacheFileUri();
             const cache = {
                 version: LatestCacheVersion,
-                projectRoot: this.project.projectRoot,
+                projectRoots: this.project.projectRoots,
                 checksums: this.checksums,
                 symbols: SymbolTable.unlink(this.project.symbols.global),
                 errors: this.errors,

package/lib/service/Config.js

@@ -236,22 +236,25 @@ export class ConfigService {
         return this.#eventEmitter.emit(event, ...args);
     }
     async load() {
-        let ans = this.defaultConfig;
-        for (const name of ConfigService.ConfigFileNames) {
-            const uri = this.project.projectRoot + name;
-            try {
-                ans = JSON.parse(bufferToString(await this.project.externals.fs.readFile(uri)));
-            }
-            catch (e) {
-                if (this.project.externals.error.isKind(e, 'ENOENT')) {
-                    // File doesn't exist.
-                    continue;
+        const overrides = [];
+        for (const projectRoot of this.project.projectRoots) {
+            for (const name of ConfigService.ConfigFileNames) {
+                const uri = projectRoot + name;
+                try {
+                    const contents = await this.project.externals.fs.readFile(uri);
+                    overrides.push(JSON.parse(bufferToString(contents)));
+                }
+                catch (e) {
+                    if (this.project.externals.error.isKind(e, 'ENOENT')) {
+                        // File doesn't exist.
+                        continue;
+                    }
+                    this.emit('error', { error: e, uri });
                 }
-                this.emit('error', { error: e, uri });
+                break;
             }
-            break;
         }
-        return ConfigService.merge(this.defaultConfig, ans);
+        return ConfigService.merge(this.defaultConfig, ...overrides);
     }
     static isConfigFile(uri) {
         return ConfigService.ConfigFileNames.some((n) => uri.endsWith(`/${n}`));

package/lib/service/Project.d.ts

@@ -14,7 +14,7 @@ import { FileService } from './FileService.js';
 import type { RootUriString } from './fileUtil.js';
 import { MetaRegistry } from './MetaRegistry.js';
 import { ProfilerFactory } from './Profiler.js';
-export type ProjectInitializerContext = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'externals' | 'isDebugging' | 'logger' | 'meta' | 'projectRoot'>;
+export type ProjectInitializerContext = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'externals' | 'isDebugging' | 'logger' | 'meta' | 'projectRoots'>;
 export type SyncProjectInitializer = (this: void, ctx: ProjectInitializerContext) => Record<string, string> | void;
 export type AsyncProjectInitializer = (this: void, ctx: ProjectInitializerContext) => PromiseLike<Record<string, string> | void>;
 export type ProjectInitializer = SyncProjectInitializer | AsyncProjectInitializer;
@@ -29,9 +29,9 @@ export interface ProjectOptions {
     logger?: Logger;
     profilers?: ProfilerFactory;
     /**
-     * A file URI to the root of this project.
+     * File URIs to the roots of this project.
      */
-    projectRoot: RootUriString;
+    projectRoots: RootUriString[];
     symbols?: SymbolUtil;
 }
 export interface DocAndNode {
@@ -57,7 +57,7 @@ interface SymbolRegistrarEvent {
     id: string;
     checksum: string | undefined;
 }
-export type ProjectData = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'ensureBindingStarted' | 'externals' | 'fs' | 'isDebugging' | 'logger' | 'meta' | 'profilers' | 'projectRoot' | 'roots' | 'symbols' | 'ctx'>;
+export type ProjectData = Pick<Project, 'cacheRoot' | 'config' | 'downloader' | 'ensureBindingStarted' | 'externals' | 'fs' | 'isDebugging' | 'logger' | 'meta' | 'profilers' | 'projectRoots' | 'roots' | 'symbols' | 'ctx'>;
 /**
  * Manage all tracked documents and errors.
  *
@@ -110,7 +110,7 @@ export declare class Project implements ExternalEventEmitter {
     readonly logger: Logger;
     readonly meta: MetaRegistry;
     readonly profilers: ProfilerFactory;
-    readonly projectRoot: RootUriString;
+    readonly projectRoots: RootUriString[];
     symbols: SymbolUtil;
     /**
      * All tracked root URIs. Each URI in this array is guaranteed to end with a slash (`/`).
@@ -159,7 +159,7 @@ export declare class Project implements ExternalEventEmitter {
      * are not loaded into the memory.
      */
     getTrackedFiles(): string[];
-    constructor({ cacheRoot, defaultConfig, downloader, externals, fs, initializers, isDebugging, logger, profilers, projectRoot, }: ProjectOptions);
+    constructor({ cacheRoot, defaultConfig, downloader, externals, fs, initializers, isDebugging, logger, profilers, projectRoots, }: ProjectOptions);
     private setInitPromise;
     private readGitignore;
     private setReadyPromise;

package/lib/service/Project.js

@@ -93,7 +93,7 @@ export class Project {
     logger;
     meta = new MetaRegistry();
     profilers;
-    projectRoot;
+    projectRoots;
     symbols;
     #dependencyRoots;
     #dependencyFiles;
@@ -125,7 +125,7 @@ export class Project {
         return this.#cacheRoot;
     }
     updateRoots() {
-        const rawRoots = [...this.#dependencyRoots ?? [], this.projectRoot];
+        const rawRoots = [...this.#dependencyRoots ?? [], ...this.projectRoots];
         const ans = new Set(rawRoots);
         // Identify roots indicated by `pack.mcmeta`.
         for (const file of this.getTrackedFiles()) {
@@ -160,7 +160,7 @@ export class Project {
         const filteredFiles = this.ignore.filter(supportedFiles);
         return filteredFiles;
     }
-    constructor({ cacheRoot, defaultConfig, downloader, externals, fs = FileService.create(externals, cacheRoot), initializers = [], isDebugging = false, logger = Logger.create(), profilers = ProfilerFactory.noop(), projectRoot, }) {
+    constructor({ cacheRoot, defaultConfig, downloader, externals, fs = FileService.create(externals, cacheRoot), initializers = [], isDebugging = false, logger = Logger.create(), profilers = ProfilerFactory.noop(), projectRoots, }) {
         this.#cacheRoot = cacheRoot;
         this.#eventEmitter = new externals.event.EventEmitter();
         this.externals = externals;
@@ -169,7 +169,7 @@ export class Project {
         this.isDebugging = isDebugging;
         this.logger = logger;
         this.profilers = profilers;
-        this.projectRoot = projectRoot;
+        this.projectRoots = projectRoots;
         this.cacheService = new CacheService(cacheRoot, this);
         this.#configService = new ConfigService(this, defaultConfig);
         this.downloader = downloader ?? new Downloader(cacheRoot, externals, logger);
@@ -247,7 +247,7 @@ export class Project {
                 isDebugging: this.isDebugging,
                 logger: this.logger,
                 meta: this.meta,
-                projectRoot: this.projectRoot,
+                projectRoots: this.projectRoots,
             };
             const results = await Promise.allSettled(this.#initializers.map((init) => init(initCtx)));
             let ctx = {};
@@ -275,8 +275,11 @@ export class Project {
         this.#initPromise = init();
     }
     async readGitignore() {
+        if (this.projectRoots.length === 0) {
+            return undefined;
+        }
         try {
-            const uri = this.projectRoot + Project.GitIgnore;
+            const uri = this.projectRoots[0] + Project.GitIgnore;
             const contents = await this.externals.fs.readFile(uri);
             return bufferToString(contents);
         }
@@ -320,9 +323,13 @@ export class Project {
             this.fs.register(ArchiveUriSupporter.Protocol, archiveUriSupporter, true);
         };
         const listProjectFiles = () => new Promise((resolve) => {
+            if (this.projectRoots.length === 0) {
+                resolve();
+                return;
+            }
             this.#watchedFiles.clear();
             this.#watcherReady = false;
-            this.#watcher = this.externals.fs.watch(this.projectRoot).once('ready', () => {
+            this.#watcher = this.externals.fs.watch(this.projectRoots).once('ready', () => {
                 this.#watcherReady = true;
                 resolve();
             }).on('add', (uri) => {

package/lib/source/IndexMap.d.ts

@@ -11,6 +11,5 @@ export declare namespace IndexMap {
     function toInnerRange(map: IndexMap, outer: Range): Range;
     function toOuterOffset(map: IndexMap, offset: number): number;
     function toOuterRange(map: IndexMap, inner: Range): Range;
-    function merge(outerMap: IndexMap, innerMap: IndexMap): IndexMap;
 }
 //# sourceMappingURL=IndexMap.d.ts.map

package/lib/source/IndexMap.js

@@ -32,9 +32,5 @@ export var IndexMap;
         return Range.create(toOuterOffset(map, inner.start), toOuterOffset(map, inner.end));
     }
     IndexMap.toOuterRange = toOuterRange;
-    function merge(outerMap, innerMap) {
-        return innerMap.map((p) => ({ inner: p.inner, outer: toOuterRange(outerMap, p.outer) }));
-    }
-    IndexMap.merge = merge;
 })(IndexMap || (IndexMap = {}));
 //# sourceMappingURL=IndexMap.js.map

package/package.json

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