@minecraft/api-docs-generator 1.0.0

package/lib/filters/CommandFilters.js

@@ -0,0 +1,171 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandMarkupFilter = void 0;
+const commandTypeNameMappings = {
+    val: 'float',
+    rval: 'rotation',
+    id: 'string',
+    selection: 'target',
+    wildcardselection: 'targets',
+    wildcardint: 'wildcard int',
+    position_float: 'position',
+    slashcommand: 'command',
+    block_state_array: 'block properties',
+    pathcommand: 'filepath',
+    json_object: 'json',
+    message_root: 'message',
+    postfix_t: 'time',
+    postfix_s: 'time',
+    postfix_d: 'time',
+    postfix_l: 'int',
+    rawtext: 'text',
+};
+const commandTypeSyntaxMappings = {
+    position: 'x y z',
+    position_float: 'x y z',
+};
+function convertCommandPermissionLevelsToName(moduleJson) {
+    const convertPermissionLevel = (permissionLevel) => {
+        switch (permissionLevel) {
+            default:
+            case 0:
+                return 'Any';
+            case 1:
+                return 'Game Directors';
+            case 2:
+                return 'Admin';
+            case 3:
+                return 'Host';
+            case 4:
+                return 'Owner';
+            case 5:
+                return 'Internal';
+        }
+    };
+    moduleJson.commands.forEach(commandJson => (commandJson.permission_level_name = convertPermissionLevel(commandJson.permission_level)));
+}
+/**
+ * Creates lists of commands that reference an enum at the enum level.
+ */
+function formatCommandEnums(moduleJson) {
+    moduleJson.command_enums.forEach(enumJson => {
+        if (enumJson.command_references === undefined) {
+            enumJson.command_references = [];
+        }
+        const addCommandReference = (commandJson, commandIndex) => {
+            for (const overloadJson of commandJson.overloads) {
+                for (const paramJson of overloadJson.params) {
+                    if (paramJson.type.name.toLowerCase() === enumJson.name.toLowerCase()) {
+                        enumJson.command_references.push({
+                            command_name: commandJson.name,
+                            command_index: commandIndex,
+                        });
+                        return;
+                    }
+                }
+            }
+        };
+        for (let i = 0; i < moduleJson.commands.length; ++i) {
+            const commandJson = moduleJson.commands[i];
+            addCommandReference(commandJson, i);
+            if (commandJson.command_enums === undefined) {
+                commandJson.command_enums = [];
+            }
+        }
+        if (enumJson.command_references.length === 1) {
+            enumJson.enum_name = enumJson.name;
+            const commandJson = moduleJson.commands[enumJson.command_references[0].command_index];
+            commandJson.command_enums.push(enumJson);
+        }
+    });
+}
+/**
+ * Creates a list of unique types used in command overload arguments at the module level.
+ */
+function formatCommandArgumentTypes(moduleJson) {
+    const commandTypes = new Map();
+    for (const commandJson of moduleJson.commands ?? []) {
+        for (const overloadJson of commandJson.overloads ?? []) {
+            for (const paramJson of overloadJson.params) {
+                const typeJson = paramJson.type;
+                typeJson.name = typeJson.name.toLowerCase();
+                for (const enumJson of moduleJson.command_enums ?? []) {
+                    if (typeJson.name === enumJson.name.toLowerCase()) {
+                        typeJson.name = enumJson.name;
+                        typeJson.is_enum = true;
+                        if (enumJson.command_references.length > 1) {
+                            typeJson.has_link = true;
+                        }
+                        if (enumJson.values.length === 1) {
+                            typeJson.is_keyword = true;
+                            typeJson.keyword_name = enumJson.values[0].value;
+                        }
+                        break;
+                    }
+                }
+                if (!typeJson.is_enum) {
+                    const mappedTypeName = commandTypeNameMappings[typeJson.name];
+                    if (mappedTypeName) {
+                        typeJson.name = mappedTypeName;
+                    }
+                    const mappedTypeSyntax = commandTypeSyntaxMappings[typeJson.name];
+                    if (mappedTypeSyntax) {
+                        typeJson.syntax = mappedTypeSyntax;
+                    }
+                    if (!commandTypes.has(typeJson.name)) {
+                        commandTypes.set(typeJson.name, typeJson);
+                    }
+                }
+            }
+        }
+    }
+    moduleJson.command_types = Array.from(commandTypes.values());
+}
+/**
+ * Create lists of unique arguments used across overloads at the command level.
+ */
+function formatCommandArguments(moduleJson) {
+    for (const commandJson of moduleJson.commands) {
+        let commandArguments = [];
+        commandJson.overloads.forEach(overloadJson => (commandArguments = commandArguments.concat(overloadJson.params)));
+        for (const paramJson of commandArguments) {
+            let count = 0;
+            for (const other of commandArguments) {
+                if (other.name === paramJson.name && other.type.name !== paramJson.type.name) {
+                    ++count;
+                }
+            }
+            const sanitizedName = (paramJson.type.keyword_name ?? paramJson.name).replace(/[^a-zA-Z0-9]/g, '');
+            const typeSuffix = count > 0 ? `-${paramJson.type.name}` : '';
+            paramJson.directory_name = `${sanitizedName}${typeSuffix}`;
+        }
+        const uniqueArguments = Array.from(new Map(commandArguments.map(p => [p.directory_name, p])).values());
+        commandJson.arguments = uniqueArguments.filter(p => !p.type.is_keyword || p.is_optional);
+    }
+}
+/**
+ * Cleanup enums that don't need their own pages.
+ */
+function cleanupUnusedEnums(moduleJson) {
+    moduleJson.command_enums = moduleJson.command_enums.filter(enumJson => enumJson.values.length > 1 && enumJson.command_references.length > 1);
+    moduleJson.commands.forEach(commandJson => {
+        commandJson.command_enums = commandJson.command_enums.filter(enumJson => enumJson.values.length > 1);
+    });
+}
+exports.CommandMarkupFilter = [
+    'command_markup',
+    (releases) => {
+        for (const release of releases) {
+            for (const moduleJson of release.command_modules) {
+                convertCommandPermissionLevelsToName(moduleJson);
+                formatCommandEnums(moduleJson);
+                formatCommandArgumentTypes(moduleJson);
+                formatCommandArguments(moduleJson);
+                cleanupUnusedEnums(moduleJson);
+            }
+        }
+    },
+];
+//# sourceMappingURL=CommandFilters.js.map

