@spyglassmc/java-edition 0.3.7 → 0.3.9

package/lib/mcfunction/signatureHelpProvider.d.ts

@@ -1,8 +1,9 @@
 import * as core from '@spyglassmc/core';
 import * as mcf from '@spyglassmc/mcfunction';
+import type { RootTreeNode } from '../dependency';
 /**
  * Only command options that can be satisfied by the current command node will be listed in `signatures`.
  * Only parameters at and immediately after the `offset` will be listed in `parameters`.
  */
-export declare function signatureHelpProvider(commandTreeName: string): core.SignatureHelpProvider<core.FileNode<mcf.McfunctionNode>>;
+export declare function signatureHelpProvider(rootTreeNode: RootTreeNode): core.SignatureHelpProvider<core.FileNode<mcf.McfunctionNode>>;
 //# sourceMappingURL=signatureHelpProvider.d.ts.map

package/lib/mcfunction/signatureHelpProvider.js

@@ -4,14 +4,17 @@ import * as mcf from '@spyglassmc/mcfunction';
  * Only command options that can be satisfied by the current command node will be listed in `signatures`.
  * Only parameters at and immediately after the `offset` will be listed in `parameters`.
  */
-export function signatureHelpProvider(commandTreeName) {
-    const rootTreeNode = mcf.CommandTreeRegistry.instance.get(commandTreeName);
+export function signatureHelpProvider(rootTreeNode) {
     return (fileNode, ctx) => {
         if (fileNode.children[0]?.type !== 'mcfunction:entry') {
             // Not mcfunction.
             return undefined;
         }
         const node = getSelectedCommandNode(fileNode, ctx.offset);
+        if (!mcf.CommandNode.is(node)) {
+            // Not a command node.
+            return undefined;
+        }
         const argumentNodes = node ? node.children : [];
         const options = getOptions(rootTreeNode, argumentNodes);
         if (options.length === 0) {
@@ -31,24 +34,16 @@ export function signatureHelpProvider(commandTreeName) {
             // No matching syntax for the selected argument node.
             return undefined;
         }
-        const ans = {
-            activeSignature: 0,
-            signatures: [],
-        };
+        const ans = { activeSignature: 0, signatures: [] };
         ans.signatures = options.map((v) => {
             const part1 = v[selectedIndex];
-            const part2 = selectedIndex + 1 < v.length
-                ? ` ${v[selectedIndex + 1]}`
-                : '';
+            const part2 = selectedIndex + 1 < v.length ? ` ${v[selectedIndex + 1]}` : '';
             const label = `${part1}${part2}`;
             return {
                 label,
                 activeParameter: 0,
                 // documentation: localize('mcfunction.signature-help.command-documentation', v[0]),
-                parameters: [
-                    { label: [0, part1.length] },
-                    { label: [part1.length, label.length] },
-                ],
+                parameters: [{ label: [0, part1.length] }, { label: [part1.length, label.length] }],
             };
         });
         return ans;
@@ -65,8 +60,7 @@ function getOptions(rootTreeNode, argumentNodes) {
         if (!name) {
             break;
         }
-        treeNode = mcf.resolveParentTreeNode(treeNode, rootTreeNode).treeNode
-            ?.children?.[name];
+        treeNode = mcf.resolveParentTreeNode(treeNode, rootTreeNode).treeNode?.children?.[name];
         if (!treeNode) {
             break;
         }
@@ -75,9 +69,7 @@ function getOptions(rootTreeNode, argumentNodes) {
     if (treeNode) {
         treeNode = mcf.resolveParentTreeNode(treeNode, rootTreeNode).treeNode;
         if (treeNode?.children) {
-            return mcf
-                .treeNodeChildrenToStringArray(treeNode.children, treeNode.executable)
-                .map((v) => [...current, v]);
+            return mcf.treeNodeChildrenToStringArray(treeNode.children, treeNode.executable).map((v) => [...current, v]);
         }
     }
     return current.length ? [current] : [];

package/lib/mcfunction/tree/argument.d.ts

@@ -101,23 +101,80 @@ export interface MinecraftItemPredicateArgumentTreeNode extends mcf.ArgumentTree
 export interface MinecraftItemSlotArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:item_slot';
 }
+export interface MinecraftItemSlotsArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:item_slots';
+}
 export interface MinecraftItemStackArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:item_stack';
 }
+export interface MinecraftLootModifierArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:loot_modifier';
+}
+export interface MinecraftLootPredicateArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:loot_predicate';
+}
+export interface MinecraftLootTableArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:loot_table';
+}
 export interface MinecraftMessageArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:message';
 }
 export interface MinecraftMobEffectArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:mob_effect';
 }
