@minecraft/api-docs-generator 1.0.0

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@minecraft/api-docs-generator",
+  "entries": [
+    {
+      "date": "Thu, 26 Jun 2025 22:33:07 GMT",
+      "version": "1.0.0",
+      "tag": "@minecraft/api-docs-generator_v1.0.0",
+      "comments": {
+        "major": [
+          {
+            "author": "zachary.campbell@skyboxlabs.com",
+            "package": "@minecraft/api-docs-generator",
+            "commit": "6dbbce7231a4daceb4ddbba5681891de7fc481e7",
+            "comment": "Add api-docs-generator and markup-generators-plugin"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @minecraft/api-docs-generator
+
+<!-- This log was last generated on Thu, 26 Jun 2025 22:33:07 GMT and should not be manually modified. -->
+
+<!-- Start content -->
+
+## 1.0.0
+
+Thu, 26 Jun 2025 22:33:07 GMT
+
+### Major changes
+
+- Add api-docs-generator and markup-generators-plugin (zachary.campbell@skyboxlabs.com)

package/README.md

@@ -0,0 +1,92 @@
+# @minecraft/api-docs-generator
+
+This package ingests [Minecraft API module metadata](https://github.com/Mojang/bedrock-samples/tree/main/metadata) and outputs various generated files such as documentation, TypeScript `.d.ts` files, and more. Requires usage of a markup generator plugin to provide output configurations, such as [@minecraft/markup-generators-plugin](../markup-generators-plugin/README.md) or a custom defined plugin.
+
+## Installation
+
+- Install [NPM/Node](https://www.npmjs.com/) version 22.x or above.
+- Clone this repository.
+- Install dependencies: `npm install`
+- Build the repository: `npm run build`
+
+## CLI Usage
+
+Usage: `minecraft-api-docs-generator [options]`
+
+Options:
+
+```
+  -i, --input-directory           Directory of the API metadata JSON input files.
+  -o, --output-directory          Directory to output generated types and documentation to.
+  -d, --docs-directory            Directory of the documentation info.JSON files that provide description strings for API modules.
+  -g, --run-generators            IDs of markup generators to render output files with.
+
+  -m, --include-modules           Mode which determines which input modules should be included in generation.
+  -b, --include-base              If set, will include base modules in generation for metadata that would be merged to a parent module.
+      --changelog-strategy        String ID of the changelog strategy to use when comparing modules.
+
+  -p, --plugin                    Plugin packages to import generators and templates from.
+  -c, --config                    Path to a config file with options.
+      --no-config                 If set, will not look for any config files.
+
+  -l, --log                       Logging options.
+  -s, --suppress                  Suppresses all output except for errors
+
+      --version                   Show version number
+  -h, --help                      Show help
+```
+
+### Example
+
+```
+minecraft-api-docs-generator -i ./input -o ./out -d ./docs -g msdocs ts
+```
+
+### Markup Generators
+
+The `run-generators` argument requires the ID of a markup generator defined in a plugin package imported via the `plugin` argument or in the config file.
+
+Multiple markup generators can be ran in the same instance by supplying multiple IDs, e.g.: `--run-generators msdocs ts`
+
+By default, `@minecraft/api-docs-generator` will assume you have imported `@minecraft/markup-generators-plugin` if no other plugins are defined via CLI or config options. See the `markup-generators-plugin` [README](../markup-generators-plugin/README.md) for more info.
+
+### Plugins
+
+The `plugin` argument allows importing additional markup generators from external plugin packages. See [ARCHITECTURE](./ARCHITECTURE.md#plugins) for more info on creating and using external plugins for custom functionality.
+
+## Generating API Types
+
+To generate API types using the most recent type metadata:
+
+1. Use NPM to globally install both api-docs-generator and the markup generators plugin: `npm install -g @minecraft/api-docs-generator @minecraft/markup-generators-plugin`
+2. Clone the [bedrock-samples](https://github.com/Mojang/bedrock-samples/tree/main/metadata) repository.
+3. Run the generator using `bedrock-samples\metadata` as the input directory. e.g.:
+
+```
+minecraft-api-docs-generator -i C:\bedrock-samples\metadata -o .\out
+```
+
+## Development
+
+`npm run build` compiles `@minecraft/api-doc-generator` TS definitions and JS files into `lib`.
+
+`npm run lint` runs ESLint and Prettier on project TS source files. `npm run lint:fix` attempts to fix Prettier issues.
+
+`npm run test` runs a suite of tests. `npm run test:update` updates the test snapshots. See [Testing](#testing) for more details.
+
+`npm run clean` cleans all build output.
+
+`npm run package` generates an NPM tarball which you can then `npm install` in other NPM packages for local tool usage.
+
+### Debugging
+
+We recommend using Visual Studio Code's [JavaScript Debug Terminal](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_javascript-debug-terminal) for debugging purposes.
+
+## Testing
+
+This package is validated with a series of vitest snapshot tests that validate generated markup for specific scenarios. When making changes to the generator, please add new scenarios or update the existing scenarios.
+
+Snapshot tests will fail if the number of files generated or the contents of the files change. If snapshot changes are expected, you can update them by running: `npm run test:update`
+
+It is possible to run specific tests using `npm run test -- -- --test <name>`, where `<name>` is a pattern matching `.test.ts`/`.spec.ts`file names. Running this in the JavaScript Debug Terminal allows for debugging specific tests (see above).
+

package/lib/ChangelogStrategy.d.ts

@@ -0,0 +1,39 @@
+import { MinecraftRelease } from './MinecraftRelease';
+import { IMinecraftModule } from './modules/IMinecraftModule';
+export type ChangelogVersionKey = 'version' | 'minecraft_version';
+export interface ChangelogStrategy {
+    getVersionKey(): ChangelogVersionKey;
+    generateModuleGroupKey(module: IMinecraftModule): string;
+    generateModuleGroups(releases: MinecraftRelease[]): IMinecraftModule[][];
+    shouldGenerateChangelogs(releases: MinecraftRelease[]): boolean;
+}
+/**
+ * Perform no diffing between modules, will not populate 'changelog' fields.
+ */
+export declare class DisabledChangelogStrategy implements ChangelogStrategy {
+    getVersionKey(): 'version';
+    generateModuleGroupKey(): string;
+    generateModuleGroups(): IMinecraftModule[][];
+    shouldGenerateChangelogs(): boolean;
+}
+/**
+ * Buckets modules per module version to compare same module across multiple versions of its self regardless of Minecraft version.
+ *
+ * Only applies to Script modules, other module types are only versioned based on Minecraft version.
+ */
+export declare class ModuleVersionChangelogStrategy implements ChangelogStrategy {
+    getVersionKey(): 'version';
+    generateModuleGroupKey(module: IMinecraftModule): string;
+    generateModuleGroups(releases: MinecraftRelease[]): IMinecraftModule[][];
+    shouldGenerateChangelogs(releases: MinecraftRelease[]): boolean;
+}
+/**
+ * Buckets modules per Minecraft version to compare same module versions across multiple Minecraft releases.
+ */
+export declare class MinecraftVersionChangelogStrategy implements ChangelogStrategy {
+    getVersionKey(): 'minecraft_version';
+    generateModuleGroupKey(module: IMinecraftModule): string;
+    generateModuleGroups(releases: MinecraftRelease[]): IMinecraftModule[][];
+    shouldGenerateChangelogs(releases: MinecraftRelease[]): boolean;
+}
+export declare const CoreChangelogStrategies: [string, ChangelogStrategy][];

package/lib/ChangelogStrategy.js

@@ -0,0 +1,114 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreChangelogStrategies = exports.MinecraftVersionChangelogStrategy = exports.ModuleVersionChangelogStrategy = exports.DisabledChangelogStrategy = void 0;
+const semver_1 = require("semver");
+/**
+ * Perform no diffing between modules, will not populate 'changelog' fields.
+ */
+class DisabledChangelogStrategy {
+    getVersionKey() {
+        return 'version';
+    }
+    generateModuleGroupKey() {
+        return 'na';
+    }
+    generateModuleGroups() {
+        return [];
+    }
+    shouldGenerateChangelogs() {
+        return false;
+    }
+}
+exports.DisabledChangelogStrategy = DisabledChangelogStrategy;
+/**
+ * Buckets modules per module version to compare same module across multiple versions of its self regardless of Minecraft version.
+ *
+ * Only applies to Script modules, other module types are only versioned based on Minecraft version.
+ */
+class ModuleVersionChangelogStrategy {
+    getVersionKey() {
+        return 'version';
+    }
+    generateModuleGroupKey(module) {
+        if (module.module_type !== 'script') {
+            return '';
+        }
+        const scriptModule = module;
+        return `${scriptModule.uuid}`;
+    }
+    generateModuleGroups(releases) {
+        const allModulesByName = {};
+        for (const release of releases) {
+            for (const moduleJson of release.script_modules) {
+                const moduleName = moduleJson.name;
+                if (!allModulesByName[moduleName]) {
+                    allModulesByName[moduleName] = [];
+                }
+                allModulesByName[moduleName].push(moduleJson);
+            }
+        }
+        return Object.values(allModulesByName);
+    }
+    shouldGenerateChangelogs(releases) {
+        for (const release of releases) {
+            const modulesByUUID = {};
+            for (const moduleJson of release.script_modules) {
+                const moduleKey = this.generateModuleGroupKey(moduleJson);
+                if (!modulesByUUID[moduleKey]) {
+                    modulesByUUID[moduleKey] = true;
+                    const prereleaseTag = (0, semver_1.prerelease)(moduleJson.version);
+                    if (prereleaseTag) {
+                        return true;
+                    }
+                }
+                else {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}
+exports.ModuleVersionChangelogStrategy = ModuleVersionChangelogStrategy;
+/**
+ * Buckets modules per Minecraft version to compare same module versions across multiple Minecraft releases.
+ */
+class MinecraftVersionChangelogStrategy {
+    getVersionKey() {
+        return 'minecraft_version';
+    }
+    generateModuleGroupKey(module) {
+        if (module.module_type === 'script') {
+            const scriptModule = module;
+            return `${scriptModule.uuid}_${scriptModule.version}`;
+        }
+        else {
+            return `${module.name}`;
+        }
+    }
+    generateModuleGroups(releases) {
+        const allModulesByUUIDAndVersion = {};
+        for (const release of releases) {
+            for (const moduleJson of release.getAllModules()) {
+                const moduleKey = this.generateModuleGroupKey(moduleJson);
+                if (!allModulesByUUIDAndVersion[moduleKey]) {
+                    allModulesByUUIDAndVersion[moduleKey] = [];
+                }
+                allModulesByUUIDAndVersion[moduleKey].push(moduleJson);
+            }
+        }
+        return Object.values(allModulesByUUIDAndVersion);
+    }
+    shouldGenerateChangelogs(releases) {
+        return releases.length > 1;
+    }
+}
+exports.MinecraftVersionChangelogStrategy = MinecraftVersionChangelogStrategy;
+exports.CoreChangelogStrategies = [
+    ['module_version', new ModuleVersionChangelogStrategy()],
+    ['minecraft_version', new MinecraftVersionChangelogStrategy()],
+    ['disabled', new DisabledChangelogStrategy()],
+];
+//# sourceMappingURL=ChangelogStrategy.js.map

package/lib/ChangelogStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangelogStrategy.js","sourceRoot":"","sources":["../src/ChangelogStrategy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,mCAAoC;AAcpC;;GAEG;AACH,MAAa,yBAAyB;IAClC,aAAa;QACT,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,sBAAsB;QAClB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,oBAAoB;QAChB,OAAO,EAAE,CAAC;IACd,CAAC;IACD,wBAAwB;QACpB,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAbD,8DAaC;AAED;;;;GAIG;AACH,MAAa,8BAA8B;IACvC,aAAa;QACT,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,sBAAsB,CAAC,MAAwB;QAC3C,IAAI,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,YAAY,GAAG,MAA+B,CAAC;QACrD,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC;IAED,oBAAoB,CAAC,QAA4B;QAC7C,MAAM,gBAAgB,GAA0C,EAAE,CAAC;QACnE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC9C,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;gBACnC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;oBAChC,gBAAgB,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;gBACtC,CAAC;gBACD,gBAAgB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC3C,CAAC;IAED,wBAAwB,CAAC,QAA4B;QACjD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,aAAa,GAA4B,EAAE,CAAC;YAClD,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;gBAC1D,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5B,aAAa,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;oBAChC,MAAM,aAAa,GAAG,IAAA,mBAAU,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC;oBACrD,IAAI,aAAa,EAAE,CAAC;wBAChB,OAAO,IAAI,CAAC;oBAChB,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,OAAO,IAAI,CAAC;gBAChB,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AA7CD,wEA6CC;AAED;;GAEG;AACH,MAAa,iCAAiC;IAC1C,aAAa;QACT,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAED,sBAAsB,CAAC,MAAwB;QAC3C,IAAI,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,MAA+B,CAAC;YACrD,OAAO,GAAG,YAAY,CAAC,IAAI,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5B,CAAC;IACL,CAAC;IAED,oBAAoB,CAAC,QAA4B;QAC7C,MAAM,0BAA0B,GAA0C,EAAE,CAAC;QAC7E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;gBAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;gBAC1D,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,CAAC;oBACzC,0BAA0B,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;gBAC/C,CAAC;gBACD,0BAA0B,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IACrD,CAAC;IAED,wBAAwB,CAAC,QAA4B;QACjD,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,CAAC;CACJ;AA/BD,8EA+BC;AAEY,QAAA,uBAAuB,GAAkC;IAClE,CAAC,gBAAgB,EAAE,IAAI,8BAA8B,EAAE,CAAC;IACxD,CAAC,mBAAmB,EAAE,IAAI,iCAAiC,EAAE,CAAC;IAC9D,CAAC,UAAU,EAAE,IAAI,yBAAyB,EAAE,CAAC;CAChD,CAAC"}

package/lib/Config.d.ts

@@ -0,0 +1,76 @@
+import { CosmiconfigResult } from 'cosmiconfig';
+import * as rt from 'runtypes';
+export declare const CONFIG_NAME = "api-docs-generator";
+/**
+ * Helper for finding the config file using cosmiconfig.
+ */
+export declare function findConfig(): Promise<CosmiconfigResult>;
+/**
+ * Helper for type validating config file.
+ */
+export declare function checkConfig(config: Config): Config;
+export declare const PreexistingModuleReleasesRecord: rt.Dictionary<rt.Array<rt.String, false>, string>;
+export type PreexistingModuleReleases = rt.Static<typeof PreexistingModuleReleasesRecord>;
+export declare const IncludeModulesModeUnion: rt.Union<[rt.Literal<"all">, rt.Literal<"latest">]>;
+export type IncludeModulesMode = rt.Static<typeof IncludeModulesModeUnion>;
+declare const PluginOptionsRecord: rt.Intersect<[rt.Record<{
+    path: rt.Optional<rt.String>;
+}, false>, rt.Dictionary<rt.Unknown, string>]>;
+export type PluginOptions = rt.Static<typeof PluginOptionsRecord>;
+declare const PluginConfigRecord: rt.Union<[rt.String, rt.Tuple<[rt.String, rt.Intersect<[rt.Record<{
+    path: rt.Optional<rt.String>;
+}, false>, rt.Dictionary<rt.Unknown, string>]>]>, rt.Constraint<rt.Array<rt.String, false>, string[], unknown>]>;
+/**
+ * The plugin config is a tuple of plugin module names and objects containing plugin-specific options.
+ *
+ * Plugins will be imported from node_modules by name or from a path if specified.
+ *
+ * Example:
+ * ```
+ * [
+ *   'plugin-module',
+ *   ['plugin-with-options', { path: './path/to/plugin.js' }]
+ * ]
+ * ```
+ */
+export type PluginConfig = rt.Static<typeof PluginConfigRecord>;
+declare const ConfigOptionsRecord: rt.Record<{
+    inputDirectory: rt.Optional<rt.String>;
+    outputDirectory: rt.Optional<rt.String>;
+    documentationDirectory: rt.Optional<rt.String>;
+    generatorsToRun: rt.Optional<rt.Array<rt.String, false>>;
+    changelogStrategy: rt.Optional<rt.String>;
+    minecraftReleaseVersion: rt.Optional<rt.String>;
+    preexistingModuleReleases: rt.Optional<rt.Dictionary<rt.Array<rt.String, false>, string>>;
+    includeModulesMode: rt.Optional<rt.Union<[rt.Literal<"all">, rt.Literal<"latest">]>>;
+    includeBaseModules: rt.Optional<rt.Boolean>;
+    skipMerging: rt.Optional<rt.Boolean>;
+    plugins: rt.Optional<rt.Array<rt.Union<[rt.String, rt.Tuple<[rt.String, rt.Intersect<[rt.Record<{
+        path: rt.Optional<rt.String>;
+    }, false>, rt.Dictionary<rt.Unknown, string>]>]>, rt.Constraint<rt.Array<rt.String, false>, string[], unknown>]>, false>>;
+    generators: rt.Optional<rt.Dictionary<rt.Dictionary<rt.Unknown, string>, string>>;
+    log: rt.Optional<rt.Record<{
+        level: rt.Optional<rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>>;
+        allMessages: rt.Optional<rt.Union<[rt.Boolean, rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>;
+        undocumentedApis: rt.Optional<rt.Union<[rt.Boolean, rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>;
+        unusedDocumentation: rt.Optional<rt.Union<[rt.Boolean, rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>;
+        unresolvedDependencies: rt.Optional<rt.Union<[rt.Boolean, rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>;
+        unresolvedTypes: rt.Optional<rt.Union<[rt.Boolean, rt.Union<[rt.Literal<"debug">, rt.Literal<"info">, rt.Literal<"warn">, rt.Literal<"error">]>]>>;
+    }, false>>;
+}, false>;
+/**
+ * Options used by generate() that can be invoked through CLI.
+ */
+export type GenerateOptions = rt.Static<typeof ConfigOptionsRecord> & {
+    configPath?: string;
+    ignoreConfig?: boolean;
+};
+/**
+ * 'api-generator.config.mjs' config schema.
+ */
+export type Config = rt.Static<typeof ConfigOptionsRecord>;
+/**
+ * Options from config files and generate() arguments.
+ */
+export type ConfigOptions = GenerateOptions & Config;
+export {};

package/lib/Config.js

@@ -0,0 +1,68 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncludeModulesModeUnion = exports.PreexistingModuleReleasesRecord = exports.CONFIG_NAME = void 0;
+exports.findConfig = findConfig;
+exports.checkConfig = checkConfig;
+const cosmiconfig_1 = require("cosmiconfig");
+const rt = __importStar(require("runtypes"));
+const Logger_1 = require("./Logger");
+exports.CONFIG_NAME = 'api-docs-generator';
+/**
+ * Helper for finding the config file using cosmiconfig.
+ */
+async function findConfig() {
+    return await (0, cosmiconfig_1.cosmiconfig)(exports.CONFIG_NAME, { searchStrategy: 'project' }).search();
+}
+/**
+ * Helper for type validating config file.
+ */
+function checkConfig(config) {
+    return ConfigOptionsRecord.check(config);
+}
+exports.PreexistingModuleReleasesRecord = rt.Dictionary(rt.Array(rt.String), rt.String);
+exports.IncludeModulesModeUnion = rt.Union(rt.Literal('all'), rt.Literal('latest'));
+const PluginOptionsRecord = rt.Intersect(rt.Record({
+    path: rt.Optional(rt.String),
+}), rt.Dictionary(rt.Unknown, rt.String));
+const PluginConfigRecord = rt.Union(rt.String, rt.Tuple(rt.String, PluginOptionsRecord), rt.Array(rt.String).withConstraint(arr => arr.length === 1));
+const ConfigOptionsRecord = rt.Record({
+    inputDirectory: rt.Optional(rt.String),
+    outputDirectory: rt.Optional(rt.String),
+    documentationDirectory: rt.Optional(rt.String),
+    generatorsToRun: rt.Optional(rt.Array(rt.String)),
+    changelogStrategy: rt.Optional(rt.String),
+    minecraftReleaseVersion: rt.Optional(rt.String),
+    preexistingModuleReleases: rt.Optional(exports.PreexistingModuleReleasesRecord),
+    includeModulesMode: rt.Optional(exports.IncludeModulesModeUnion),
+    includeBaseModules: rt.Optional(rt.Boolean),
+    skipMerging: rt.Optional(rt.Boolean),
+    plugins: rt.Optional(rt.Array(PluginConfigRecord)),
+    generators: rt.Optional(rt.Dictionary(rt.Dictionary(rt.Unknown, rt.String), rt.String)),
+    log: rt.Optional(Logger_1.LogOptionsRecord),
+});
+//# sourceMappingURL=Config.js.map

package/lib/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;AAYlC,gCAEC;AAKD,kCAEC;AAnBD,6CAA6D;AAC7D,6CAA+B;AAE/B,qCAA4C;AAE/B,QAAA,WAAW,GAAG,oBAAoB,CAAC;AAEhD;;GAEG;AACI,KAAK,UAAU,UAAU;IAC5B,OAAO,MAAM,IAAA,yBAAW,EAAC,mBAAW,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAClF,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,MAAc;IACtC,OAAO,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAEY,QAAA,+BAA+B,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;AAGhF,QAAA,uBAAuB,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;AAGzF,MAAM,mBAAmB,GAAG,EAAE,CAAC,SAAS,CACpC,EAAE,CAAC,MAAM,CAAC;IACN,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;CAC/B,CAAC,EACF,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,CACvC,CAAC;AAGF,MAAM,kBAAkB,GAAG,EAAE,CAAC,KAAK,CAC/B,EAAE,CAAC,MAAM,EACT,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,EACxC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAC9D,CAAC;AAiBF,MAAM,mBAAmB,GAAG,EAAE,CAAC,MAAM,CAAC;IAClC,cAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;IACtC,eAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;IACvC,sBAAsB,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;IAC9C,eAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACjD,iBAAiB,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;IACzC,uBAAuB,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC;IAC/C,yBAAyB,EAAE,EAAE,CAAC,QAAQ,CAAC,uCAA+B,CAAC;IACvE,kBAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,+BAAuB,CAAC;IACxD,kBAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC;IAC3C,WAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC;IACpC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAClD,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IACvF,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,yBAAgB,CAAC;CACrC,CAAC,CAAC"}

package/lib/Context.d.ts

@@ -0,0 +1,28 @@
+import { ChangelogStrategy } from './ChangelogStrategy';
+import { GenerateOptions, IncludeModulesMode } from './Config';
+import { FileLoader } from './FileLoader';
+import { MarkupGenerator, MarkupGeneratorOptions } from './plugins';
+export declare class GeneratorContext {
+    private readonly config;
+    readonly changelogStrategy: ChangelogStrategy;
+    readonly inputDirectory: string;
+    readonly rootOutputDirectory: string;
+    readonly documentationFileLoader: FileLoader | undefined;
+    private readonly generators;
+    private readonly templates;
+    private constructor();
+    static Init(cliOptions: GenerateOptions): Promise<GeneratorContext>;
+    get minecraftReleaseVersion(): string | undefined;
+    get preexistingModuleReleases(): Record<string, string[]> | undefined;
+    get includeModules(): IncludeModulesMode;
+    get includeBaseModules(): boolean;
+    get skipMerging(): boolean;
+    getGenerator(generatorId: string): MarkupGenerator;
+    getGeneratorOptions(generatorId: string): MarkupGeneratorOptions;
+    getGenerators(): Iterable<MarkupGenerator>;
+    getGeneratorIds(): string[];
+    hasGenerators(...generatorIds: string[]): boolean;
+    getTemplates(...templateIds: string[]): Record<string, FileLoader>;
+    hasTemplates(...templateIds: string[]): boolean;
+    shutdown(): void;
+}