package/lib/filters/CommandFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandFilters.js","sourceRoot":"","sources":["../../src/filters/CommandFilters.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAWlC,MAAM,uBAAuB,GAA2B;IACpD,GAAG,EAAE,OAAO;IACZ,IAAI,EAAE,UAAU;IAChB,EAAE,EAAE,QAAQ;IACZ,SAAS,EAAE,QAAQ;IACnB,iBAAiB,EAAE,SAAS;IAC5B,WAAW,EAAE,cAAc;IAC3B,cAAc,EAAE,UAAU;IAC1B,YAAY,EAAE,SAAS;IACvB,iBAAiB,EAAE,kBAAkB;IACrC,WAAW,EAAE,UAAU;IACvB,WAAW,EAAE,MAAM;IACnB,YAAY,EAAE,SAAS;IACvB,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,KAAK;IAChB,OAAO,EAAE,MAAM;CAClB,CAAC;AAEF,MAAM,yBAAyB,GAA2B;IACtD,QAAQ,EAAE,OAAO;IACjB,cAAc,EAAE,OAAO;CAC1B,CAAC;AAEF,SAAS,oCAAoC,CAAC,UAAkC;IAC5E,MAAM,sBAAsB,GAAG,CAAC,eAAuB,EAAE,EAAE;QACvD,QAAQ,eAAe,EAAE,CAAC;YACtB,QAAQ;YACR,KAAK,CAAC;gBACF,OAAO,KAAK,CAAC;YACjB,KAAK,CAAC;gBACF,OAAO,gBAAgB,CAAC;YAC5B,KAAK,CAAC;gBACF,OAAO,OAAO,CAAC;YACnB,KAAK,CAAC;gBACF,OAAO,MAAM,CAAC;YAClB,KAAK,CAAC;gBACF,OAAO,OAAO,CAAC;YACnB,KAAK,CAAC;gBACF,OAAO,UAAU,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC;IAEF,UAAU,CAAC,QAAQ,CAAC,OAAO,CACvB,WAAW,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAC5G,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,UAAkC;IAC1D,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxC,IAAI,QAAQ,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAC5C,QAAQ,CAAC,kBAAkB,GAAG,EAAE,CAAC;QACrC,CAAC;QACD,MAAM,mBAAmB,GAAG,CAAC,WAA6B,EAAE,YAAoB,EAAE,EAAE;YAChF,KAAK,MAAM,YAAY,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;gBAC/C,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;oBAC1C,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;wBACpE,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC;4BAC7B,YAAY,EAAE,WAAW,CAAC,IAAI;4BAC9B,aAAa,EAAE,YAAY;yBAC9B,CAAC,CAAC;wBACH,OAAO;oBACX,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC,CAAC;QACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAClD,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3C,mBAAmB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACpC,IAAI,WAAW,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC1C,WAAW,CAAC,aAAa,GAAG,EAAE,CAAC;YACnC,CAAC;QACL,CAAC;QACD,IAAI,QAAQ,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC;YACnC,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YACtF,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CAAC,UAAkC;IAClE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAwC,CAAC;IACrE,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAClD,KAAK,MAAM,YAAY,IAAI,WAAW,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YACrD,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC;gBAChC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC5C,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC;oBACpD,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;wBAChD,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;wBAE9B,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;wBACxB,IAAI,QAAQ,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BACzC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;wBAC7B,CAAC;wBACD,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BAC/B,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;4BAC3B,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACrD,CAAC;wBACD,MAAM;oBACV,CAAC;gBACL,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACpB,MAAM,cAAc,GAAG,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAC9D,IAAI,cAAc,EAAE,CAAC;wBACjB,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC;oBACnC,CAAC;oBACD,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAClE,IAAI,gBAAgB,EAAE,CAAC;wBACnB,QAAQ,CAAC,MAAM,GAAG,gBAAgB,CAAC;oBACvC,CAAC;oBACD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBACnC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAC9C,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IACD,UAAU,CAAC,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,UAAkC;IAC9D,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC5C,IAAI,gBAAgB,GAA+B,EAAE,CAAC;QACtD,WAAW,CAAC,SAAS,CAAC,OAAO,CACzB,YAAY,CAAC,EAAE,CAAC,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CACpF,CAAC;QACF,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;YACvC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;gBACnC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC3E,EAAE,KAAK,CAAC;gBACZ,CAAC;YACL,CAAC;YACD,MAAM,aAAa,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACnG,MAAM,UAAU,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,SAAS,CAAC,cAAc,GAAG,GAAG,aAAa,GAAG,UAAU,EAAE,CAAC;QAC/D,CAAC;QACD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACvG,WAAW,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC;IAC7F,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,UAAkC;IAC1D,UAAU,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC,MAAM,CACtD,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CACnF,CAAC;IACF,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACtC,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;AACP,CAAC;AAEY,QAAA,mBAAmB,GAAW;IACvC,gBAAgB;IAChB,CAAC,QAA4B,EAAQ,EAAE;QACnC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC/C,oCAAoC,CAAC,UAAU,CAAC,CAAC;gBACjD,kBAAkB,CAAC,UAAU,CAAC,CAAC;gBAC/B,0BAA0B,CAAC,UAAU,CAAC,CAAC;gBACvC,sBAAsB,CAAC,UAAU,CAAC,CAAC;gBACnC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAC"}

package/lib/filters/CommonFilters.d.ts

@@ -0,0 +1,2 @@
+import { FilterGroup } from './Filters';
+export declare const CommonFilters: FilterGroup;