@minecraft/api-docs-generator 1.0.0

package/lib/Context.js

@@ -0,0 +1,323 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratorContext = void 0;
+const cosmiconfig_1 = require("cosmiconfig");
+const path_1 = __importDefault(require("path"));
+const resolve_from_1 = __importDefault(require("resolve-from"));
+const toposort_1 = __importDefault(require("toposort"));
+const ChangelogStrategy_1 = require("./ChangelogStrategy");
+const Config_1 = require("./Config");
+const FileLoader_1 = require("./FileLoader");
+const log = __importStar(require("./Logger"));
+/**
+ * Markup generators ran by default when none are specified
+ */
+const DefaultGenerators = ['ts', 'ts-source', 'changelog', 'npm', 'typedoc', 'msdocs'];
+/**
+ * Parse CLI options and merge with the loaded config if it exists
+ */
+async function parseConfig(generateOptions) {
+    let configFile;
+    if (!generateOptions.ignoreConfig) {
+        if (generateOptions.configPath) {
+            configFile = await (0, cosmiconfig_1.cosmiconfig)(Config_1.CONFIG_NAME).load(generateOptions.configPath);
+            if (!configFile) {
+                log.warn(`Could not load config file from '${generateOptions.configPath}', will search for one instead.`);
+            }
+        }
+        if (!configFile) {
+            configFile = await (0, Config_1.findConfig)();
+            if (configFile) {
+                generateOptions.configPath = configFile.filepath;
+            }
+        }
+    }
+    const parsedConfig = configFile ? (0, Config_1.checkConfig)(configFile.config) : {};
+    const parsedOptions = Object.fromEntries(Object.entries(generateOptions).filter(([, v]) => v));
+    return {
+        ...parsedConfig,
+        ...parsedOptions,
+    };
+}
+function initGenerators(generatorsToInit, allGenerators) {
+    const ids = [];
+    for (const generator of generatorsToInit) {
+        if (!allGenerators.has(generator.id)) {
+            allGenerators.set(generator.id, generator);
+            ids.push(generator.id);
+        }
+        else {
+            log.warn(`Multiple generators with identical ID '${generator.id}' present. Ignoring duplicate.`);
+        }
+    }
+    return ids;
+}
+function initTemplates(templatesToInit, allTemplates) {
+    const ids = [];
+    for (const id in templatesToInit) {
+        if (!allTemplates.has(id)) {
+            const fileLoader = new FileLoader_1.FileLoader(templatesToInit[id]);
+            if (!fileLoader.loaded()) {
+                log.warn(`No template files were loaded from directory: ${templatesToInit[id]}`);
+                continue;
+            }
+            allTemplates.set(id, fileLoader);
+            ids.push(id);
+        }
+        else {
+            log.warn(`Multiple templates with identical ID '${id}' present. Ignoring duplicates.`);
+        }
+    }
+    return ids;
+}
+function initStrategies(strategiesToInit, allStrategies) {
+    const ids = [];
+    for (const id in strategiesToInit) {
+        if (!allStrategies.has(id)) {
+            allStrategies.set(id, strategiesToInit[id]);
+            ids.push(id);
+        }
+        else {
+            log.warn(`Multiple changelog strategies with identical ID '${id}' present. Ignoring duplicates.`);
+        }
+    }
+    return ids;
+}
+/**
+ * Initialize markup generators imported from plugin modules
+ */
+async function initPlugins(config) {
+    const allGenerators = new Map();
+    const allTemplates = new Map();
+    const allStrategies = new Map(ChangelogStrategy_1.CoreChangelogStrategies);
+    if (config.plugins && config.plugins.length === 0) {
+        throw new Error('No plugins defined in config, must specify at least one plugin to import generators from.');
+    }
+    else if (!config.plugins) {
+        log.debug(`No plugins specified, adding '@minecraft/markup-generators-plugin'.`);
+        config.plugins = ['@minecraft/markup-generators-plugin'];
+    }
+    if (config.plugins) {
+        for (const plugin of config.plugins) {
+            let pluginName;
+            let pluginConfig = {};
+            if (typeof plugin === 'string') {
+                pluginName = plugin;
+            }
+            else if (Array.isArray(plugin)) {
+                if (plugin.length <= 2) {
+                    if (plugin.length >= 1 && typeof plugin[0] === 'string') {
+                        pluginName = plugin[0];
+                    }
+                    if (plugin.length === 2 && typeof plugin[1] === 'object') {
+                        pluginConfig = plugin[1];
+                    }
+                }
+                else {
+                    throw new Error(`Plugin config should be a tuple, but has ${plugin.length} values. Expected format: ['plugin-name', { setting: true }]`);
+                }
+            }
+            if (!pluginName) {
+                throw new Error(`Incorrectly formatted plugin config in '${config.configPath}'. Expected format: ['plugin-name', { setting: true }]`);
+            }
+            let importPath = pluginName;
+            if (pluginConfig.path) {
+                importPath = (0, resolve_from_1.default)(process.cwd(), pluginConfig.path);
+            }
+            log.info(`Importing plugin: '${importPath}'`);
+            try {
+                const { default: pluginModule } = (await Promise.resolve(`${importPath}`).then(s => __importStar(require(s))));
+                const generatorIds = initGenerators(pluginModule.generators ?? [], allGenerators);
+                const templateIds = initTemplates(pluginModule.templates ?? {}, allTemplates);
+                const strategyIds = initStrategies(pluginModule.changelogStrategies ?? {}, allStrategies);
+                if (generatorIds.length > 0) {
+                    log.info(`Imported generators: [${generatorIds.join(', ')}]`);
+                }
+                if (templateIds.length > 0) {
+                    log.info(`Imported templates: [${templateIds.join(', ')}]`);
+                }
+                if (strategyIds.length > 0) {
+                    log.info(`Imported changelog strategies: [${strategyIds.join(', ')}]`);
+                }
+                if (generatorIds.length === 0 && templateIds.length === 0 && strategyIds.length === 0) {
+                    log.warn('Plugin has nothing to import!');
+                }
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    log.error(`Could not import plugin module '${importPath}'.`);
+                    throw e;
+                }
+            }
+        }
+    }
+    let changelogStrategy;
+    if (config.changelogStrategy) {
+        if (allStrategies.has(config.changelogStrategy)) {
+            changelogStrategy = allStrategies.get(config.changelogStrategy);
+        }
+        else {
+            log.warn(`Changelog Strategy '${config.changelogStrategy}' is invalid, will default to 'module_version'.`);
+        }
+    }
+    if (!changelogStrategy) {
+        changelogStrategy = allStrategies.get('module_version');
+    }
+    const generatorsToRun = new Map();
+    const initGeneratorRecursive = (generatorId) => {
+        let generator = generatorsToRun.get(generatorId);
+        if (!generator) {
+            if (allGenerators.has(generatorId)) {
+                generator = allGenerators.get(generatorId);
+            }
+            else {
+                throw new Error(`Attempted to run generator '${generatorId}' but it has not been imported from a plugin module.\n
+                    Verify that all required plugins are included in config.`);
+            }
+            generatorsToRun.set(generatorId, generator);
+            if (generator.dependencies) {
+                for (const dependencyId of generator.dependencies) {
+                    initGeneratorRecursive(dependencyId);
+                }
+            }
+        }
+    };
+    for (const generatorId of config.generatorsToRun ?? DefaultGenerators) {
+        initGeneratorRecursive(generatorId);
+    }
+    const generatorDependencyEdges = [];
+    for (const generator of generatorsToRun.values()) {
+        if (generator.dependencies) {
+            for (const depId of generator.dependencies) {
+                generatorDependencyEdges.push([depId, generator.id]);
+            }
+        }
+    }
+    const sortedGeneratorIds = toposort_1.default.array(Array.from(generatorsToRun.keys()), generatorDependencyEdges);
+    const sortedGeneratorMap = new Map(sortedGeneratorIds.map(id => {
+        const generator = generatorsToRun.get(id);
+        return [
+            id,
+            [
+                generator,
+                {
+                    ...generator.defaultOptions,
+                    ...config.generators?.[id],
+                },
+            ],
+        ];
+    }));
+    return {
+        generators: sortedGeneratorMap,
+        templates: allTemplates,
+        changelogStrategy,
+    };
+}
+class GeneratorContext {
+    config;
+    changelogStrategy;
+    inputDirectory;
+    rootOutputDirectory;
+    documentationFileLoader;
+    generators;
+    templates;
+    constructor(config, generators, templates, changelogStrategy) {
+        this.config = { ...config };
+        this.generators = generators;
+        this.templates = templates;
+        this.changelogStrategy = changelogStrategy;
+        this.inputDirectory = path_1.default.resolve(config.inputDirectory);
+        this.rootOutputDirectory = path_1.default.resolve(config.outputDirectory);
+        if (config.documentationDirectory) {
+            const docsPath = path_1.default.resolve(config.documentationDirectory);
+            const loader = new FileLoader_1.FileLoader(docsPath, ['.json', '.js', '.ts']);
+            if (loader.loaded()) {
+                this.documentationFileLoader = loader;
+            }
+            else {
+                log.warn(`No documentation files were loaded from directory: ${docsPath}`);
+            }
+        }
+    }
+    static async Init(cliOptions) {
+        const config = await parseConfig(cliOptions);
+        log.setLogOptions(config.log);
+        if (config.configPath) {
+            log.info(`Loaded config file: ${config.configPath}`);
+        }
+        const { generators, templates, changelogStrategy } = await initPlugins(config);
+        return new GeneratorContext(config, generators, templates, changelogStrategy);
+    }
+    get minecraftReleaseVersion() {
+        return this.config.minecraftReleaseVersion;
+    }
+    get preexistingModuleReleases() {
+        return this.config.preexistingModuleReleases;
+    }
+    get includeModules() {
+        return this.config.includeModulesMode ?? 'all';
+    }
+    get includeBaseModules() {
+        return this.config.includeBaseModules ?? false;
+    }
+    get skipMerging() {
+        return this.config.skipMerging ?? false;
+    }
+    getGenerator(generatorId) {
+        return this.generators.get(generatorId)[0];
+    }
+    getGeneratorOptions(generatorId) {
+        return this.generators.get(generatorId)[1];
+    }
+    getGenerators() {
+        return Array.from(this.generators.values()).map(g => g[0]);
+    }
+    getGeneratorIds() {
+        return Array.from(this.generators.keys());
+    }
+    hasGenerators(...generatorIds) {
+        return generatorIds.every(id => this.generators.has(id));
+    }
+    getTemplates(...templateIds) {
+        return Object.fromEntries(Array.from(this.templates.entries()).filter(([id]) => templateIds.includes(id)));
+    }
+    hasTemplates(...templateIds) {
+        return templateIds.every(id => this.templates.has(id));
+    }
+    shutdown() {
+        this.documentationFileLoader?.logUnusedFiles();
+        for (const id in this.templates) {
+            this.templates.get(id).logUnusedFiles();
+        }
+    }
+}
+exports.GeneratorContext = GeneratorContext;
+//# sourceMappingURL=Context.js.map

