@spyglassmc/core 0.4.0 → 0.4.2

package/lib/symbol/Symbol.js

@@ -1,13 +1,13 @@
 import rfdc from 'rfdc';
 import { isIterable } from '../common/index.js';
 import { Location, PositionRange, Range } from '../source/index.js';
-//#region Mcdoc Categories
+// #region Mcdoc Categories
 export const McdocCategories = Object.freeze([
     'mcdoc',
     'mcdoc/dispatcher',
 ]);
-//#endregion
-//#region Registry Categories
+// #endregion
+// #region Registry Categories
 // Data in `java-edition/src/binder/index.ts` may need to be updated when this section is changed.
 export const RegistryCategories = Object.freeze([
     'activity',
@@ -69,14 +69,15 @@ export const RegistryCategories = Object.freeze([
     'worldgen/tree_decorator_type',
     'worldgen/trunk_placer_type',
 ]);
-//#endregion
-//#region Data Pack Categories
+// #endregion
+// #region Data Pack Categories
 export const WorldgenFileCategories = Object.freeze([
     'worldgen/biome',
     'worldgen/configured_carver',
     'worldgen/configured_feature',
     'worldgen/configured_structure_feature',
     'worldgen/configured_surface_builder',
+    'worldgen/density_function',
     'worldgen/noise',
     'worldgen/noise_settings',
     'worldgen/placed_feature',
@@ -88,7 +89,7 @@ export const TaggableResourceLocationCategories = Object.freeze([
     ...RegistryCategories,
     ...WorldgenFileCategories,
 ]);
-export const TagFileCategories = Object.freeze(TaggableResourceLocationCategories.map(key => `tag/${key}`));
+export const TagFileCategories = Object.freeze(TaggableResourceLocationCategories.map((key) => `tag/${key}`));
 export const FileCategories = Object.freeze([
     'advancement',
     'dimension',
@@ -115,7 +116,7 @@ export const DatapackCategories = Object.freeze([
     ...FileCategories,
     ...MiscCategories,
 ]);
-//#endregion
+// #endregion
 export const AllCategories = Object.freeze([
     ...DatapackCategories,
     ...McdocCategories,
@@ -170,7 +171,13 @@ export class SymbolPathCollector {
         return [...this.#set].map(SymbolPath.fromString);
     }
 }
-export const SymbolUsageTypes = Object.freeze(['definition', 'declaration', 'implementation', 'reference', 'typeDefinition']);
+export const SymbolUsageTypes = Object.freeze([
+    'definition',
+    'declaration',
+    'implementation',
+    'reference',
+    'typeDefinition',
+]);
 export var SymbolUsageType;
 (function (SymbolUsageType) {
     function is(value) {
@@ -203,9 +210,14 @@ export var SymbolLocation;
     function create(doc, range, fullRange, contributor, additional) {
         return {
             ...Location.create(doc, range),
-            ...fullRange ? { fullRange: Range.get(fullRange), fullPosRange: PositionRange.from(fullRange, doc) } : {},
-            ...contributor ? { contributor } : {},
-            ...additional ? additional : {},
+            ...(fullRange
+                ? {
+                    fullRange: Range.get(fullRange),
+                    fullPosRange: PositionRange.from(fullRange, doc),
+                }
+                : {}),
+            ...(contributor ? { contributor } : {}),
+            ...(additional ? additional : {}),
         };
     }
     SymbolLocation.create = create;
@@ -233,7 +245,10 @@ export var SymbolTable;
         };
         const linkSymbolMap = (map, parentSymbol, category, path) => {
             for (const [identifier, childSymbol] of Object.entries(map)) {
-                linkSymbol(childSymbol, map, parentSymbol, category, [...path, identifier]);
+                linkSymbol(childSymbol, map, parentSymbol, category, [
+                    ...path,
+                    identifier,
+                ]);
             }
         };
         const ans = rfdc()(table);

package/lib/symbol/SymbolUtil.d.ts

@@ -99,7 +99,7 @@ export declare class SymbolUtil implements ExternalEventEmitter {
      * 	- `uri` - clear symbol locations associated with this URI.
      * 	- `predicate` - clear symbol locations matching this predicate
      */
-    clear({ uri, contributor, predicate }: {
+    clear({ uri, contributor, predicate, }: {
         contributor?: string;
         uri?: string;
         predicate?: (this: void, data: SymbolLocationEvent) => boolean;
@@ -213,7 +213,7 @@ interface SymbolAddition {
     data?: SymbolMetadata;
     usage?: SymbolAdditionUsage;
 }
-declare type SymbolAdditionUsage = SymbolAdditionUsageWithRange | SymbolAdditionUsageWithNode;
+type SymbolAdditionUsage = SymbolAdditionUsageWithRange | SymbolAdditionUsageWithNode;
 interface SymbolAdditionUsageBase extends SymbolLocationMetadata {
     /**
      * The type of this usage. Use `definition` when the usage consists both a `declaration` and an `implementation`.
@@ -269,9 +269,9 @@ declare namespace SymbolAdditionUsageWithNode {
  * which is accessible by any later elements but not saved to the global `SymbolTable`.
  * Later elements represent different levels of `Block` visibility scopes.
  */
-export declare type SymbolStack = [SymbolTable, ...SymbolTable[]];
-declare type QueryCallback<S extends Symbol | undefined = Symbol | undefined> = (this: SymbolQuery, symbol: S, query: SymbolQuery) => unknown;
-declare type QueryMemberCallback = (this: void, query: SymbolQuery) => unknown;
+export type SymbolStack = [SymbolTable, ...SymbolTable[]];
+type QueryCallback<S extends Symbol | undefined = Symbol | undefined> = (this: SymbolQuery, symbol: S, query: SymbolQuery) => unknown;
+type QueryMemberCallback = (this: void, query: SymbolQuery) => unknown;
 export declare class SymbolQuery {
     #private;
     readonly category: string;
@@ -282,7 +282,7 @@ export declare class SymbolQuery {
     util: SymbolUtil;
     get symbol(): Symbol | undefined;
     get visibleMembers(): SymbolMap;
-    constructor({ category, contributor, doc, map, parentSymbol, path, symbol, util }: {
+    constructor({ category, contributor, doc, map, parentSymbol, path, symbol, util, }: {
         category: string;
         contributor: string | undefined;
         doc: DocAndNode | TextDocument | string;

package/lib/symbol/SymbolUtil.js

@@ -6,7 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { Range } from '../source/index.js';
-import { SymbolLocation, SymbolPath, SymbolUsageTypes } from './Symbol.js';
+import { SymbolLocation, SymbolPath, SymbolUsageTypes, } from './Symbol.js';
 export class SymbolUtil {
     #global;
     #eventEmitter;
@@ -35,16 +35,16 @@ export class SymbolUtil {
         this.#global = global;
         this.#currentContributor = _currentContributor;
         this._inDelayMode = _inDelayMode;
-        this
-            .on('symbolCreated', ({ symbol }) => {
+        this.on('symbolCreated', ({ symbol }) => {
             this.#trimmableSymbols.add(SymbolPath.toString(symbol));
         })
             .on('symbolRemoved', ({ symbol }) => {
             this.#trimmableSymbols.delete(SymbolPath.toString(symbol));
         })
             .on('symbolLocationCreated', ({ symbol, location }) => {
-            const cache = this.#cache[location.contributor ?? 'undefined'] ??= Object.create(null);
-            const fileSymbols = cache[location.uri] ??= new Set();
+            const cache = (this.#cache[location.contributor ?? 'undefined'] ??= Object
+                .create(null));
+            const fileSymbols = (cache[location.uri] ??= new Set());
             const path = SymbolPath.toString(symbol);
             fileSymbols.add(path);
             this.#trimmableSymbols.delete(path);
@@ -69,7 +69,7 @@ export class SymbolUtil {
      * Build the internal cache of the SymbolUtil according to the current global symbol table.
      */
     buildCache() {
-        SymbolUtil.forEachSymbol(this.global, symbol => {
+        SymbolUtil.forEachSymbol(this.global, (symbol) => {
             this.emit('symbolCreated', { symbol });
             SymbolUtil.forEachLocationOfSymbol(symbol, ({ type, location }) => {
                 this.emit('symbolLocationCreated', { symbol, type, location });
@@ -90,7 +90,7 @@ export class SymbolUtil {
      * Apply edits done during the delay mode.
      */
     applyDelayedEdits() {
-        this._delayedOps.forEach(f => f());
+        this._delayedOps.forEach((f) => f());
         this._delayedOps = [];
         this._inDelayMode = false;
     }
@@ -123,7 +123,7 @@ export class SymbolUtil {
      * 	- `uri` - clear symbol locations associated with this URI.
      * 	- `predicate` - clear symbol locations matching this predicate
      */
-    clear({ uri, contributor, predicate = () => true }) {
+    clear({ uri, contributor, predicate = () => true, }) {
         const getCaches = () => {
             if (contributor) {
                 return this.#cache[contributor] ? [this.#cache[contributor]] : [];
@@ -135,14 +135,15 @@ export class SymbolUtil {
         const getPaths = () => {
             const caches = getCaches();
             const sets = uri
-                ? caches.map(cache => cache[uri] ?? new Set())
-                : caches.map(cache => Object.values(cache)).flat();
-            return sets.map(s => [...s]).flat().map(SymbolPath.fromString);
+                ? caches.map((cache) => cache[uri] ?? new Set())
+                : caches.map((cache) => Object.values(cache)).flat();
+            return sets
+                .map((s) => [...s])
+                .flat()
+                .map(SymbolPath.fromString);
         };
         const getTables = () => {
-            return uri
-                ? [this.#global]
-                : [this.#global];
+            return uri ? [this.#global] : [this.#global];
         };
         const paths = getPaths();
         const tables = getTables();
@@ -153,7 +154,7 @@ export class SymbolUtil {
                     continue;
                 }
                 this.removeLocationsFromSymbol(symbol, uri
-                    ? data => data.location.uri === uri && predicate(data)
+                    ? (data) => data.location.uri === uri && predicate(data)
                     : predicate);
             }
             this.trim(table);
@@ -277,7 +278,9 @@ export class SymbolUtil {
             if (result.symbol) {
                 return result;
             }
-            if (!parentSymbol && !parentMap && (result.parentSymbol || result.parentMap)) {
+            if (!parentSymbol &&
+                !parentMap &&
+                (result.parentSymbol || result.parentMap)) {
                 parentSymbol = result.parentSymbol;
                 parentMap = result.parentMap;
             }
@@ -285,14 +288,14 @@ export class SymbolUtil {
         return { parentSymbol, parentMap, symbol: undefined };
     }
     createSymbol(category, parentSymbol, parentMap, path, identifier, addition, doc, contributor) {
-        const ans = parentMap[identifier] = {
+        const ans = (parentMap[identifier] = {
             category,
             identifier,
-            ...parentSymbol ? { parentSymbol } : {},
+            ...(parentSymbol ? { parentSymbol } : {}),
             parentMap,
             path,
             ...addition.data,
-        };
+        });
         this.emit('symbolCreated', { symbol: ans });
         this.amendSymbolUsage(ans, addition.usage, doc, contributor);
         return ans;
@@ -321,8 +324,12 @@ export class SymbolUtil {
             if ('visibility' in addition) {
                 // Visibility changes are only accepted if the change wouldn't result in the
                 // symbol being stored in a different symbol table.
-                const inGlobalTable = (v) => v === undefined || v === 2 /* SymbolVisibility.Public */ || v === 3 /* SymbolVisibility.Restricted */;
-                if (symbol.visibility === addition.visibility || (inGlobalTable(symbol.visibility) && inGlobalTable(addition.visibility))) {
+                const inGlobalTable = (v) => v === undefined ||
+                    v === 2 /* SymbolVisibility.Public */ ||
+                    v === 3 /* SymbolVisibility.Restricted */;
+                if (symbol.visibility === addition.visibility ||
+                    (inGlobalTable(symbol.visibility) &&
+                        inGlobalTable(addition.visibility))) {
                     symbol.visibility = addition.visibility;
                 }
                 else {
@@ -337,8 +344,10 @@ export class SymbolUtil {
     amendSymbolUsage(symbol, addition, doc, contributor) {
         if (addition) {
             const type = addition.type ?? 'reference';
-            const arr = symbol[type] ??= [];
-            const range = Range.get((SymbolAdditionUsageWithNode.is(addition) ? addition.node : addition.range) ?? 0);
+            const arr = (symbol[type] ??= []);
+            const range = Range.get((SymbolAdditionUsageWithNode.is(addition)
+                ? addition.node
+                : addition.range) ?? 0);
             const location = SymbolLocation.create(doc, range, addition.fullRange, contributor, {
                 accessType: addition.accessType,
                 skipRenaming: addition.skipRenaming,
@@ -371,7 +380,12 @@ export class SymbolUtil {
         return ans;
     }
     static isTrimmable(symbol) {
-        return !Object.keys(symbol.members ?? {}).length && !symbol.declaration?.length && !symbol.definition?.length && !symbol.implementation?.length && !symbol.reference?.length && !symbol.typeDefinition?.length;
+        return (!Object.keys(symbol.members ?? {}).length &&
+            !symbol.declaration?.length &&
+            !symbol.definition?.length &&
+            !symbol.implementation?.length &&
+            !symbol.reference?.length &&
+            !symbol.typeDefinition?.length);
     }
     static isVisible(symbol, _uri) {
         switch (symbol.visibility) {
@@ -394,7 +408,8 @@ export class SymbolUtil {
      * @returns If the symbol has definitions, or declarations and implementations.
      */
     static isDefined(symbol) {
-        return !!(symbol?.definition?.length || (symbol?.definition?.length && symbol?.implementation?.length));
+        return !!(symbol?.definition?.length ||
+            (symbol?.definition?.length && symbol?.implementation?.length));
     }
     /**
      * @returns If the symbol has implementations or definitions.
@@ -418,7 +433,11 @@ export class SymbolUtil {
      * @throws If the symbol does not have any declarations or definitions.
      */
     static getDeclaredLocation(symbol) {
-        return symbol.declaration?.[0] ?? symbol.definition?.[0] ?? (() => { throw new Error(`Cannot get declared location of ${JSON.stringify(SymbolPath.fromSymbol(symbol))}`); })();
+        return (symbol.declaration?.[0] ??
+            symbol.definition?.[0] ??
+            (() => {
+                throw new Error(`Cannot get declared location of ${JSON.stringify(SymbolPath.fromSymbol(symbol))}`);
+            })());
     }
     static forEachSymbolInMap(map, fn) {
         for (const symbol of Object.values(map)) {
@@ -435,11 +454,13 @@ export class SymbolUtil {
     }
     static forEachLocationOfSymbol(symbol, fn) {
         for (const type of SymbolUsageTypes) {
-            symbol[type]?.forEach(location => fn({ type, location }));
+            symbol[type]?.forEach((location) => fn({ type, location }));
         }
     }
     static isVisibilityInGlobal(v) {
-        return v === undefined || v === 2 /* SymbolVisibility.Public */ || v === 3 /* SymbolVisibility.Restricted */;
+        return (v === undefined ||
+            v === 2 /* SymbolVisibility.Public */ ||
+            v === 3 /* SymbolVisibility.Restricted */);
     }
     static areVisibilitiesCompatible(v1, v2) {
         return ((this.isVisibilityInGlobal(v1) && this.isVisibilityInGlobal(v2)) ||
@@ -505,7 +526,7 @@ export class SymbolQuery {
     get visibleMembers() {
         return SymbolUtil.filterVisibleSymbols(this.#doc.uri, this.path.length === 0 ? this.#map : this.#symbol?.members);
     }
-    constructor({ category, contributor, doc, map, parentSymbol, path, symbol, util }) {
+    constructor({ category, contributor, doc, map, parentSymbol, path, symbol, util, }) {
         this.category = category;
         this.path = path;
         if (typeof doc === 'string') {
@@ -545,13 +566,13 @@ export class SymbolQuery {
      * Calls `fn` if the queried symbol does not exist.
      */
     ifUnknown(fn) {
-        return this.if(s => s === undefined, fn);
+        return this.if((s) => s === undefined, fn);
     }
     /**
      * Calls `fn` if the queried symbol exists (i.e. has any of declarations/definitions/implementations/references/typeDefinitions).
      */
     ifKnown(fn) {
-        return this.if(s => s !== undefined, fn);
+        return this.if((s) => s !== undefined, fn);
     }
     /**
      * Calls `fn` if the queried symbol has declarations or definitions.
@@ -613,11 +634,14 @@ export class SymbolQuery {
          * * If the visibility is `undefined`, use the visibility of the symbol, or `Public` if unapplicable.
          */
         const getAdditionVisibility = (addition) => {
-            return addition.data?.visibility ?? this.symbol?.visibility ?? 2 /* SymbolVisibility.Public */;
+            return (addition.data?.visibility ??
+                this.symbol?.visibility ??
+                2 /* SymbolVisibility.Public */);
         };
         const getMap = (addition) => {
             const additionVisibility = getAdditionVisibility(addition);
-            if (this.#map && SymbolUtil.areVisibilitiesCompatible(additionVisibility, this.#symbol?.visibility)) {
+            if (this.#map &&
+                SymbolUtil.areVisibilitiesCompatible(additionVisibility, this.#symbol?.visibility)) {
                 return this.#map;
             }
             if (this.path.length > 1) {
@@ -625,7 +649,7 @@ export class SymbolQuery {
                     if (!SymbolUtil.areVisibilitiesCompatible(additionVisibility, this.#parentSymbol.visibility)) {
                         throw new Error(`Cannot enter member “${this.getPath()}” of ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility to parent of ${SymbolFormatter.stringifyVisibility(this.#parentSymbol.visibility)} visibility`);
                     }
-                    return this.#parentSymbol.members ??= {};
+                    return (this.#parentSymbol.members ??= {});
                 }
             }
             else {
@@ -666,12 +690,13 @@ export class SymbolQuery {
                     }
                 }
                 // TODO: Move part of symbol from global to table.
-                return table[this.category] ??= {};
+                return (table[this.category] ??= {});
             }
             throw new Error(`Cannot create the symbol map for “${this.getPath()}”`);
         };
         // Treat `usage.range` as `[0, 0)` if this class was constructed with a string URI (instead of a `TextDocument`).
-        if (this.#createdWithUri && SymbolAdditionUsageWithRange.is(addition.usage)) {
+        if (this.#createdWithUri &&
+            SymbolAdditionUsageWithRange.is(addition.usage)) {
             addition.usage.range = Range.create(0, 0);
         }
         this.#map = getMap(addition);
@@ -738,7 +763,8 @@ export class SymbolQuery {
         if (this.#symbol === undefined) {
             throw new Error(`Tried to query member symbol “${identifier}” from an undefined symbol (path “${this.path.join('.')}”)`);
         }
-        const memberDoc = typeof doc === 'string' && doc === this.#doc.uri && !this.#createdWithUri
+        const memberDoc = typeof doc === 'string' && doc === this.#doc.uri &&
+            !this.#createdWithUri
             ? this.#doc
             : doc;
         const memberMap = this.#symbol.members;
@@ -767,7 +793,7 @@ export class SymbolQuery {
         return this;
     }
     forEachMember(fn) {
-        return this.onEach(Object.keys(this.visibleMembers), identifier => this.member(identifier, query => fn(identifier, query)));
+        return this.onEach(Object.keys(this.visibleMembers), (identifier) => this.member(identifier, (query) => fn(identifier, query)));
     }
     getPath() {
         return `${this.category}.${this.path.join('/')}`;
@@ -789,7 +815,9 @@ export var SymbolFormatter;
         }
     }
     function stringifySymbolStack(stack) {
-        return stack.map(table => stringifySymbolTable(table)).join('\n------------\n');
+        return stack
+            .map((table) => stringifySymbolTable(table))
+            .join('\n------------\n');
     }
     SymbolFormatter.stringifySymbolStack = stringifySymbolStack;
     function stringifySymbolTable(table, indent = '') {
@@ -798,7 +826,9 @@ export var SymbolFormatter;
             const map = table[category];
             ans.push([category, stringifySymbolMap(map, `${indent}${IndentChar}`)]);
         }
-        return ans.map(v => `CATEGORY ${v[0]}\n${v[1]}`).join(`\n${indent}------------\n`) || 'EMPTY TABLE';
+        return (ans
+            .map((v) => `CATEGORY ${v[0]}\n${v[1]}`)
+            .join(`\n${indent}------------\n`) || 'EMPTY TABLE');
     }
     SymbolFormatter.stringifySymbolTable = stringifySymbolTable;
     function stringifySymbolMap(map, indent = '') {
@@ -831,7 +861,7 @@ export var SymbolFormatter;
         }
         for (const type of SymbolUsageTypes) {
             if (symbol[type]) {
-                ans.push(`${IndentChar}${type}:\n${symbol[type].map(v => `${indent}${IndentChar.repeat(2)}${JSON.stringify(v)}`).join(`\n${indent}${IndentChar.repeat(2)}------------\n`)}`);
+                ans.push(`${IndentChar}${type}:\n${symbol[type].map((v) => `${indent}${IndentChar.repeat(2)}${JSON.stringify(v)}`).join(`\n${indent}${IndentChar.repeat(2)}------------\n`)}`);
             }
         }
         if (symbol.relations) {
@@ -840,7 +870,7 @@ export var SymbolFormatter;
         if (symbol.members) {
             ans.push(`${IndentChar}members:\n${stringifySymbolMap(symbol.members, `${indent}${IndentChar.repeat(2)}`)}`);
         }
-        return ans.map(v => `${indent}${v}`).join('\n');
+        return ans.map((v) => `${indent}${v}`).join('\n');
     }
     SymbolFormatter.stringifySymbol = stringifySymbol;
     function stringifyVisibility(visibility, visibilityRestriction) {
@@ -860,7 +890,9 @@ export var SymbolFormatter;
                 stringVisibility = 'Public';
                 break;
         }
-        return `${stringVisibility}${visibilityRestriction ? ` ${visibilityRestriction.map(v => `“${v}”`).join(', ')}` : ''}`;
+        return `${stringVisibility}${visibilityRestriction
+            ? ` ${visibilityRestriction.map((v) => `“${v}”`).join(', ')}`
+            : ''}`;
     }
     SymbolFormatter.stringifyVisibility = stringifyVisibility;
     function stringifyLookupResult(result) {
@@ -879,7 +911,7 @@ ${stringifySymbol(result.symbol, IndentChar)}`;
  *
  * The decorated method MUST have return type `void`.
  */
-function DelayModeSupport(getUtil = self => self) {
+function DelayModeSupport(getUtil = (self) => self) {
     return (_target, _key, descripter) => {
         const decoratedMethod = descripter.value;
         // The `function` syntax is used to preserve `this` context from the decorated method.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,7 +23,7 @@
     "pako": "^2.0.4",
     "rfdc": "^1.3.0",
     "vscode-languageserver-textdocument": "^1.0.4",
-    "@spyglassmc/locales": "0.3.0"
+    "@spyglassmc/locales": "0.3.2"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.3",