Update from_module to use the base module if it is a dependency (#80)

Author: SBLMikeDemone

change/@minecraft-api-docs-generator-e45942de-5bc2-4e70-99b1-d52618d2bf08.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Set all APIs from_module to the from_module's base module and all dependencies to the dependency's base module.",
+  "packageName": "@minecraft/api-docs-generator",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

tools/api-docs-generator-test-snapshots/test/only_generate_latest_versions/__snapshots__/onlyGenerateLatestVersions.spec.ts.snap

@@ -58,34 +58,19 @@ exports[`Only Generate Latest Script Module Versions > Generates correct output
   },
   {
     "version": "1.1.0",
-    "dependencies": [],
-    "peer_dependencies": [],
-    "classes": [],
-    "interfaces": [],
-    "errors": [],
-    "objects": [],
-    "functions": [],
+    "$added": true,
     "constants": [
       {
-        "name": "GlobalConstantV110",
-        "$added": true,
         "is_read_only": true,
         "is_static": true,
+        "name": "GlobalConstantV110",
         "type": {
           "is_bind_type": false,
           "is_errorable": false,
           "name": "int32"
         },
         "value": 8
-      }
-    ],
-    "enums": [],
-    "type_aliases": []
-  },
-  {
-    "version": "1.0.0",
-    "$added": true,
-    "constants": [
+      },
       {
         "is_read_only": true,
         "is_static": true,
@@ -186,15 +171,12 @@ description: Changelog of the \`test-module\` module
 - [2.1.0-beta](#210-beta)
 - [2.0.0](#200)
 - [1.1.0](#110)
-- [1.0.0](#100)
 
 ## 2.1.0-beta
 #### Added constant \`GlobalConstantV210Beta\`
 ## 2.0.0
 #### Added constant \`GlobalConstantV200\`
 ## 1.1.0
-#### Added constant \`GlobalConstantV110\`
-## 1.0.0
 #### Added \`test-module\` Module
 "
 `;
@@ -282,9 +264,6 @@ exports[`Only Generate Latest Script Module Versions > Generates correct output
 - Added constant \`GlobalConstantV200\`
 
 === 1.1.0 ===
-- Added constant \`GlobalConstantV110\`
-
-=== 1.0.0 ===
 - Added \`test-module\` module
 
 == /Change Log =="

tools/api-docs-generator/src/filters/CommonFilters.ts

@@ -52,6 +52,7 @@ import {
     MinecraftError,
     MinecraftFunction,
     MinecraftInterface,
+    MinecraftModuleDependency,
     MinecraftModuleDescription,
     MinecraftObject,
     MinecraftProperty,
@@ -3255,15 +3256,54 @@ function addRuntimeConditionsFlag(releases: MinecraftRelease[]) {
     }
 }
 
+function upgradeFromModuleToBaseModule(releases: MinecraftRelease[]) {
+    for (const release of releases) {
+        const scriptModules = getLatestScriptModules(release.script_modules);
+        const uuidToLatestBase = Object.fromEntries(
+            scriptModules.map(m => {
+                if (!m.base_module) {
+                    return [m.uuid, undefined];
+                }
+                return [m.uuid, scriptModules.find(m1 => m1.name === m.base_module.name)];
+            })
+        );
+        for (const scriptModule of release.script_modules) {
+            utils.scanObjectForMemberWithName(
+                scriptModule,
+                'from_module',
+                (jsonObject: Record<string, MinecraftModuleDescription>) => {
+                    if (jsonObject.from_module.uuid === scriptModule.uuid) {
+                        return;
+                    }
+                    if (uuidToLatestBase[jsonObject.from_module.uuid]) {
+                        const base = uuidToLatestBase[jsonObject.from_module.uuid];
+                        const dependencies: MinecraftModuleDependency[] = scriptModule.dependencies.concat(
+                            scriptModule.peer_dependencies ?? []
+                        );
+
+                        if (dependencies.every(d => d.uuid !== base.uuid)) {
+                            // Only change dependency if we rely on base module
+                            return;
+                        }
+                        jsonObject.from_module.name = base.name;
+                        jsonObject.from_module.uuid = base.uuid;
+                    }
+                }
+            );
+        }
+    }
+}
+
 export const CommonFilters: FilterGroup = {
     id: 'common',
     filters: [
         ['mark_prerelease_modules', markModulesWithPrerelease], // No dependencies
         ['default_module_categories', defaultModuleCategories], // No dependencies
         ['link_derived_types', linkDerivedTypes], // No dependencies
+        ['upgrade_from_module_to_base', upgradeFromModuleToBaseModule], // No dependencies
         ['add_from_module_to_root', addFromModuleToRoot], // No dependencies
         ['external_module_flag', fromExternalModule], // Depends on link_derived_types, add_from_module_to_root
-        ['add_from_module_to_dependencies', addFromModuleToDependencies], // No dependencies
+        ['add_from_module_to_dependencies', addFromModuleToDependencies], // Run after upgrade_from_module_to_base for perf
         ['set_from_module_to_dependent_modules', setFromModuleToDependentModules], // No dependencies
         ['markup_latest_modules', markupLatestModules], // Depends on add_from_module_to_root, add_from_module_to_dependencies, set_from_module_to_dependent_modules
         ['markup_names', markupNames], // Depends on add_from_module_to_dependencies, markup_latest_modules

tools/api-docs-generator/src/generator.ts

@@ -173,10 +173,10 @@ function mergeScriptModule(base: MinecraftScriptModule, parent: MinecraftScriptM
 /**
  * Merges each script module that specifies a 'parentModule' with it's parent, returning the list of all modules after merging.
  *
- * If 'includeParentModules' is true, parent modules will be generated on their own in addition to the merged modules.
+ * If 'includeBaseModules' is true, base modules will be generated on their own in addition to the merged modules.
  */
-function getMergedScriptModules(
-    context: GeneratorContext,
+export function getMergedScriptModules(
+    includeBaseModules: boolean,
     scriptModules: MinecraftScriptModule[]
 ): MinecraftScriptModule[] {
     const standardModules = new Map<string, MinecraftScriptModule>();
@@ -221,8 +221,13 @@ function getMergedScriptModules(
             `Merging parent module '${parentName}@${parentVersion}' into '${moduleToParent.name}@${moduleToParent.version}'.`
         );
         const mergedModule = mergeScriptModule(moduleToParent, parent);
+        mergedModule.parentModule = moduleToParent.parentModule;
+        parent.base_module = {
+            name: moduleToParent.name,
+            version: moduleToParent.version,
+        };
 
-        if (!context.includeBaseModules) {
+        if (!includeBaseModules) {
             standardModules.delete(`${parentName}_${parentVersion}_${minecraftVersion}`);
         }
 
@@ -352,7 +357,7 @@ function loadMinecraftReleases(context: GeneratorContext): MinecraftReleasesByVe
 
     const scriptModulesToProcess = context.skipMerging
         ? allScriptModules
-        : getMergedScriptModules(context, allScriptModules);
+        : getMergedScriptModules(context.includeBaseModules, allScriptModules);
 
     for (const scriptModule of scriptModulesToProcess) {
         const moduleMinecraftVersion = scriptModule.minecraft_version;
@@ -607,13 +612,13 @@ export async function generate(options: GenerateOptions) {
         utils.reverseSemVerSortComparer('minecraft_version')
     );
 
+    filterIncludedModules(context, sortedMinecraftReleases);
+
     if (context.changelogStrategy.shouldGenerateChangelogs(sortedMinecraftReleases)) {
         const changelogGenerator = new ChangelogGenerator(context.changelogStrategy);
         changelogGenerator.generateChangelogs(sortedMinecraftReleases);
     }
 
-    filterIncludedModules(context, sortedMinecraftReleases);
-
     const filteredMinecraftReleases = markupFilters(context, sortedMinecraftReleases);
 
     await generateMarkupFiles(context, filteredMinecraftReleases, sortedMinecraftReleases);

tools/api-docs-generator/src/modules/MinecraftScriptModule.ts

@@ -552,6 +552,7 @@ export const MinecraftScriptModuleRecord = Intersect(
         module_type: Literal('script'),
         uuid: String,
         parentModule: Optional(Union(String, MinecraftParentModuleRecord).Or(Null)),
+        base_module: Optional(MinecraftParentModuleRecord),
         dependencies: Optional(Array(MinecraftModuleDependencyRecord).Or(Null)),
         peer_dependencies: Optional(Array(MinecraftModuleDependencyRecord).Or(Null)),
     }),