package/lib/Context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.js","sourceRoot":"","sources":["../src/Context.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAElC,6CAA0C;AAC1C,gDAAwB;AACxB,gEAAuC;AACvC,wDAAgC;AAEhC,2DAAiF;AACjF,qCASkB;AAClB,6CAA0C;AAC1C,8CAAgC;AAGhC;;GAEG;AACH,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAEvF;;GAEG;AACH,KAAK,UAAU,WAAW,CAAC,eAAgC;IACvD,IAAI,UAAU,CAAC;IAEf,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,CAAC;QAChC,IAAI,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,UAAU,GAAG,MAAM,IAAA,yBAAW,EAAC,oBAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;YAC7E,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,GAAG,CAAC,IAAI,CACJ,oCAAoC,eAAe,CAAC,UAAU,iCAAiC,CAClG,CAAC;YACN,CAAC;QACL,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,UAAU,GAAG,MAAM,IAAA,mBAAU,GAAE,CAAC;YAChC,IAAI,UAAU,EAAE,CAAC;gBACb,eAAe,CAAC,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;YACrD,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,oBAAW,EAAC,UAAU,CAAC,MAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChF,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,OAAO;QACH,GAAG,YAAY;QACf,GAAG,aAAa;KACnB,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CAAC,gBAAmC,EAAE,aAA2C;IACpG,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;QACvC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;YACnC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAC3C,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,IAAI,CAAC,0CAA0C,SAAS,CAAC,EAAE,gCAAgC,CAAC,CAAC;QACrG,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,eAAuC,EAAE,YAAqC;IACjG,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;QAC/B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACxB,MAAM,UAAU,GAAG,IAAI,uBAAU,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;gBACvB,GAAG,CAAC,IAAI,CAAC,iDAAiD,eAAe,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACjF,SAAS;YACb,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YACjC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,IAAI,CAAC,yCAAyC,EAAE,iCAAiC,CAAC,CAAC;QAC3F,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CACnB,gBAAmD,EACnD,aAA6C;IAE7C,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,EAAE,IAAI,gBAAgB,EAAE,CAAC;QAChC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACzB,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC5C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,IAAI,CAAC,oDAAoD,EAAE,iCAAiC,CAAC,CAAC;QACtG,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAUD;;GAEG;AACH,KAAK,UAAU,WAAW,CAAC,MAAqB;IAC5C,MAAM,aAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;IACzD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAsB,CAAC;IACnD,MAAM,aAAa,GAAG,IAAI,GAAG,CAA4B,2CAAuB,CAAC,CAAC;IAElF,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;IACjH,CAAC;SAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,GAAG,CAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACjF,MAAM,CAAC,OAAO,GAAG,CAAC,qCAAqC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,UAA8B,CAAC;YACnC,IAAI,YAAY,GAAkB,EAAE,CAAC;YAErC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC7B,UAAU,GAAG,MAAM,CAAC;YACxB,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACrB,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;wBACtD,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC;oBACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;wBACvD,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC7B,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,KAAK,CACX,4CAA4C,MAAM,CAAC,MAAM,8DAA8D,CAC1H,CAAC;gBACN,CAAC;YACL,CAAC;YAED,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACX,2CAA2C,MAAM,CAAC,UAAU,wDAAwD,CACvH,CAAC;YACN,CAAC;YAED,IAAI,UAAU,GAAG,UAAU,CAAC;YAC5B,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;gBACpB,UAAU,GAAG,IAAA,sBAAW,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;YAC/D,CAAC;YAED,GAAG,CAAC,IAAI,CAAC,sBAAsB,UAAU,GAAG,CAAC,CAAC;YAC9C,IAAI,CAAC;gBACD,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,CAAC,yBAAa,UAAU,uCAAC,CAAwB,CAAC;gBACpF,MAAM,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC,UAAU,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC;gBAClF,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;gBAC9E,MAAM,WAAW,GAAG,cAAc,CAAC,YAAY,CAAC,mBAAmB,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC;gBAE1F,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1B,GAAG,CAAC,IAAI,CAAC,yBAAyB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAClE,CAAC;gBACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,GAAG,CAAC,IAAI,CAAC,wBAAwB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAChE,CAAC;gBACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,GAAG,CAAC,IAAI,CAAC,mCAAmC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3E,CAAC;gBACD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpF,GAAG,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;gBAC9C,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;oBACrB,GAAG,CAAC,KAAK,CAAC,mCAAmC,UAAU,IAAI,CAAC,CAAC;oBAC7D,MAAM,CAAC,CAAC;gBACZ,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,iBAAgD,CAAC;IACrD,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;QAC3B,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC9C,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACpE,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,iBAAiB,iDAAiD,CAAC,CAAC;QAC/G,CAAC;IACL,CAAC;IACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACrB,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAA2B,CAAC;IAE3D,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAE,EAAE;QACnD,IAAI,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;gBACjC,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CACX,+BAA+B,WAAW;6EACe,CAC5D,CAAC;YACN,CAAC;YAED,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAE5C,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;gBACzB,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;oBAChD,sBAAsB,CAAC,YAAY,CAAC,CAAC;gBACzC,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC,CAAC;IAEF,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,eAAe,IAAI,iBAAiB,EAAE,CAAC;QACpE,sBAAsB,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,wBAAwB,GAAuB,EAAE,CAAC;IACxD,KAAK,MAAM,SAAS,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QAC/C,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;YACzB,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;gBACzC,wBAAwB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;YACzD,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,kBAAkB,GAAG,kBAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAC;IACxG,MAAM,kBAAkB,GAAuB,IAAI,GAAG,CAClD,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QACxB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO;YACH,EAAE;YACF;gBACI,SAAS;gBACT;oBACI,GAAG,SAAS,CAAC,cAAc;oBAC3B,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;iBAC7B;aACJ;SACJ,CAAC;IACN,CAAC,CAAC,CACL,CAAC;IAEF,OAAO;QACH,UAAU,EAAE,kBAAkB;QAC9B,SAAS,EAAE,YAAY;QACvB,iBAAiB;KACpB,CAAC;AACN,CAAC;AAED,MAAa,gBAAgB;IACR,MAAM,CAAgB;IAE9B,iBAAiB,CAAoB;IAErC,cAAc,CAAS;IACvB,mBAAmB,CAAS;IAE5B,uBAAuB,CAAyB;IAExC,UAAU,CAAqB;IAC/B,SAAS,CAA0B;IAEpD,YACI,MAAqB,EACrB,UAA8B,EAC9B,SAAkC,EAClC,iBAAoC;QAEpC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,IAAI,CAAC,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC1D,IAAI,CAAC,mBAAmB,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAEhE,IAAI,MAAM,CAAC,sBAAsB,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC7D,MAAM,MAAM,GAAG,IAAI,uBAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YACjE,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;gBAClB,IAAI,CAAC,uBAAuB,GAAG,MAAM,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACJ,GAAG,CAAC,IAAI,CAAC,sDAAsD,QAAQ,EAAE,CAAC,CAAC;YAC/E,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,UAA2B;QACzC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC;QAE7C,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACpB,GAAG,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;QAC/E,OAAO,IAAI,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;IAClF,CAAC;IAED,IAAI,uBAAuB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAC/C,CAAC;IAED,IAAI,yBAAyB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC;IACjD,CAAC;IAED,IAAI,cAAc;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,IAAI,KAAK,CAAC;IACnD,CAAC;IAED,IAAI,kBAAkB;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,IAAI,KAAK,CAAC;IACnD,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC;IAC5C,CAAC;IAED,YAAY,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,mBAAmB,CAAC,WAAmB;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,aAAa;QACT,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,eAAe;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,aAAa,CAAC,GAAG,YAAsB;QACnC,OAAO,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,YAAY,CAAC,GAAG,WAAqB;QACjC,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED,YAAY,CAAC,GAAG,WAAqB;QACjC,OAAO,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,uBAAuB,EAAE,cAAc,EAAE,CAAC;QAC/C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,cAAc,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC;CACJ;AAzGD,4CAyGC"}

