@spyglassmc/mcdoc 0.3.46 → 0.3.48

package/lib/checker/index.d.ts

@@ -0,0 +1,3 @@
+import type { MetaRegistry } from '@spyglassmc/core';
+export declare function registerMcdocChecker(meta: MetaRegistry): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/checker/index.js

@@ -0,0 +1,28 @@
+import { localize } from '@spyglassmc/locales';
+import { TypeDefSymbolData } from '../binder/index.js';
+import { PathNode, ReferenceTypeNode, TypeArgBlockNode, TypeBaseNode } from '../node/index.js';
+const reference = (node, ctx) => {
+    const { path } = ReferenceTypeNode.destruct(node);
+    const { children } = PathNode.destruct(path);
+    const symbol = children.findLast((c) => c.symbol && c.symbol.category === 'mcdoc' && c.symbol.subcategory !== 'module')?.symbol;
+    if (!TypeDefSymbolData.is(symbol?.data)) {
+        return;
+    }
+    const { appendixes } = TypeBaseNode.destruct(node);
+    let typeArgs = [];
+    if (TypeArgBlockNode.is(appendixes[0])) {
+        const { args } = TypeArgBlockNode.destruct(appendixes[0]);
+        typeArgs = args;
+    }
+    let typeParams = [];
+    if (symbol.data.typeDef.kind === 'template') {
+        typeParams = symbol.data.typeDef.typeParams;
+    }
+    if (typeParams.length !== typeArgs.length) {
+        ctx.err.report(localize('mcdoc.checker.reference.unexpected-number-of-type-arguments', symbol.identifier, typeParams.length, typeArgs.length), node);
+    }
+};
+export function registerMcdocChecker(meta) {
+    meta.registerChecker('mcdoc:type/reference', reference);
+}
+//# sourceMappingURL=index.js.map

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import type * as core from '@spyglassmc/core';
 export * as binder from './binder/index.js';
+export * as checker from './checker/index.js';
 export * as colorizer from './colorizer/index.js';
 export * from './node/index.js';
 export * from './parser/index.js';

package/lib/index.js

@@ -1,10 +1,12 @@
 import * as binder from './binder/index.js';
+import * as checker from './checker/index.js';
 import * as colorizer from './colorizer/index.js';
 import * as formatter from './formatter/index.js';
 import * as parser from './parser/index.js';
 import { registerBuiltinAttributes } from './runtime/attribute/builtin.js';
 import * as uri_professors from './uri_processors.js';
 export * as binder from './binder/index.js';
+export * as checker from './checker/index.js';
 export * as colorizer from './colorizer/index.js';
 export * from './node/index.js';
 export * from './parser/index.js';
@@ -20,5 +22,6 @@ export const initialize = ({ meta }) => {
     binder.registerMcdocBinders(meta);
     colorizer.registerMcdocColorizer(meta);
     formatter.registerMcdocFormatter(meta);
+    checker.registerMcdocChecker(meta);
 };
 //# sourceMappingURL=index.js.map

package/lib/node/index.d.ts

