@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
73 lines • 3.62 kB
JavaScript
;
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
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.GenerateAction = void 0;
const path = __importStar(require("path"));
const BaseAction_1 = require("./BaseAction");
const DocumenterConfig_1 = require("../documenters/DocumenterConfig");
const ExperimentalYamlDocumenter_1 = require("../documenters/ExperimentalYamlDocumenter");
const node_core_library_1 = require("@rushstack/node-core-library");
const MarkdownDocumenter_1 = require("../documenters/MarkdownDocumenter");
class GenerateAction extends BaseAction_1.BaseAction {
constructor(parser) {
super({
actionName: 'generate',
summary: 'EXPERIMENTAL',
documentation: 'EXPERIMENTAL - This action is a prototype of a new config file driven mode of operation for' +
' API Documenter. It is not ready for general usage yet. Its design may change in the future.'
});
}
async onExecute() {
// override
// Look for the config file under the current folder
let configFilePath = path.join(process.cwd(), DocumenterConfig_1.DocumenterConfig.FILENAME);
// First try the current folder
if (!node_core_library_1.FileSystem.exists(configFilePath)) {
// Otherwise try the standard "config" subfolder
configFilePath = path.join(process.cwd(), 'config', DocumenterConfig_1.DocumenterConfig.FILENAME);
if (!node_core_library_1.FileSystem.exists(configFilePath)) {
throw new Error(`Unable to find ${DocumenterConfig_1.DocumenterConfig.FILENAME} in the current folder or in a "config" subfolder`);
}
}
const documenterConfig = DocumenterConfig_1.DocumenterConfig.loadFile(configFilePath);
const { apiModel, outputFolder } = this.buildApiModel();
if (documenterConfig.configFile.outputTarget === 'markdown') {
const markdownDocumenter = new MarkdownDocumenter_1.MarkdownDocumenter({
apiModel,
documenterConfig,
outputFolder
});
markdownDocumenter.generateFiles();
}
else {
const yamlDocumenter = new ExperimentalYamlDocumenter_1.ExperimentalYamlDocumenter(apiModel, documenterConfig);
yamlDocumenter.generateFiles(outputFolder);
}
}
}
exports.GenerateAction = GenerateAction;
//# sourceMappingURL=GenerateAction.js.map