@spyglassmc/mcdoc 0.3.18 → 0.3.20

package/lib/binder/index.d.ts

@@ -1,10 +1,11 @@
 import type { BinderContext, MetaRegistry } from '@spyglassmc/core';
 import { AsyncBinder } from '@spyglassmc/core';
-import type { AdditionalContext } from '../common.js';
 import type { ModuleNode } from '../node/index.js';
 import type { SimplifiedMcdocType } from '../runtime/checker/index.js';
 import type { McdocType } from '../type/index.js';
-interface McdocBinderContext extends BinderContext, AdditionalContext {
+interface McdocBinderContext extends BinderContext {
+    moduleIdentifier: string;
+    isHoisting?: boolean;
 }
 export interface TypeDefSymbolData {
     typeDef: McdocType;

package/lib/binder/index.js

@@ -33,7 +33,7 @@ export async function module_(node, ctx) {
     ctx.symbols.query({ doc: ctx.doc, node }, 'mcdoc', ctx.moduleIdentifier).amend({
         data: { data },
     });
-    hoist(node, ctx);
+    hoist(node, { ...ctx, isHoisting: true });
     for (const child of node.children) {
         switch (child.type) {
             case 'mcdoc:dispatch_statement':
@@ -559,6 +559,10 @@ function convertTypeArgBlock(node, ctx) {
 }
 function convertEnum(node, ctx) {
     const { block, enumKind, identifier } = EnumNode.destruct(node);
+    // Return reference if the enum has been hoisted
+    if (identifier && !ctx.isHoisting) {
+        return { kind: 'reference', path: `${ctx.moduleIdentifier}::${identifier.value}` };
+    }
     // Shortcut if the typeDef has been added to the enum symbol.
     const symbol = identifier?.symbol ?? node.symbol;
     if (symbol && TypeDefSymbolData.is(symbol.data) && symbol.data.typeDef.kind === 'enum') {
@@ -571,9 +575,10 @@ function convertEnumBlock(node, ctx) {
     return fields.map((n) => convertEnumField(n, ctx));
 }
 function convertEnumField(node, ctx) {
-    const { attributes, identifier, value } = EnumFieldNode.destruct(node);
+    const { attributes, docComments, identifier, value } = EnumFieldNode.destruct(node);
     return {
         attributes: convertAttributes(attributes, ctx),
+        desc: DocCommentsNode.asText(docComments),
         identifier: identifier.value,
         value: convertEnumValue(value, ctx),
     };
@@ -587,6 +592,10 @@ function convertEnumValue(node, ctx) {
 }
 function convertStruct(node, ctx) {
     const { block, identifier } = StructNode.destruct(node);
+    // Return reference if the struct has been hoisted
+    if (identifier && !ctx.isHoisting) {
+        return { kind: 'reference', path: `${ctx.moduleIdentifier}::${identifier.value}` };
+    }
     // Shortcut if the typeDef has been added to the struct symbol.
     const symbol = identifier?.symbol ?? node.symbol;
     if (symbol && TypeDefSymbolData.is(symbol.data) && symbol.data.typeDef.kind === 'struct') {

package/lib/common.d.ts

@@ -1,7 +1,4 @@
 export type Segments = readonly string[];
 export declare function identifierToSeg(identifier: string): Segments;
 export declare function segToIdentifier(seg: Segments): string;
-export interface AdditionalContext {
-    moduleIdentifier: string;
-}
 //# sourceMappingURL=common.d.ts.map

package/lib/node/index.d.ts

@@ -310,6 +310,7 @@ export interface EnumFieldNode extends AstNode {
 export declare namespace EnumFieldNode {
     function destruct(node: EnumFieldNode): {
         attributes: AttributeNode[];
+        docComments?: DocCommentsNode;
         identifier: IdentifierNode;
         value: EnumValueNode;
     };

package/lib/node/index.js

@@ -475,6 +475,7 @@ export var EnumFieldNode;
     function destruct(node) {
         return {
             attributes: node.children.filter(AttributeNode.is),
+            docComments: node.children.find(DocCommentsNode.is),
             identifier: node.children.find(IdentifierNode.is),
             value: node.children.find(EnumValueNode.is),
         };

package/lib/runtime/checker/index.js

@@ -545,7 +545,7 @@ function simplifyReference(typeDef, context) {
         context.ctx.logger.warn(`Tried to access unknown reference ${typeDef.path}`);
         return { typeDef: { kind: 'union', members: [] } };
     }
-    if (data.simplifiedTypeDef) {
+    if (context.ctx.config.env.enableMcdocCaching && data.simplifiedTypeDef) {
         return { typeDef: data.simplifiedTypeDef };
     }
     const simplifiedResult = simplify(data.typeDef, context);
@@ -555,7 +555,7 @@ function simplifyReference(typeDef, context) {
             attributes: [...typeDef.attributes, ...simplifiedResult.typeDef.attributes ?? []],
         };
     }
-    if (!simplifiedResult.dynamicData) {
+    if (context.ctx.config.env.enableMcdocCaching && !simplifiedResult.dynamicData) {
         symbol.amend({
             data: {
                 data: {
@@ -604,7 +604,7 @@ function resolveIndices(parallelIndices, symbolMap, symbolQuery, context) {
     let dynamicData = false;
     let values = [];
     function pushValue(key, data) {
-        if (data.simplifiedTypeDef) {
+        if (context.ctx.config.env.enableMcdocCaching && data.simplifiedTypeDef) {
             if (data.simplifiedTypeDef.kind === 'union') {
                 values.push(...data.simplifiedTypeDef.members);
             }
@@ -617,7 +617,7 @@ function resolveIndices(parallelIndices, symbolMap, symbolQuery, context) {
             if (simplifiedResult.dynamicData) {
                 dynamicData = true;
             }
-            else if (symbolQuery) {
+            else if (context.ctx.config.env.enableMcdocCaching && symbolQuery) {
                 symbolQuery.member(key, s => s.amend({
                     data: { data: { ...data, simplifiedTypeDef: simplifiedResult.typeDef } },
                 }));

package/lib/runtime/completer/index.d.ts

@@ -12,6 +12,7 @@ export declare function getFields(typeDef: core.DeepReadonly<SimplifiedMcdocType
 export type SimpleCompletionValue = {
     value: string;
     detail?: string;
+    documentation?: string;
     labelSuffix?: string;
     kind?: McdocType['kind'];
     completionKind?: core.CompletionKind;

package/lib/runtime/completer/index.js

@@ -94,6 +94,7 @@ export function getValues(typeDef, ctx) {
                 value: `${v.value}`,
                 detail: v.identifier,
                 kind: typeDef.enumKind ?? 'string',
+                documentation: v.desc,
             }));
         case 'byte':
         case 'short':

package/lib/type/index.d.ts

@@ -86,6 +86,7 @@ export interface EnumType extends McdocBaseType {
 export interface EnumTypeField extends McdocBaseType {
     identifier: string;
     value: string | number;
+    desc?: string;
 }
 export interface ReferenceType extends McdocBaseType {
     kind: 'reference';
@@ -181,7 +182,4 @@ export declare namespace McdocType {
     function equals(a: McdocType, b: McdocType): boolean;
     function toString(type: McdocType | undefined): string;
 }
-export interface UseStatementBindingData {
-    target: readonly string[];
-}
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/mcdoc",
-  "version": "0.3.18",
+  "version": "0.3.20",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -25,7 +25,7 @@
     "url": "https://github.com/SpyglassMC/Spyglass/issues"
   },
   "dependencies": {
-    "@spyglassmc/core": "0.4.15",
-    "@spyglassmc/locales": "0.3.9"
+    "@spyglassmc/core": "0.4.16",
+    "@spyglassmc/locales": "0.3.10"
   }
 }