+export interface NbtParserProperties extends Record<string, unknown> {
+    /**
+     * The NBT checker should check this argument by dispatching on `dispatcher`
+     * with a static index inferred from the argument with the name `dispatchedBy`
+     * and optionally indexing on the dispatched type by indices inferred from the
+     * argument named by `indexedBy`.
+     */
+    dispatcher: 'minecraft:block' | 'minecraft:entity' | 'minecraft:storage' | 'minecraft:macro_function';
+    /**
+     * The name of a vec3, an entity, an entity resource location, or a
+     * storage resource location argument.
+     *
+     * @see {@link NbtParserProperties.dispatcher}
+     */
+    dispatchedBy: string;
+    /**
+     * The name of an NBT path argument.
+     *
+     * @see {@link NbtParserProperties.dispatcher}
+     */
+    indexedBy?: string;
+    /**
+     * @default {@link core.SymbolAccessType.Read}
+     */
+    accessType?: core.SymbolAccessType;
+    /**
+     * `true` if the NBT checker should check this argument as a predicate. In a
+     * predicate NBT argument, keys can be missing, resource location strings must
+     * include the default namespace and numbers must have the exact type match.
+     */
+    isPredicate?: boolean;
+    /**
+     * `true` if the NBT checker should check this argument as a merge. In a
+     * merge NBT argument, keys can be missing.
+     */
+    isMerge?: boolean;
+    /**
+     * `true` if the NBT checker should check this type using the list item of
+     * {@link indexedBy}
+     */
+    isListIndex?: boolean;
+}
 export interface MinecraftNbtCompoundTagArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:nbt_compound_tag';
+    properties?: NbtParserProperties;
 }
 export interface MinecraftNbtPathArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:nbt_path';
+    properties?: NbtParserProperties;
 }
 export interface MinecraftNbtTagArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:nbt_tag';
+    properties?: NbtParserProperties;
 }
 export interface MinecraftObjectiveArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:objective';
@@ -153,18 +210,28 @@ export interface MinecraftResourceOrTagArgumentTreeNode extends mcf.ArgumentTree
         registry: string;
     };
 }
+export interface MinecraftResourceOrTagKeyArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:resource_or_tag_key';
+    properties: {
+        registry: string;
+    };
+}
 export interface MinecraftRotationArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:rotation';
 }
 export interface MinecraftScoreHolderArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:score_holder';
     properties: {
+        usageType: core.SymbolUsageType;
         amount: 'single' | 'multiple';
     };
 }
 export interface MinecraftScoreboardSlotArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:scoreboard_slot';
 }
+export interface MinecraftStyleArgumentTreeNode extends mcf.ArgumentTreeNode {
+    parser: 'minecraft:style';
+}
 export interface MinecraftSwizzleArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'minecraft:swizzle';
 }