package/lib/FileLoader.d.ts

@@ -0,0 +1,13 @@
+export declare class FileLoader {
+    private fileCache;
+    private filePathIsCached;
+    private rootFilePath;
+    private supportedExtensions;
+    constructor(rootFilePath: string, extensions?: string[]);
+    loaded(): boolean;
+    canLoadFile(filePath: string): boolean;
+    readFile(filePath: string): Buffer;
+    readFileAsString(filePath: string): string;
+    joinToRoot(directory: string): string;
+    logUnusedFiles(): void;
+}

package/lib/FileLoader.js

@@ -0,0 +1,91 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileLoader = void 0;
+const path_1 = __importDefault(require("path"));
+const log = __importStar(require("./Logger"));
+const utils = __importStar(require("./utilities"));
+class FileLoader {
+    fileCache;
+    filePathIsCached;
+    rootFilePath;
+    supportedExtensions;
+    constructor(rootFilePath, extensions) {
+        this.fileCache = new Map();
+        this.rootFilePath = rootFilePath;
+        this.supportedExtensions = extensions ?? [];
+        this.filePathIsCached = {};
+        let filePaths = utils.getFilesRecursively(this.rootFilePath);
+        if (this.supportedExtensions.length > 0) {
+            filePaths = filePaths.filter(p => this.supportedExtensions.includes(path_1.default.extname(p)));
+        }
+        for (const p of filePaths) {
+            this.filePathIsCached[p.toLowerCase()] = false;
+        }
+    }
+    loaded() {
+        return Object.keys(this.filePathIsCached).length > 0;
+    }
+    canLoadFile(filePath) {
+        const realPath = path_1.default.resolve(path_1.default.join(this.rootFilePath, filePath));
+        return Object.hasOwn(this.filePathIsCached, realPath.toLowerCase());
+    }
+    readFile(filePath) {
+        const realPath = path_1.default.resolve(path_1.default.join(this.rootFilePath, filePath));
+        const ext = path_1.default.extname(realPath);
+        if (this.supportedExtensions.length > 0 && !this.supportedExtensions.includes(ext)) {
+            throw new Error(`Attempted to read file of type '${ext}' not supported by this FileLoader.\nFile: ${realPath}`);
+        }
+        if (!Object.hasOwn(this.filePathIsCached, realPath.toLowerCase())) {
+            throw new Error(`Attempted to read file outside of FileLoader input directory.\nFile: ${realPath}\nInput Directory: ${this.rootFilePath}`);
+        }
+        if (!this.fileCache.has(realPath)) {
+            this.fileCache.set(realPath, utils.readFile(realPath));
+            // Mark this file as having been read so we can log unused files
+            this.filePathIsCached[realPath.toLowerCase()] = true;
+        }
+        return this.fileCache.get(realPath);
+    }
+    readFileAsString(filePath) {
+        return this.readFile(filePath).toString('utf-8');
+    }
+    joinToRoot(directory) {
+        return path_1.default.join(this.rootFilePath, directory);
+    }
+    logUnusedFiles() {
+        for (const filePath in this.filePathIsCached) {
+            if (!this.filePathIsCached[filePath]) {
+                log.printOption(`Documentation file was not used: ${filePath}`, 'unusedDocumentation');
+            }
+        }
+    }
+}
+exports.FileLoader = FileLoader;
+//# sourceMappingURL=FileLoader.js.map

