@spyglassmc/mcdoc 0.3.0 → 0.3.2

package/lib/colorizer/index.js

@@ -1,8 +1,8 @@
 import { ColorToken } from '@spyglassmc/core';
-export const identifier = node => {
+export const identifier = (node) => {
     return [ColorToken.create(node, 'variable')];
 };
-export const literal = node => {
+export const literal = (node) => {
     return [ColorToken.create(node, node.colorTokenType ?? 'literal')];
 };
 export function registerMcdocColorizer(meta) {

package/lib/node/index.d.ts

@@ -13,7 +13,7 @@ export declare const TopLevelNode: Readonly<{
 }>;
 export interface DispatchStatementNode extends AstNode {
     type: 'mcdoc:dispatch_statement';
-    children: (CommentNode | AttributeNode | LiteralNode | ResourceLocationNode | IndexBodyNode | TypeNode)[];
+    children: (CommentNode | AttributeNode | LiteralNode | ResourceLocationNode | IndexBodyNode | TypeParamBlockNode | TypeNode)[];
 }
 export declare const DispatchStatementNode: Readonly<{
     destruct(node: DispatchStatementNode): {
@@ -21,6 +21,7 @@ export declare const DispatchStatementNode: Readonly<{
         location?: ResourceLocationNode;
         index?: IndexBodyNode;
         target?: TypeNode;
+        typeParams?: TypeParamBlockNode;
     };
     is(node: AstNode | undefined): node is DispatchStatementNode;
 }>;
@@ -76,12 +77,12 @@ export declare const TypeNode: Readonly<{
 }>;
 export interface TypeBaseNode<CN extends AstNode> extends AstNode {
     type: `mcdoc:${string}`;
-    children: (CommentNode | AttributeNode | IndexBodyNode | CN)[];
+    children: (CommentNode | AttributeNode | IndexBodyNode | TypeArgBlockNode | CN)[];
 }
 export declare const TypeBaseNode: Readonly<{
     destruct(node: TypeBaseNode<any>): {
+        appendixes: (IndexBodyNode | TypeArgBlockNode)[];
         attributes: AttributeNode[];
-        indices: IndexBodyNode[];
     };
 }>;
 export interface AttributeNode extends AstNode {
@@ -135,6 +136,16 @@ export interface AttributeTreeNamedKeyValuePair {
     key: IdentifierNode | StringNode;
     value: AttributeValueNode;
 }
+export interface TypeArgBlockNode extends AstNode {
+    type: 'mcdoc:type_arg_block';
+    children: (CommentNode | TypeNode)[];
+}
+export declare const TypeArgBlockNode: Readonly<{
+    destruct(node: TypeArgBlockNode): {
+        args: TypeNode[];
+    };
+    is(node: AstNode | undefined): node is TypeArgBlockNode;
+}>;
 export interface AnyTypeNode extends TypeBaseNode<LiteralNode> {
     type: 'mcdoc:type/any';
 }
@@ -264,6 +275,7 @@ export declare const EnumNode: Readonly<{
         docComments?: DocCommentsNode;
         enumKind?: EnumKind;
         identifier?: IdentifierNode;
+        keyword: LiteralNode;
     };
     is(node: AstNode | undefined): node is EnumNode;
 }>;
@@ -316,16 +328,16 @@ export declare const StructNode: Readonly<{
         block: StructBlockNode;
         docComments?: DocCommentsNode;
         identifier?: IdentifierNode;
+        keyword: LiteralNode;
     };
     is(node: AstNode | undefined): node is StructNode;
 }>;
-export interface ReferenceTypeNode extends TypeBaseNode<PathNode | TypeNode> {
+export interface ReferenceTypeNode extends TypeBaseNode<PathNode> {
     type: 'mcdoc:type/reference';
 }
 export declare const ReferenceTypeNode: Readonly<{
     destruct(node: ReferenceTypeNode): {
         path: PathNode;
-        typeParameters: TypeNode[];
     };
     is(node: AstNode | undefined): node is ReferenceTypeNode;
 }>;
@@ -464,12 +476,14 @@ export declare const StructInjectionNode: Readonly<{
 }>;
 export interface TypeAliasNode extends AstNode {
     type: 'mcdoc:type_alias';
-    children: (CommentNode | DocCommentsNode | LiteralNode | IdentifierNode | TypeParamBlockNode | TypeNode)[];
+    children: (CommentNode | PrelimNode | LiteralNode | IdentifierNode | TypeParamBlockNode | TypeNode)[];
 }
 export declare const TypeAliasNode: Readonly<{
     destruct(node: TypeAliasNode): {
+        attributes: AttributeNode[];
         docComments?: DocCommentsNode;
-        identifier?: IdentifierNode;
+        identifier: IdentifierNode;
+        keyword: LiteralNode;
         typeParams?: TypeParamBlockNode;
         rhs?: TypeNode;
     };

package/lib/node/index.js

@@ -1,4 +1,4 @@
-import { atArray, CommentNode, FloatNode, ResourceLocationNode, StringNode } from '@spyglassmc/core';
+import { atArray, CommentNode, FloatNode, ResourceLocationNode, StringNode, } from '@spyglassmc/core';
 export const ModuleNode = Object.freeze({
     is(node) {
         return node?.type === 'mcdoc:module';
@@ -22,10 +22,12 @@ export const DispatchStatementNode = Object.freeze({
             location: node.children.find(ResourceLocationNode.is),
             index: node.children.find(IndexBodyNode.is),
             target: node.children.find(TypeNode.is),
+            typeParams: node.children.find(TypeParamBlockNode.is),
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:dispatch_statement';
+        return (node?.type ===
+            'mcdoc:dispatch_statement');
     },
 });
 export const LiteralNode = Object.freeze({
@@ -50,7 +52,10 @@ export const IndexNode = Object.freeze({
 });
 export const StaticIndexNode = Object.freeze({
     is(node) {
-        return LiteralNode.is(node) || IdentifierNode.is(node) || StringNode.is(node) || ResourceLocationNode.is(node);
+        return (LiteralNode.is(node) ||
+            IdentifierNode.is(node) ||
+            StringNode.is(node) ||
+            ResourceLocationNode.is(node));
     },
 });
 export const IdentifierNode = Object.freeze({
@@ -65,12 +70,12 @@ export const DynamicIndexNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:dynamic_index';
+        return (node?.type === 'mcdoc:dynamic_index');
     },
 });
 export const AccessorKeyNode = Object.freeze({
     is(node) {
-        return LiteralNode.is(node) || IdentifierNode.is(node) || StringNode.is(node);
+        return (LiteralNode.is(node) || IdentifierNode.is(node) || StringNode.is(node));
     },
 });
 export const TypeNode = Object.freeze({
@@ -93,8 +98,8 @@ export const TypeNode = Object.freeze({
 export const TypeBaseNode = Object.freeze({
     destruct(node) {
         return {
+            appendixes: node.children.filter((n) => IndexBodyNode.is(n) || TypeArgBlockNode.is(n)),
             attributes: node.children.filter(AttributeNode.is),
-            indices: node.children.filter(IndexBodyNode.is),
         };
     },
 });
@@ -122,7 +127,7 @@ export const AttributeTreeNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:attribute/tree';
+        return (node?.type === 'mcdoc:attribute/tree');
     },
 });
 export const AttributeTreePosValuesNode = Object.freeze({
@@ -132,7 +137,8 @@ export const AttributeTreePosValuesNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:attribute/tree/pos';
+        return (node?.type ===
+            'mcdoc:attribute/tree/pos');
     },
 });
 export const AttributeTreeNamedValuesNode = Object.freeze({
@@ -156,7 +162,18 @@ export const AttributeTreeNamedValuesNode = Object.freeze({
         return ans;
     },
     is(node) {
-        return node?.type === 'mcdoc:attribute/tree/named';
+        return (node?.type ===
+            'mcdoc:attribute/tree/named');
+    },
+});
+export const TypeArgBlockNode = Object.freeze({
+    destruct(node) {
+        return {
+            args: node.children.filter(TypeNode.is),
+        };
+    },
+    is(node) {
+        return (node?.type === 'mcdoc:type_arg_block');
     },
 });
 export const AnyTypeNode = Object.freeze({
@@ -189,7 +206,7 @@ export const LiteralTypeNode = Object.freeze({
 });
 export const LiteralTypeValueNode = Object.freeze({
     is(node) {
-        return LiteralNode.is(node) || TypedNumberNode.is(node) || StringNode.is(node);
+        return (LiteralNode.is(node) || TypedNumberNode.is(node) || StringNode.is(node));
     },
 });
 export const TypedNumberNode = Object.freeze({
@@ -207,11 +224,12 @@ export const NumericTypeNode = Object.freeze({
     destruct(node) {
         return {
             numericKind: node.children.find(LiteralNode.is),
-            valueRange: node.children.find(FloatRangeNode.is) || node.children.find(IntRangeNode.is),
+            valueRange: node.children.find(FloatRangeNode.is) ||
+                node.children.find(IntRangeNode.is),
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:type/numeric_type';
+        return (node?.type === 'mcdoc:type/numeric_type');
     },
 });
 export const RangeExclusiveChar = '<';
@@ -294,7 +312,8 @@ export const PrimitiveArrayTypeNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:type/primitive_array';
+        return (node?.type ===
+            'mcdoc:type/primitive_array');
     },
 });
 export const ListTypeNode = Object.freeze({
@@ -328,7 +347,15 @@ export const TupleTypeNode = Object.freeze({
         return node?.type === 'mcdoc:type/tuple';
     },
 });
-const EnumKinds = new Set(['byte', 'short', 'int', 'long', 'float', 'double', 'string']);
+const EnumKinds = new Set([
+    'byte',
+    'short',
+    'int',
+    'long',
+    'float',
+    'double',
+    'string',
+]);
 export const EnumNode = Object.freeze({
     kinds: EnumKinds,
     destruct(node) {
@@ -337,6 +364,7 @@ export const EnumNode = Object.freeze({
             docComments: node.children.find(DocCommentsNode.is),
             enumKind: getEnumKind(node),
             identifier: node.children.find(IdentifierNode.is),
+            keyword: node.children.find(LiteralNode.is),
         };
         function getEnumKind(node) {
             for (const literal of node.children.filter(LiteralNode.is)) {
@@ -359,14 +387,14 @@ export const DocCommentsNode = Object.freeze({
         if (!node) {
             return undefined;
         }
-        let comments = node.children.map(doc => doc.comment);
+        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));
+        if (comments.every((s) => s.length === 0 || s.startsWith(' '))) {
+            comments = comments.map((s) => s.slice(1));
         }
         return comments.join('\n');
     },
@@ -412,6 +440,7 @@ export const StructNode = Object.freeze({
             block: node.children.find(StructBlockNode.is),
             docComments: node.children.find(DocCommentsNode.is),
             identifier: node.children.find(IdentifierNode.is),
+            keyword: node.children.find(LiteralNode.is),
         };
     },
     is(node) {
@@ -422,11 +451,10 @@ export const ReferenceTypeNode = Object.freeze({
     destruct(node) {
         return {
             path: node.children.find(PathNode.is),
-            typeParameters: node.children.filter(TypeNode.is),
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:type/reference';
+        return (node?.type === 'mcdoc:type/reference');
     },
 });
 export const TypeParamBlockNode = Object.freeze({
@@ -436,7 +464,8 @@ export const TypeParamBlockNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:type_param_block';
+        return (node?.type ===
+            'mcdoc:type_param_block');
     },
 });
 export const TypeParamNode = Object.freeze({
@@ -488,12 +517,15 @@ export const StructPairFieldNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:struct/field/pair';
+        return (node?.type ===
+            'mcdoc:struct/field/pair');
     },
 });
 export const StructKeyNode = Object.freeze({
     is(node) {
-        return StringNode.is(node) || IdentifierNode.is(node) || StructMapKeyNode.is(node);
+        return (StringNode.is(node) ||
+            IdentifierNode.is(node) ||
+            StructMapKeyNode.is(node));
     },
 });
 export const StructMapKeyNode = Object.freeze({
@@ -503,7 +535,7 @@ export const StructMapKeyNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:struct/map_key';
+        return (node?.type === 'mcdoc:struct/map_key');
     },
 });
 export const StructSpreadFieldNode = Object.freeze({
@@ -514,7 +546,8 @@ export const StructSpreadFieldNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:struct/field/spread';
+        return (node?.type ===
+            'mcdoc:struct/field/spread');
     },
 });
 export const DispatcherTypeNode = Object.freeze({
@@ -525,7 +558,7 @@ export const DispatcherTypeNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:type/dispatcher';
+        return (node?.type === 'mcdoc:type/dispatcher');
     },
 });
 export const UnionTypeNode = Object.freeze({
@@ -555,19 +588,22 @@ export const InjectionContentNode = Object.freeze({
 });
 export const EnumInjectionNode = Object.freeze({
     is(node) {
-        return node?.type === 'mcdoc:injection/enum';
+        return (node?.type === 'mcdoc:injection/enum');
     },
 });
 export const StructInjectionNode = Object.freeze({
     is(node) {
-        return node?.type === 'mcdoc:injection/struct';
+        return (node?.type ===
+            'mcdoc:injection/struct');
     },
 });
 export const TypeAliasNode = Object.freeze({
     destruct(node) {
         return {
+            attributes: node.children.filter(AttributeNode.is),
             docComments: node.children.find(DocCommentsNode.is),
             identifier: node.children.find(IdentifierNode.is),
+            keyword: node.children.find(LiteralNode.is),
             typeParams: node.children.find(TypeParamBlockNode.is),
             rhs: node.children.find(TypeNode.is),
         };
@@ -584,7 +620,7 @@ export const UseStatementNode = Object.freeze({
         };
     },
     is(node) {
-        return node?.type === 'mcdoc:use_statement';
+        return (node?.type === 'mcdoc:use_statement');
     },
 });
 //# sourceMappingURL=index.js.map

package/lib/parser/index.d.ts

@@ -25,7 +25,7 @@ export declare const typedNumber: InfallibleParser<TypedNumberNode>;
 export declare const enum_: Parser<EnumNode>;
 export declare const struct: Parser<StructNode>;
 export declare const injection: Parser<InjectionNode>;
-export declare const typeAlias: Parser<TypeAliasNode>;
+export declare const typeAliasStatement: Parser<TypeAliasNode>;
 export declare const useStatement: Parser<UseStatementNode>;
 export declare const module_: Parser<ModuleNode>;
 export declare const anyType: Parser<AnyTypeNode>;