@spyglassmc/core 0.1.0 → 0.2.0

package/lib/symbol/Symbol.js

@@ -1,27 +1,15 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _SymbolPathCollector_set;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SymbolTable = exports.SymbolLocation = exports.Symbol = exports.SymbolUsageType = exports.SymbolUsageTypes = exports.SymbolPathCollector = exports.SymbolPath = exports.ResourceLocationCategory = exports.ResourceLocationCategories = exports.AllCategories = exports.DatapackCategories = exports.MiscCategories = exports.FileCategories = exports.TagFileCategories = exports.TaggableResourceLocationCategories = exports.WorldgenFileCategories = exports.RegistryCategories = exports.NbtdocCategories = void 0;
-const rfdc_1 = __importDefault(require("rfdc"));
-const common_1 = require("../common");
-const source_1 = require("../source");
-//#region NBTDoc Categories
-exports.NbtdocCategories = Object.freeze([
-    'nbtdoc',
-    'nbtdoc/description',
+import rfdc from 'rfdc';
+import { isIterable } from '../common/index.js';
+import { Location, PositionRange, Range } from '../source/index.js';
+//#region Mcdoc Categories
+export const McdocCategories = Object.freeze([
+    'mcdoc',
+    'mcdoc/dispatcher',
 ]);
 //#endregion
 //#region Registry Categories
 // Data in `java-edition/src/binder/index.ts` may need to be updated when this section is changed.
-exports.RegistryCategories = Object.freeze([
+export const RegistryCategories = Object.freeze([
     'activity',
     'attribute',
     'block',
@@ -83,7 +71,7 @@ exports.RegistryCategories = Object.freeze([
 ]);
 //#endregion
 //#region Data Pack Categories
-exports.WorldgenFileCategories = Object.freeze([
+export const WorldgenFileCategories = Object.freeze([
     'worldgen/biome',
     'worldgen/configured_carver',
     'worldgen/configured_feature',
@@ -95,13 +83,13 @@ exports.WorldgenFileCategories = Object.freeze([
     'worldgen/processor_list',
     'worldgen/template_pool',
 ]);
-exports.TaggableResourceLocationCategories = Object.freeze([
+export const TaggableResourceLocationCategories = Object.freeze([
     'function',
-    ...exports.RegistryCategories,
-    ...exports.WorldgenFileCategories,
+    ...RegistryCategories,
+    ...WorldgenFileCategories,
 ]);
-exports.TagFileCategories = Object.freeze(exports.TaggableResourceLocationCategories.map(key => `tag/${key}`));
-exports.FileCategories = Object.freeze([
+export const TagFileCategories = Object.freeze(TaggableResourceLocationCategories.map(key => `tag/${key}`));
+export const FileCategories = Object.freeze([
     'advancement',
     'dimension',
     'dimension_type',
@@ -111,10 +99,10 @@ exports.FileCategories = Object.freeze([
     'predicate',
     'recipe',
     'structure',
-    ...exports.TagFileCategories,
-    ...exports.WorldgenFileCategories,
+    ...TagFileCategories,
+    ...WorldgenFileCategories,
 ]);
-exports.MiscCategories = Object.freeze([
+export const MiscCategories = Object.freeze([
     'attribute_modifier_uuid',
     'bossbar',
     'objective',
@@ -123,30 +111,31 @@ exports.MiscCategories = Object.freeze([
     'tag',
     'team',
 ]);
-exports.DatapackCategories = Object.freeze([
-    ...exports.FileCategories,
-    ...exports.MiscCategories,
+export const DatapackCategories = Object.freeze([
+    ...FileCategories,
+    ...MiscCategories,
 ]);
 //#endregion
-exports.AllCategories = Object.freeze([
-    ...exports.DatapackCategories,
-    ...exports.NbtdocCategories,
-    ...exports.RegistryCategories,
+export const AllCategories = Object.freeze([
+    ...DatapackCategories,
+    ...McdocCategories,
+    ...RegistryCategories,
 ]);
-exports.ResourceLocationCategories = Object.freeze([
+export const ResourceLocationCategories = Object.freeze([
     'bossbar',
     'storage',
-    ...exports.FileCategories,
-    ...exports.RegistryCategories,
+    'mcdoc/dispatcher',
+    ...FileCategories,
+    ...RegistryCategories,
 ]);
-var ResourceLocationCategory;
+export var ResourceLocationCategory;
 (function (ResourceLocationCategory) {
     function is(category) {
-        return exports.ResourceLocationCategories.includes(category);
+        return ResourceLocationCategories.includes(category);
     }
     ResourceLocationCategory.is = is;
-})(ResourceLocationCategory = exports.ResourceLocationCategory || (exports.ResourceLocationCategory = {}));
-var SymbolPath;
+})(ResourceLocationCategory || (ResourceLocationCategory = {}));
+export var SymbolPath;
 (function (SymbolPath) {
     function fromSymbol(symbol) {
         return symbol
@@ -165,38 +154,34 @@ var SymbolPath;
         return JSON.parse(value);
     }
     SymbolPath.fromString = fromString;
-})(SymbolPath = exports.SymbolPath || (exports.SymbolPath = {}));
-class SymbolPathCollector {
-    constructor() {
-        _SymbolPathCollector_set.set(this, new Set());
-    }
+})(SymbolPath || (SymbolPath = {}));
+export class SymbolPathCollector {
+    #set = new Set();
     add(path) {
         if (!path) {
             return;
         }
-        __classPrivateFieldGet(this, _SymbolPathCollector_set, "f").add(SymbolPath.toString(path));
+        this.#set.add(SymbolPath.toString(path));
     }
     has(path) {
-        return __classPrivateFieldGet(this, _SymbolPathCollector_set, "f").has(SymbolPath.toString(path));
+        return this.#set.has(SymbolPath.toString(path));
     }
     collect() {
-        return [...__classPrivateFieldGet(this, _SymbolPathCollector_set, "f")].map(SymbolPath.fromString);
+        return [...this.#set].map(SymbolPath.fromString);
     }
 }
-exports.SymbolPathCollector = SymbolPathCollector;
-_SymbolPathCollector_set = new WeakMap();
-exports.SymbolUsageTypes = Object.freeze(['definition', 'declaration', 'implementation', 'reference', 'typeDefinition']);
-var SymbolUsageType;
+export const SymbolUsageTypes = Object.freeze(['definition', 'declaration', 'implementation', 'reference', 'typeDefinition']);
+export var SymbolUsageType;
 (function (SymbolUsageType) {
     function is(value) {
-        return exports.SymbolUsageTypes.includes(value);
+        return SymbolUsageTypes.includes(value);
     }
     SymbolUsageType.is = is;
-})(SymbolUsageType = exports.SymbolUsageType || (exports.SymbolUsageType = {}));
-var Symbol;
+})(SymbolUsageType || (SymbolUsageType = {}));
+export var Symbol;
 (function (Symbol) {
     function get(table, category, ...path) {
-        if ((0, common_1.isIterable)(table)) {
+        if (isIterable(table)) {
             for (const t of table) {
                 const result = get(t, category, ...path);
                 if (result) {
@@ -211,21 +196,21 @@ var Symbol;
         return undefined;
     }
     Symbol.get = get;
-})(Symbol = exports.Symbol || (exports.Symbol = {}));
-var SymbolLocation;
+})(Symbol || (Symbol = {}));
+export var SymbolLocation;
 (function (SymbolLocation) {
     /* istanbul ignore next */
     function create(doc, range, fullRange, contributor, additional) {
         return {
-            ...source_1.Location.create(doc, range),
-            ...fullRange ? { fullRange: source_1.Range.get(fullRange), fullPosRange: source_1.PositionRange.from(fullRange, doc) } : {},
+            ...Location.create(doc, range),
+            ...fullRange ? { fullRange: Range.get(fullRange), fullPosRange: PositionRange.from(fullRange, doc) } : {},
             ...contributor ? { contributor } : {},
             ...additional ? additional : {},
         };
     }
     SymbolLocation.create = create;
-})(SymbolLocation = exports.SymbolLocation || (exports.SymbolLocation = {}));
-var SymbolTable;
+})(SymbolLocation || (SymbolLocation = {}));
+export var SymbolTable;
 (function (SymbolTable) {
     /**
      * The passed-in parameter `table` won't be mutated.
@@ -251,7 +236,7 @@ var SymbolTable;
                 linkSymbol(childSymbol, map, parentSymbol, category, [...path, identifier]);
             }
         };
-        const ans = (0, rfdc_1.default)()(table);
+        const ans = rfdc()(table);
         for (const [category, map] of Object.entries(ans)) {
             linkSymbolMap(map, undefined, category, []);
         }
@@ -280,7 +265,7 @@ var SymbolTable;
                 unlinkSymbol(childSymbol);
             }
         };
-        const ans = (0, rfdc_1.default)({ circles: true })(table);
+        const ans = rfdc({ circles: true })(table);
         for (const map of Object.values(ans)) {
             unlinkSymbolMap(map);
         }
@@ -302,7 +287,7 @@ var SymbolTable;
         return link(JSON.parse(json));
     }
     SymbolTable.deserialize = deserialize;
-})(SymbolTable = exports.SymbolTable || (exports.SymbolTable = {}));
+})(SymbolTable || (SymbolTable = {}));
 // interface SymbolEvent {
 // 	symbol: Symbol,
 // }

package/lib/symbol/SymbolUtil.d.ts

@@ -1,10 +1,9 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import type { AstNode } from '../node';
-import type { RangeLike } from '../source';
-import type { AllCategory, Symbol, SymbolLocationBuiltInContributor, SymbolLocationMetadata, SymbolMap, SymbolMetadata, SymbolTable, SymbolUsageType } from './Symbol';
-import { SymbolLocation, SymbolVisibility } from './Symbol';
+import type { ExternalEventEmitter, Externals } from '../common/index.js';
+import type { AstNode } from '../node/index.js';
+import type { RangeLike } from '../source/index.js';
+import type { AllCategory, Symbol, SymbolLocationBuiltInContributor, SymbolLocationMetadata, SymbolMap, SymbolMetadata, SymbolTable, SymbolUsageType } from './Symbol.js';
+import { SymbolLocation, SymbolVisibility } from './Symbol.js';
 export interface LookupResult {
     /**
      * The {@link SymbolMap} that contains the symbol. If `symbol` is `undefined`, this property will be the map that could
@@ -28,28 +27,11 @@ interface SymbolLocationEvent extends SymbolEvent {
     type: SymbolUsageType;
     location: SymbolLocation;
 }
-export interface SymbolUtil {
-    on(event: 'symbolCreated', callbackFn: (data: SymbolEvent) => void): this;
-    on(event: 'symbolAmended', callbackFn: (data: SymbolEvent) => void): this;
-    on(event: 'symbolRemoved', callbackFn: (data: SymbolEvent) => void): this;
-    on(event: 'symbolLocationCreated', callbackFn: (data: SymbolLocationEvent) => void): this;
-    on(event: 'symbolLocationRemoved', callbackFn: (data: SymbolLocationEvent) => void): this;
-    once(event: 'symbolCreated', callbackFn: (data: SymbolEvent) => void): this;
-    once(event: 'symbolAmended', callbackFn: (data: SymbolEvent) => void): this;
-    once(event: 'symbolRemoved', callbackFn: (data: SymbolEvent) => void): this;
-    once(event: 'symbolLocationCreated', callbackFn: (data: SymbolLocationEvent) => void): this;
-    once(event: 'symbolLocationRemoved', callbackFn: (data: SymbolLocationEvent) => void): this;
-    emit(event: 'symbolCreated', data: SymbolEvent): boolean;
-    emit(event: 'symbolAmended', data: SymbolEvent): boolean;
-    emit(event: 'symbolRemoved', data: SymbolEvent): boolean;
-    emit(event: 'symbolLocationCreated', data: SymbolLocationEvent): boolean;
-    emit(event: 'symbolLocationRemoved', data: SymbolLocationEvent): boolean;
-}
 interface DocAndNode {
     doc: TextDocument;
     node: AstNode;
 }
-export declare class SymbolUtil extends EventEmitter {
+export declare class SymbolUtil implements ExternalEventEmitter {
     #private;
     /**
      * @internal
@@ -60,11 +42,26 @@ export declare class SymbolUtil extends EventEmitter {
      */
     _inDelayMode: boolean;
     get global(): SymbolTable;
-    constructor(global: SymbolTable, 
+    constructor(global: SymbolTable, eventEmitterConstructor: Externals['event']['EventEmitter'], 
     /** @internal */
     _currentContributor?: string, 
     /** @internal */
     _inDelayMode?: boolean);
+    on(event: 'symbolCreated', callbackFn: (data: SymbolEvent) => void): this;
+    on(event: 'symbolAmended', callbackFn: (data: SymbolEvent) => void): this;
+    on(event: 'symbolRemoved', callbackFn: (data: SymbolEvent) => void): this;
+    on(event: 'symbolLocationCreated', callbackFn: (data: SymbolLocationEvent) => void): this;
+    on(event: 'symbolLocationRemoved', callbackFn: (data: SymbolLocationEvent) => void): this;
+    once(event: 'symbolCreated', callbackFn: (data: SymbolEvent) => void): this;
+    once(event: 'symbolAmended', callbackFn: (data: SymbolEvent) => void): this;
+    once(event: 'symbolRemoved', callbackFn: (data: SymbolEvent) => void): this;
+    once(event: 'symbolLocationCreated', callbackFn: (data: SymbolLocationEvent) => void): this;
+    once(event: 'symbolLocationRemoved', callbackFn: (data: SymbolLocationEvent) => void): this;
+    emit(event: 'symbolCreated', data: SymbolEvent): boolean;
+    emit(event: 'symbolAmended', data: SymbolEvent): boolean;
+    emit(event: 'symbolRemoved', data: SymbolEvent): boolean;
+    emit(event: 'symbolLocationCreated', data: SymbolLocationEvent): boolean;
+    emit(event: 'symbolLocationRemoved', data: SymbolLocationEvent): boolean;
     /**
      * Build the internal cache of the SymbolUtil according to the current global symbol table.
      */
@@ -223,14 +220,7 @@ interface SymbolAdditionUsageBase extends SymbolLocationMetadata {
      */
     type?: SymbolUsageType;
     /**
-     * The range of the full declaration/implementation of this {@link Symbol}. For example, for the following piece of
-     * nbtdoc code,
-     * ```nbtdoc
-     * 0123456789012345
-     * compound Foo {}
-     * ```
-     *
-     * The `range` for the Symbol `Foo` is `[9, 12)`, while the `fullRange` for it is `[0, 15)`.
+     * @see {@link SymbolLocation.fullRange}
      */
     fullRange?: RangeLike;
 }