package/lib/FileLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileLoader.js","sourceRoot":"","sources":["../src/FileLoader.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAElC,gDAAwB;AAExB,8CAAgC;AAChC,mDAAqC;AAErC,MAAa,UAAU;IACX,SAAS,CAAsB;IAC/B,gBAAgB,CAA0B;IAC1C,YAAY,CAAS;IACrB,mBAAmB,CAAW;IAEtC,YAAY,YAAoB,EAAE,UAAqB;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,mBAAmB,GAAG,UAAU,IAAI,EAAE,CAAC;QAE5C,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,GAAG,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE7D,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1F,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;QACnD,CAAC;IACL,CAAC;IAED,MAAM;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,WAAW,CAAC,QAAgB;QACxB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,QAAQ,CAAC,QAAgB;QACrB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;QAEtE,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CACX,mCAAmC,GAAG,8CAA8C,QAAQ,EAAE,CACjG,CAAC;QACN,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CACX,wEAAwE,QAAQ,sBAAsB,IAAI,CAAC,YAAY,EAAE,CAC5H,CAAC;QACN,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YAEvD,gEAAgE;YAChE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC;QACzD,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,UAAU,CAAC,SAAiB;QACxB,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,cAAc;QACV,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnC,GAAG,CAAC,WAAW,CAAC,oCAAoC,QAAQ,EAAE,EAAE,qBAAqB,CAAC,CAAC;YAC3F,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AAzED,gCAyEC"}