@@ -193,5 +260,5 @@ export interface MinecraftVec3ArgumentTreeNode extends mcf.ArgumentTreeNode {
 export interface SpyglassmcTagArgumentTreeNode extends mcf.ArgumentTreeNode {
     parser: 'spyglassmc:tag';
 }
-export type ArgumentTreeNode = BrigadierBoolArgumentTreeNode | BrigadierDoubleArgumentTreeNode | BrigadierFloatArgumentTreeNode | BrigadierIntegerArgumentTreeNode | BrigadierLongArgumentTreeNode | BrigadierStringArgumentTreeNode | MinecraftAngleArgumentTreeNode | MinecraftBlockPosArgumentTreeNode | MinecraftBlockPredicateArgumentTreeNode | MinecraftBlockStateArgumentTreeNode | MinecraftColorArgumentTreeNode | MinecraftColumnPosArgumentTreeNode | MinecraftComponentArgumentTreeNode | MinecraftDimensionArgumentTreeNode | MinecraftEntityArgumentTreeNode | MinecraftEntityAnchorArgumentTreeNode | MinecraftEntitySummonArgumentTreeNode | MinecraftFloatRangeArgumentTreeNode | MinecraftFunctionArgumentTreeNode | MinecraftGamemodeArgumentTreeNode | MinecraftGameProfileArgumentTreeNode | MinecraftHeightmapArgumentTreeNode | MinecraftIntRangeArgumentTreeNode | MinecraftItemEnchantmentArgumentTreeNode | MinecraftItemPredicateArgumentTreeNode | MinecraftItemSlotArgumentTreeNode | MinecraftItemStackArgumentTreeNode | MinecraftMessageArgumentTreeNode | MinecraftMobEffectArgumentTreeNode | MinecraftNbtCompoundTagArgumentTreeNode | MinecraftNbtPathArgumentTreeNode | MinecraftNbtTagArgumentTreeNode | MinecraftObjectiveArgumentTreeNode | MinecraftObjectiveCriteriaArgumentTreeNode | MinecraftOperationArgumentTreeNode | MinecraftParticleArgumentTreeNode | MinecraftResourceArgumentTreeNode | MinecraftResourceKeyArgumentTreeNode | MinecraftResourceLocationArgumentTreeNode | MinecraftResourceOrTagArgumentTreeNode | MinecraftRotationArgumentTreeNode | MinecraftScoreHolderArgumentTreeNode | MinecraftScoreboardSlotArgumentTreeNode | MinecraftSwizzleArgumentTreeNode | MinecraftTeamArgumentTreeNode | MinecraftTemplateMirrorArgumentTreeNode | MinecraftTemplateRotationArgumentTreeNode | MinecraftTimeArgumentTreeNode | MinecraftUuidArgumentTreeNode | MinecraftVec2ArgumentTreeNode | MinecraftVec3ArgumentTreeNode | SpyglassmcTagArgumentTreeNode;
+export type ArgumentTreeNode = BrigadierBoolArgumentTreeNode | BrigadierDoubleArgumentTreeNode | BrigadierFloatArgumentTreeNode | BrigadierIntegerArgumentTreeNode | BrigadierLongArgumentTreeNode | BrigadierStringArgumentTreeNode | MinecraftAngleArgumentTreeNode | MinecraftBlockPosArgumentTreeNode | MinecraftBlockPredicateArgumentTreeNode | MinecraftBlockStateArgumentTreeNode | MinecraftColorArgumentTreeNode | MinecraftColumnPosArgumentTreeNode | MinecraftComponentArgumentTreeNode | MinecraftDimensionArgumentTreeNode | MinecraftEntityArgumentTreeNode | MinecraftEntityAnchorArgumentTreeNode | MinecraftEntitySummonArgumentTreeNode | MinecraftFloatRangeArgumentTreeNode | MinecraftFunctionArgumentTreeNode | MinecraftGamemodeArgumentTreeNode | MinecraftGameProfileArgumentTreeNode | MinecraftHeightmapArgumentTreeNode | MinecraftIntRangeArgumentTreeNode | MinecraftItemEnchantmentArgumentTreeNode | MinecraftItemPredicateArgumentTreeNode | MinecraftItemSlotArgumentTreeNode | MinecraftItemSlotsArgumentTreeNode | MinecraftItemStackArgumentTreeNode | MinecraftLootModifierArgumentTreeNode | MinecraftLootPredicateArgumentTreeNode | MinecraftLootTableArgumentTreeNode | MinecraftMessageArgumentTreeNode | MinecraftMobEffectArgumentTreeNode | MinecraftNbtCompoundTagArgumentTreeNode | MinecraftNbtPathArgumentTreeNode | MinecraftNbtTagArgumentTreeNode | MinecraftObjectiveArgumentTreeNode | MinecraftObjectiveCriteriaArgumentTreeNode | MinecraftOperationArgumentTreeNode | MinecraftParticleArgumentTreeNode | MinecraftResourceArgumentTreeNode | MinecraftResourceKeyArgumentTreeNode | MinecraftResourceLocationArgumentTreeNode | MinecraftResourceOrTagArgumentTreeNode | MinecraftResourceOrTagKeyArgumentTreeNode | MinecraftRotationArgumentTreeNode | MinecraftScoreHolderArgumentTreeNode | MinecraftScoreboardSlotArgumentTreeNode | MinecraftStyleArgumentTreeNode | MinecraftSwizzleArgumentTreeNode | MinecraftTeamArgumentTreeNode | MinecraftTemplateMirrorArgumentTreeNode | MinecraftTemplateRotationArgumentTreeNode | MinecraftTimeArgumentTreeNode | MinecraftUuidArgumentTreeNode | MinecraftVec2ArgumentTreeNode | MinecraftVec3ArgumentTreeNode | SpyglassmcTagArgumentTreeNode;
 //# sourceMappingURL=argument.d.ts.map