@@ -289,6 +289,18 @@ export interface DocCommentsNode extends AstNode {
 export declare namespace DocCommentsNode {
     /**
      * @returns The text content of this doc comment block.
+     *
+     * If every line contains a leading space or is empty, stripe the leading spaces off.
+     * Trailing whitespace characters at the end are removed.
+     *
+     * e.g., given
+     * ```
+     * /// This is an example doc comment.
+     * ///
+     * /// Another line.
+     * ```
+     *
+     * "This is an example doc comment.\n\nAnother line." is returned.
      */
     function asText(node: DocCommentsNode | undefined): string | undefined;
     function is(node: AstNode | undefined): node is DocCommentsNode;

package/lib/node/index.js

@@ -437,21 +437,29 @@ export var DocCommentsNode;
 (function (DocCommentsNode) {
     /**
      * @returns The text content of this doc comment block.
+     *
+     * If every line contains a leading space or is empty, stripe the leading spaces off.
+     * Trailing whitespace characters at the end are removed.
+     *
+     * e.g., given
+     * ```
+     * /// This is an example doc comment.
+     * ///
+     * /// Another line.
+     * ```
+     *
+     * "This is an example doc comment.\n\nAnother line." is returned.
      */
     function asText(node) {
         if (!node) {
             return undefined;
         }
         let comments = node.children.map((doc) => doc.comment);
-        // If every comment contains a leading space or is empty, stripe the leading spaces off.
-        // e.g. /// This is an example doc comment.
-        //      ///
-        //      /// Another line.
-        // should be converted to "This is an example doc comment.\n\nAnother line."
-        if (comments.every((s) => s.length === 0 || s.startsWith(' '))) {
-            comments = comments.map((s) => s.slice(1));
+        // Note that each comment node includes the ending newline character.
+        if (comments.every((s) => !s.trim() || s.startsWith(' '))) {
+            comments = comments.map((s) => s.replace(/^ /, ''));
         }
-        return comments.join('\n');
+        return comments.join('').trimEnd();
     }
     DocCommentsNode.asText = asText;
     function is(node) {

package/lib/runtime/attribute/builtin.js

@@ -1,6 +1,7 @@
 import * as core from '@spyglassmc/core';
 import { localeQuote, localize } from '@spyglassmc/locales';
-import { registerAttribute, validator } from './index.js';
+import { TypeDefSymbolData } from '../../binder/index.js';
+import { registerAttribute, shouldKeepAccordingToAttributeFilters, validator } from './index.js';
 const idValidator = validator.alternatives(validator.map(validator.string, v => ({ registry: v })), validator.tree({
     registry: validator.string,
     tags: validator.optional(validator.options('allowed', 'implicit', 'required')),
@@ -60,7 +61,17 @@ export function registerBuiltinAttributes(meta) {
     registerAttribute(meta, 'dispatcher_key', validator.string, {
         stringMocker: (config, _, ctx) => {
             const symbol = ctx.symbols.query(ctx.doc, 'mcdoc/dispatcher', config).symbol;
-            const keys = Object.keys(symbol?.members ?? {}).filter(m => !m.startsWith('%'));
+            const keys = Object.entries(symbol?.members ?? {})
+                .filter(([k, v]) => {
+                if (k.startsWith('%')) {
+                    return false;
+                }
+                if (!TypeDefSymbolData.is(v.data)) {
+                    return false;
+                }
+                return shouldKeepAccordingToAttributeFilters(v.data.typeDef.attributes, ctx);
+            })
+                .map(([k, _]) => k);
             return core.LiteralNode.mock(ctx.offset, { pool: keys });
         },
     });

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

@@ -21,4 +21,5 @@ interface AttributeInfo {
 }
 export declare function getAttribute(meta: core.MetaRegistry, name: string): AttributeInfo | undefined;
 export declare function handleAttributes(attributes: core.DeepReadonly<Attribute[]> | undefined, ctx: core.ContextBase, fn: <C>(handler: McdocAttribute<C>, config: C) => void): void;
+export declare function shouldKeepAccordingToAttributeFilters(attributes: core.DeepReadonly<Attribute[]> | undefined, ctx: core.ContextBase): boolean;
 //# sourceMappingURL=index.d.ts.map

package/lib/runtime/attribute/index.js

@@ -19,4 +19,16 @@ export function handleAttributes(attributes, ctx, fn) {
         fn(handler.attribute, config);
     }
 }
+export function shouldKeepAccordingToAttributeFilters(attributes, ctx) {
+    let keep = true;
+    handleAttributes(attributes, ctx, (handler, config) => {
+        if (!keep || !handler.filterElement) {
+            return;
+        }
+        if (!handler.filterElement(config, ctx)) {
+            keep = false;
+        }
+    });
+    return keep;
+}
 //# sourceMappingURL=index.js.map

package/lib/runtime/checker/index.js

@@ -2,7 +2,7 @@ import { Range, Source } from '@spyglassmc/core';
 import { localize } from '@spyglassmc/locales';
 import { TypeDefSymbolData } from '../../binder/index.js';
 import { McdocType, NumericRange } from '../../type/index.js';
-import { handleAttributes } from '../attribute/index.js';
+import { handleAttributes, shouldKeepAccordingToAttributeFilters } from '../attribute/index.js';
 import { McdocCheckerContext } from './context.js';
 import { condenseAndPropagate } from './error.js';
 export * from './context.js';
@@ -604,6 +604,9 @@ function resolveIndices(parallelIndices, symbolMap, symbolQuery, context) {
     let dynamicData = false;
     let values = [];
     function pushValue(key, data) {
+        if (!shouldKeepAccordingToAttributeFilters(data.typeDef.attributes, context.ctx)) {
+            return;
+        }
         if (context.ctx.config.env.enableMcdocCaching && data.simplifiedTypeDef) {
             if (data.simplifiedTypeDef.kind === 'union') {
                 values.push(...data.simplifiedTypeDef.members);
@@ -753,23 +756,11 @@ function resolveIndices(parallelIndices, symbolMap, symbolQuery, context) {
 }
 function simplifyUnion(typeDef, context) {
     let dynamicData = false;
-    let validMembers = typeDef.members
-        .filter(member => {
-        let keep = true;
-        handleAttributes(member.attributes, context.ctx, (handler, config) => {
-            if (!keep || !handler.filterElement) {
-                return;
-            }
-            if (!handler.filterElement(config, context.ctx)) {
-                keep = false;
-            }
-        });
-        return keep;
-    });
+    let validMembers = typeDef.members.filter(member => shouldKeepAccordingToAttributeFilters(member.attributes, context.ctx));
     const filterCanonical = context.ctx.requireCanonical
         && validMembers.some(m => m.attributes?.some(a => a.name === 'canonical'));
     if (filterCanonical) {
-        validMembers = typeDef.members.filter(member => member.attributes?.some(a => a.name === 'canonical'));
+        validMembers = validMembers.filter(member => member.attributes?.some(a => a.name === 'canonical'));
     }
     if (validMembers.length === 1) {
         return simplify(validMembers[0], context);
@@ -815,13 +806,7 @@ function simplifyStruct(typeDef, context) {
         }
     }
     for (const field of typeDef.fields) {
-        let keep = true;
-        handleAttributes(field.attributes, context.ctx, (handler, config) => {
-            if (keep && handler.filterElement?.(config, context.ctx) === false) {
-                keep = false;
-            }
-        });
-        if (!keep) {
+        if (!shouldKeepAccordingToAttributeFilters(field.attributes, context.ctx)) {
             continue;
         }
         if (field.kind === 'pair') {
@@ -917,18 +902,7 @@ function simplifyTuple(typeDef, context) {
     };
 }
 function simplifyEnum(typeDef, context) {
-    const filteredValues = typeDef.values.filter(value => {
-        let keep = true;
-        handleAttributes(value.attributes, context.ctx, (handler, config) => {
-            if (!keep || !handler.filterElement) {
-                return;
-            }
-            if (!handler.filterElement(config, context.ctx)) {
-                keep = false;
-            }
-        });
-        return keep;
-    });
+    const filteredValues = typeDef.values.filter(value => shouldKeepAccordingToAttributeFilters(value.attributes, context.ctx));
     return { typeDef: { ...typeDef, enumKind: typeDef.enumKind ?? 'int', values: filteredValues } };
 }
 function simplifyConcrete(typeDef, context) {

package/lib/runtime/completer/index.js

@@ -1,5 +1,5 @@
 import { TypeDefSymbolData } from '../../binder/index.js';
-import { handleAttributes } from '../attribute/index.js';
+import { handleAttributes, shouldKeepAccordingToAttributeFilters } from '../attribute/index.js';
 export function getFields(typeDef, ctx) {
     switch (typeDef.kind) {
         case 'union':
@@ -78,19 +78,7 @@ export function getValues(typeDef, ctx) {
         case 'boolean':
             return ['false', 'true'].map(v => ({ value: v, kind: 'boolean' }));
         case 'enum':
-            // TODO: de-duplicate this logic from the runtime simplifier
-            const filteredValues = typeDef.values.filter(value => {
-                let keep = true;
-                handleAttributes(value.attributes, ctx, (handler, config) => {
-                    if (!keep || !handler.filterElement) {
-                        return;
-                    }
-                    if (!handler.filterElement(config, ctx)) {
-                        keep = false;
-                    }
-                });
-                return keep;
-            });
+            const filteredValues = typeDef.values.filter(value => shouldKeepAccordingToAttributeFilters(value.attributes, ctx));
             return filteredValues.map(v => ({
                 value: `${v.value}`,
                 detail: v.identifier,

package/lib/uri_processors.js

@@ -27,7 +27,8 @@ export const uriBinder = (uris, ctx) => {
     // file:///root/mcdoc/foo/mod.mcdoc -> foo
     // file:///root/mcdoc/foo/bar.mcdoc -> foo/bar
     for (const [uri, rel] of urisAndRels) {
-        ctx.symbols.query(uri, 'mcdoc', segToIdentifier(rel.split('/'))).ifKnown(() => { }).elseEnter({
+        ctx.symbols.query(uri, 'mcdoc', segToIdentifier(rel.split('/'))).ifDefined(() => { })
+            .elseEnter({
             data: { subcategory: 'module' },
             usage: { type: 'definition' },
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/mcdoc",
-  "version": "0.3.46",
+  "version": "0.3.48",
   "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.42",
-    "@spyglassmc/locales": "0.3.21"
+    "@spyglassmc/core": "0.4.44",
+    "@spyglassmc/locales": "0.3.23"
   }
 }