package/lib/Logger.d.ts

@@ -0,0 +1,65 @@
+import * as rt from 'runtypes';
+export declare enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}
+declare const LogMessageRecord: rt.Union<[rt.Literal<"undocumentedApis">, rt.Literal<"unusedDocumentation">, rt.Literal<"unresolvedDependencies">, rt.Literal<"unresolvedTypes">]>;
+export type LogMessage = rt.Static<typeof LogMessageRecord>;
+export declare const LogOptionsRecord: 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>;
+export type LogOptions = rt.Static<typeof LogOptionsRecord>;
+/**
+ * `printOption()` uses the log levels defined here to determine the level a message should be printed at.
+ *
+ * Note: true is equivalent to 'warn', undefined defaults to 'debug', false does not print.
+ */
+export declare const DefaultLogOptions: LogOptions;
+export declare function print(text: string, level?: LogLevel): void;
+/**
+ * Prints according to the specified log level setting for 'messageId', or:
+ *
+ * If 'messageId' is set to true, will print to 'warn' log level.
+ * If 'messageId' is undefined, will print to 'debug' log level.
+ * If 'messageId' is set to false, will not print.
+ */
+export declare function printOption(text: string, messageId: LogMessage): void;
+export declare function debug(text: string): void;
+export declare function info(text: string): void;
+export declare function warn(text: string): void;
+export declare function error(text: string): void;
+export declare function assert(assertion: boolean, text: string): void;
+export declare function setLogOptions(options: LogOptions): void;
+export declare function getLogOptions(): LogOptions;
+export declare function getLogLevel(): LogLevel;
+export interface ILogger {
+    options: LogOptions;
+    level: LogLevel;
+    debug(text: string): void;
+    info(text: string): void;
+    warn(text: string): void;
+    error(text: string): void;
+    assert(text: string): void;
+    setLogOptions(options: LogOptions): void;
+}
+export declare class TerminalLogger implements ILogger {
+    options: LogOptions;
+    level: LogLevel;
+    debug(text: string): void;
+    info(text: string): void;
+    warn(text: string): void;
+    error(text: string): void;
+    assert(text: string): void;
+    setLogOptions(options: LogOptions): void;
+}
+export declare class LoggerInstance {
+    static instance: ILogger;
+}
+export {};