@spyglassmc/mcdoc 0.1.1 → 0.3.1

package/lib/type/index.d.ts

@@ -1,32 +1,43 @@
-import type { FullResourceLocation, ProcessorContext, SymbolPath } from '@spyglassmc/core';
-import type { EnumKind } from '../node';
+import type { FullResourceLocation, ProcessorContext } from '@spyglassmc/core';
+import type { EnumKind, RangeKind } from '../node/index.js';
 export interface Attribute {
     name: string;
-    value: AttributeValue;
+    value?: AttributeValue;
 }
-export declare type AttributeValue = string | {
+export declare type AttributeValue = McdocType | {
+    kind: 'tree';
+    values: AttributeTree;
+};
+export declare type AttributeTree = {
     [key: string | number]: AttributeValue;
 };
-export declare type NumericRange = [number | undefined, number | undefined];
-interface StaticIndex {
+export declare type NumericRange = {
+    kind: RangeKind;
+    min?: number;
+    max?: number;
+};
+export declare const StaticIndexKeywords: readonly ["fallback", "none", "unknown"];
+export declare type StaticIndexKeyword = typeof StaticIndexKeywords[number];
+export interface StaticIndex {
     kind: 'static';
-    value: string | {
-        keyword: 'fallback' | 'none' | 'unknown';
-    };
+    value: string;
 }
-interface DynamicIndex {
+export interface DynamicIndex {
     kind: 'dynamic';
     accessor: (string | {
         keyword: 'key' | 'parent';
     })[];
 }
 export declare type Index = StaticIndex | DynamicIndex;
-export declare type ParallelIndices = [Index, ...Index[]];
+/**
+ * Corresponds to the IndexBodyNode
+ */
+export declare type ParallelIndices = Index[];
 export interface DispatcherData {
-    registry: FullResourceLocation | undefined;
+    registry: FullResourceLocation;
     index: ParallelIndices;
 }
-interface TypeBase {
+export interface TypeBase {
     kind: string;
     attributes?: Attribute[];
     indices?: ParallelIndices[];
@@ -36,28 +47,35 @@ export interface DispatcherType extends TypeBase, DispatcherData {
 }
 export interface StructType extends TypeBase {
     kind: 'struct';
-    fields: ({
-        kind: 'field';
-        key: string;
-        type: McdocType;
-        symbol: SymbolPath;
-    } | {
-        kind: 'spread';
-        type: McdocType;
-    })[];
+    fields: StructTypeField[];
+}
+export declare type StructTypeField = StructTypePairField | StructTypeSpreadField;
+export interface StructTypePairField {
+    kind: 'pair';
+    attributes?: Attribute[];
+    key: string | McdocType;
+    type: McdocType;
+    optional?: boolean;
+}
+export interface StructTypeSpreadField {
+    kind: 'spread';
+    attributes?: Attribute[];
+    type: McdocType;
 }
 export interface EnumType extends TypeBase {
     kind: 'enum';
-    enumKind: EnumKind;
-    values: {
-        identifier: string;
-        value: string | number | bigint;
-    }[];
+    enumKind?: EnumKind;
+    values: EnumTypeField[];
+}
+export interface EnumTypeField {
+    attributes?: Attribute[];
+    identifier: string;
+    value: string | number | bigint;
 }
 export interface ReferenceType extends TypeBase {
     kind: 'reference';
-    symbol?: SymbolPath;
-    index?: Index;
+    path?: string;
+    typeParameters?: McdocType[];
 }
 export interface UnionType<T extends McdocType = McdocType> extends TypeBase {
     kind: 'union';
@@ -65,14 +83,14 @@ export interface UnionType<T extends McdocType = McdocType> extends TypeBase {
 }
 export declare const EmptyUnion: UnionType<never> & NoIndices;
 export declare function createEmptyUnion(attributes?: Attribute[]): UnionType<never> & NoIndices;
-interface KeywordType extends TypeBase {
+export interface KeywordType extends TypeBase {
     kind: 'any' | 'boolean';
 }
-interface StringType extends TypeBase {
+export interface StringType extends TypeBase {
     kind: 'string';
     lengthRange?: NumericRange;
 }
-declare type LiteralValue = {
+export declare type LiteralValue = {
     kind: 'boolean';
     value: boolean;
 } | {
@@ -81,21 +99,35 @@ declare type LiteralValue = {
 } | {
     kind: 'number';
     value: number;
-    suffix: 'b' | 's' | 'L' | 'f' | 'd' | undefined;
+    suffix: 'b' | 's' | 'l' | 'f' | 'd' | undefined;
 };
-interface LiteralType extends TypeBase {
+export interface LiteralType extends TypeBase {
     kind: 'literal';
     value: LiteralValue;
 }
-interface NumericType extends TypeBase {
-    kind: 'byte' | 'short' | 'int' | 'long' | 'float' | 'double';
+export declare const LiteralNumberSuffixes: readonly ["b", "s", "l", "f", "d"];
+export declare type LiteralNumberSuffix = typeof LiteralNumberSuffixes[number];
+export declare const LiteralNumberCaseInsensitiveSuffixes: readonly ["b", "s", "l", "f", "d", "B", "S", "L", "F", "D"];
+export declare type LiteralNumberCaseInsensitiveSuffix = typeof LiteralNumberCaseInsensitiveSuffixes[number];
+export interface NumericType extends TypeBase {
+    kind: NumericTypeKind;
     valueRange?: NumericRange;
 }
-interface PrimitiveArrayType extends TypeBase {
+export declare const NumericTypeIntKinds: readonly ["byte", "short", "int", "long"];
+export declare type NumericTypeIntKind = typeof NumericTypeIntKinds[number];
+export declare const NumericTypeFloatKinds: readonly ["float", "double"];
+export declare type NumericTypeFloatKind = typeof NumericTypeFloatKinds[number];
+export declare const NumericTypeKinds: readonly ["byte", "short", "int", "long", "float", "double"];
+export declare type NumericTypeKind = typeof NumericTypeKinds[number];
+export interface PrimitiveArrayType extends TypeBase {
     kind: 'byte_array' | 'int_array' | 'long_array';
     valueRange?: NumericRange;
     lengthRange?: NumericRange;
 }
+export declare const PrimitiveArrayValueKinds: readonly ["byte", "int", "long"];
+export declare type PrimitiveArrayValueKind = typeof PrimitiveArrayValueKinds[number];
+export declare const PrimitiveArrayKinds: readonly ("byte_array" | "int_array" | "long_array")[];
+export declare type PrimitiveArrayKind = typeof PrimitiveArrayKinds[number];
 export interface ListType extends TypeBase {
     kind: 'list';
     item: McdocType;
@@ -130,10 +162,7 @@ declare type NoIndices = {
 };
 export interface FlatStructType extends TypeBase {
     kind: 'flat_struct';
-    fields: Record<string, {
-        type: McdocType;
-        symbol: SymbolPath;
-    }>;
+    fields: Record<string, McdocType>;
 }
 export declare const flattenUnionType: (union: UnionType) => UnionType;
 export declare const unionTypes: (a: McdocType, b: McdocType) => McdocType;

package/lib/type/index.js

@@ -1,29 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveType = exports.checkAssignability = exports.simplifyType = exports.simplifyListType = exports.simplifyUnionType = exports.unionTypes = exports.flattenUnionType = exports.McdocType = exports.createEmptyUnion = exports.EmptyUnion = void 0;
-const core_1 = require("@spyglassmc/core");
-const locales_1 = require("@spyglassmc/locales");
-exports.EmptyUnion = Object.freeze({ kind: 'union', members: [] });
-function createEmptyUnion(attributes) {
+import { Arrayable } from '@spyglassmc/core';
+import { localeQuote, localize } from '@spyglassmc/locales';
+import { getRangeDelimiter } from '../node/index.js';
+export const StaticIndexKeywords = Object.freeze(['fallback', 'none', 'unknown']);
+export const EmptyUnion = Object.freeze({ kind: 'union', members: [] });
+export function createEmptyUnion(attributes) {
     return {
-        ...exports.EmptyUnion,
+        ...EmptyUnion,
         attributes,
     };
 }
-exports.createEmptyUnion = createEmptyUnion;
-var McdocType;
+export const LiteralNumberSuffixes = Object.freeze(['b', 's', 'l', 'f', 'd']);
+export const LiteralNumberCaseInsensitiveSuffixes = Object.freeze([...LiteralNumberSuffixes, 'B', 'S', 'L', 'F', 'D']);
+export const NumericTypeIntKinds = Object.freeze(['byte', 'short', 'int', 'long']);
+export const NumericTypeFloatKinds = Object.freeze(['float', 'double']);
+export const NumericTypeKinds = Object.freeze([...NumericTypeIntKinds, ...NumericTypeFloatKinds]);
+export const PrimitiveArrayValueKinds = Object.freeze(['byte', 'int', 'long']);
+export const PrimitiveArrayKinds = Object.freeze(PrimitiveArrayValueKinds.map(kind => `${kind}_array`));
+export var McdocType;
 (function (McdocType) {
     function toString(type) {
         const rangeToString = (range) => {
             if (!range) {
                 return '';
             }
-            const [min, max] = range;
-            return min === max ? ` @ ${min}` : ` @ ${min ?? ''}..${max ?? ''}`;
+            const { kind, min, max } = range;
+            return min === max ? ` @ ${min}` : ` @ ${min ?? ''}${getRangeDelimiter(kind)}${max ?? ''}`;
         };
         const indicesToString = (indices) => {
             const strings = [];
-            for (const index of core_1.Arrayable.toArray(indices)) {
+            for (const index of Arrayable.toArray(indices)) {
                 if (index === undefined) {
                     strings.push('()');
                 }
@@ -67,7 +72,7 @@ var McdocType;
             case 'long_array':
                 return `long${rangeToString(type.valueRange)}[]${rangeToString(type.lengthRange)}`;
             case 'reference':
-                return type.symbol?.path.join('::') ?? '<unknown_reference>';
+                return type.path ?? '<unknown_reference>';
             case 'short':
                 return `short${rangeToString(type.valueRange)}`;
             case 'string':
@@ -81,7 +86,7 @@ var McdocType;
         }
     }
     McdocType.toString = toString;
-})(McdocType = exports.McdocType || (exports.McdocType = {}));
+})(McdocType || (McdocType = {}));
 var CheckResult;
 (function (CheckResult) {
     CheckResult[CheckResult["Nah"] = 0] = "Nah";
@@ -95,12 +100,12 @@ const areRangesMatch = (s, t) => {
     if (!s) {
         return false;
     }
-    const [sMin, sMax] = s;
-    const [tMin, tMax] = t;
+    const { min: sMin, max: sMax } = s;
+    const { min: tMin, max: tMax } = t;
     return (tMin === undefined || (sMin !== undefined && sMin >= tMin)) &&
         (tMax === undefined || (sMax !== undefined && sMax <= tMax));
 };
-const flattenUnionType = (union) => {
+export const flattenUnionType = (union) => {
     const set = new Set();
     const add = (data) => {
         for (const existingMember of set) {
@@ -115,7 +120,7 @@ const flattenUnionType = (union) => {
     };
     for (const member of union.members) {
         if (member.kind === 'union') {
-            (0, exports.flattenUnionType)(member).members.forEach(add);
+            flattenUnionType(member).members.forEach(add);
         }
         else {
             add(member);
@@ -126,8 +131,7 @@ const flattenUnionType = (union) => {
         members: [...set],
     };
 };
-exports.flattenUnionType = flattenUnionType;
-const unionTypes = (a, b) => {
+export const unionTypes = (a, b) => {
     if ((check(a, b) & CheckResult.StrictlyAssignable) === CheckResult.StrictlyAssignable) {
         return b;
     }
@@ -143,37 +147,33 @@ const unionTypes = (a, b) => {
     };
     return ans;
 };
-exports.unionTypes = unionTypes;
-const simplifyUnionType = (union) => {
-    union = (0, exports.flattenUnionType)(union);
+export const simplifyUnionType = (union) => {
+    union = flattenUnionType(union);
     if (union.members.length === 1) {
         return union.members[0];
     }
     return union;
 };
-exports.simplifyUnionType = simplifyUnionType;
-const simplifyListType = (list) => ({
+export const simplifyListType = (list) => ({
     kind: 'list',
-    item: (0, exports.simplifyType)(list.item),
-    ...list.lengthRange ? { lengthRange: [...list.lengthRange] } : {},
+    item: simplifyType(list.item),
+    ...list.lengthRange ? { lengthRange: { ...list.lengthRange } } : {},
 });
-exports.simplifyListType = simplifyListType;
-const simplifyType = (data) => {
+export const simplifyType = (data) => {
     if (data.kind === 'union') {
-        data = (0, exports.simplifyUnionType)(data);
+        data = simplifyUnionType(data);
     }
     else if (data.kind === 'list') {
-        data = (0, exports.simplifyListType)(data);
+        data = simplifyListType(data);
     }
     return data;
 };
-exports.simplifyType = simplifyType;
 const check = (s, t, errors = []) => {
     const strictlyAssignableIfTrue = (value) => value ? CheckResult.StrictlyAssignable : CheckResult.Nah;
     const assignableIfTrue = (value) => value ? CheckResult.Assignable : CheckResult.Nah;
     let ans;
-    s = (0, exports.simplifyType)(s);
-    t = (0, exports.simplifyType)(t);
+    s = simplifyType(s);
+    t = simplifyType(t);
     if (s.kind === 'any' || s.kind === 'reference' || t.kind === 'reference') {
         // Reference types are treated as any for now.
         ans = CheckResult.Assignable;
@@ -192,7 +192,7 @@ const check = (s, t, errors = []) => {
     }
     else if (s.kind === 'byte') {
         if (t.kind === 'boolean') {
-            ans = check(s, { kind: 'byte', valueRange: [0, 1] }, errors);
+            ans = check(s, { kind: 'byte', valueRange: { kind: 0b00, min: 0, max: 1 } }, errors);
         }
         else if (t.kind === 'byte') {
             ans = strictlyAssignableIfTrue(areRangesMatch(s.valueRange, t.valueRange));
@@ -244,11 +244,11 @@ const check = (s, t, errors = []) => {
         ans = CheckResult.Nah;
     }
     if (!ans) {
-        errors.push((0, locales_1.localize)('mcdoc.checker.type-not-assignable', (0, locales_1.localeQuote)(McdocType.toString(s)), (0, locales_1.localeQuote)(McdocType.toString(t))));
+        errors.push(localize('mcdoc.checker.type-not-assignable', localeQuote(McdocType.toString(s)), localeQuote(McdocType.toString(t))));
     }
     return ans;
 };
-const checkAssignability = ({ source, target }) => {
+export const checkAssignability = ({ source, target }) => {
     if (source === undefined || target === undefined) {
         return { isAssignable: true };
     }
@@ -259,8 +259,7 @@ const checkAssignability = ({ source, target }) => {
         ...errors.length ? { errorMessage: errors.reverse().map((m, i) => `${'  '.repeat(i)}${m}`).join('\n') } : {},
     };
 };
-exports.checkAssignability = checkAssignability;
-function resolveType(inputType, ctx, value) {
+export function resolveType(inputType, ctx, value) {
     const type = getTangibleType(inputType, ctx, value);
     let ans = (() => {
         if (type.kind === 'union') {
@@ -282,7 +281,6 @@ function resolveType(inputType, ctx, value) {
     }
     return ans;
 }
-exports.resolveType = resolveType;
 function dispatchType(type, ctx) {
     throw '// TODO';
 }
@@ -328,7 +326,7 @@ function navigateIndex(type, index, ctx, value) {
             return createEmptyUnion(type.attributes);
         }
         const flatStruct = flattenStruct(type, ctx, value);
-        return resolveType(flatStruct.fields[key].type, ctx, value);
+        return resolveType(flatStruct.fields[key], ctx, value);
     }
     else if (type.kind === 'union') {
         return mapUnion(type, t => navigateIndex(t, index, ctx, value));
@@ -382,14 +380,19 @@ function flattenStruct(type, ctx, value) {
             }
         }
         else {
-            ans.fields[field.key] = { type: field.type, symbol: field.symbol };
+            if (typeof field.key === 'string') {
+                ans.fields[field.key] = field.type;
+            }
+            else {
+                // TODO: Handle map keys
+            }
         }
     }
     return ans;
 }
 function addAttributes(type, ...attributes) {
     for (const attr of attributes) {
-        type.attributes ?? (type.attributes = []);
+        type.attributes ??= [];
         if (!type.attributes.some(a => a.name === attr.name)) {
             type.attributes.push(attr);
         }

package/lib/uri_processors.d.ts

@@ -0,0 +1,4 @@
+import type { UriBinder, UriSorterRegistration } from '@spyglassmc/core';
+export declare const uriBinder: UriBinder;
+export declare const uriSorter: UriSorterRegistration;
+//# sourceMappingURL=uri_processors.d.ts.map

package/lib/{binder/uriBinder.js → uri_processors.js}

@@ -1,17 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uriBinder = void 0;
-const core_1 = require("@spyglassmc/core");
-const util_1 = require("./util");
+import { fileUtil } from '@spyglassmc/core';
+import { segToIdentifier } from './common.js';
 const Extension = '.mcdoc';
 const McdocRootPrefix = 'mcdoc/';
-const uriBinder = (uris, ctx) => {
+export const uriBinder = (uris, ctx) => {
     let urisAndRels = [];
     for (const uri of uris) {
         if (!uri.endsWith(Extension)) {
             continue;
         }
-        let rel = core_1.fileUtil.getRel(uri, ctx.roots);
+        let rel = fileUtil.getRel(uri, ctx.roots);
         if (!rel) {
             continue;
         }
@@ -34,17 +31,23 @@ const uriBinder = (uris, ctx) => {
     // file:///root/mcdoc/foo/bar.mcdoc -> foo/bar
     for (const [uri, rel] of urisAndRels) {
         ctx.symbols
-            .query(uri, 'mcdoc', (0, util_1.segToIdentifier)(rel.split('/')))
+            .query(uri, 'mcdoc', segToIdentifier(rel.split('/')))
             .ifKnown(() => { })
             .elseEnter({
-            data: {
-                subcategory: 'module',
-            },
-            usage: {
-                type: 'implementation',
-            },
+            data: { subcategory: 'module' },
+            usage: { type: 'definition' },
         });
     }
 };
-exports.uriBinder = uriBinder;
-//# sourceMappingURL=uriBinder.js.map
+export const uriSorter = (a, b, next) => {
+    if (a.endsWith(Extension) && !b.endsWith(Extension)) {
+        return -1;
+    }
+    else if (!a.endsWith(Extension) && b.endsWith(Extension)) {
+        return 1;
+    }
+    else {
+        return next(a, b);
+    }
+};
+//# sourceMappingURL=uri_processors.js.map

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@spyglassmc/mcdoc",
-  "version": "0.1.1",
+  "version": "0.3.1",
+  "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "author": "SPGoding",
@@ -24,7 +25,7 @@
     "url": "https://github.com/SpyglassMC/Spyglass/issues"
   },
   "dependencies": {
-    "@spyglassmc/core": "0.1.2",
-    "@spyglassmc/locales": "0.1.2"
+    "@spyglassmc/core": "0.4.0",
+    "@spyglassmc/locales": "0.3.0"
   }
 }

package/lib/binder/uriBinder.d.ts

@@ -1,3 +0,0 @@
-import type { UriBinder } from '@spyglassmc/core';
-export declare const uriBinder: UriBinder;
-//# sourceMappingURL=uriBinder.d.ts.map

package/lib/binder/util.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.segToIdentifier = exports.identifierToSeg = void 0;
-function identifierToSeg(identifier) {
-    const ans = identifier.slice(2).split('::');
-    if (ans.length === 1 && ans[0] === '') {
-        return [];
-    }
-    return ans;
-}
-exports.identifierToSeg = identifierToSeg;
-function segToIdentifier(seg) {
-    return `::${seg.join('::')}`;
-}
-exports.segToIdentifier = segToIdentifier;
-//# sourceMappingURL=util.js.map

package/lib/checker/CheckerContext.d.ts

@@ -1,18 +0,0 @@
-import type * as core from '@spyglassmc/core';
-import type { Symbol } from '@spyglassmc/core';
-import type { Segments } from '../binder';
-export interface CheckerContext extends core.CheckerContext {
-    /**
-     * The current module's identifier.
-     */
-    modIdentifier: string;
-    /**
-     * The current module's segments.
-     */
-    modSeg: Segments;
-    /**
-     * The current module's symbol.
-     */
-    modSymbol: Symbol;
-}
-//# sourceMappingURL=CheckerContext.d.ts.map

package/lib/checker/CheckerContext.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CheckerContext.js.map

package/lib/checker/entry.d.ts

@@ -1,4 +0,0 @@
-import type { Checker } from '@spyglassmc/core';
-import type { ModuleNode } from '../node';
-export declare const module_: Checker<ModuleNode>;
-//# sourceMappingURL=entry.d.ts.map