Expand the api-documenter.schema.json to include "outputTarget" and "plugins" fields

octogonz · octogonz · commit dbb2244411e0 · 2019-09-04T23:15:50.000-07:00
diff --git a/apps/api-documenter/src/cli/GenerateAction.ts b/apps/api-documenter/src/cli/GenerateAction.ts
@@ -11,6 +11,8 @@ import { IConfigFile } from '../documenters/IConfigFile';
 
 import { ApiModel } from '@microsoft/api-extractor-model';
 import { FileSystem } from '@microsoft/node-core-library';
+import { MarkdownDocumenter } from '../documenters/MarkdownDocumenter';
+import { PluginContext } from '../plugin/PluginContext';
 
 export class GenerateAction extends BaseAction {
   constructor(parser: ApiDocumenterCommandLine) {
@@ -38,10 +40,19 @@ export class GenerateAction extends BaseAction {
 
     const configFile: IConfigFile = DocumenterConfig.loadFile(configFilePath);
 
+    const pluginContext: PluginContext = new PluginContext();
+    pluginContext.load(configFile.plugins || [], configFilePath);
+
     const apiModel: ApiModel = this.buildApiModel();
 
-    const yamlDocumenter: ExperimentalYamlDocumenter = new ExperimentalYamlDocumenter(apiModel, configFile);
-    yamlDocumenter.generateFiles(this.outputFolder);
+    if (configFile.outputTarget === 'docfx') {
+      const yamlDocumenter: ExperimentalYamlDocumenter = new ExperimentalYamlDocumenter(apiModel, configFile);
+      yamlDocumenter.generateFiles(this.outputFolder);
+    } else {
+      const markdownDocumenter: MarkdownDocumenter = new MarkdownDocumenter(apiModel);
+      markdownDocumenter.generateFiles(this.outputFolder);
+    }
+
     return Promise.resolve();
   }
 }
diff --git a/apps/api-documenter/src/documenters/IConfigFile.ts b/apps/api-documenter/src/documenters/IConfigFile.ts
@@ -50,10 +50,36 @@ export interface IConfigTableOfContents {
   nonEmptyCategoryNodeNames?: string[];
 }
 
+/**
+ * Describes plugin packages to be loaded, and which features to enable.
+ */
+export interface IConfigPlugin {
+  /**
+   * Specifies the name of an API Documenter plugin package to be loaded.  By convention, the NPM package name
+   * should have the prefix `doc-plugin-`.  Its main entry point should export an object named
+   * `apiDocumenterPluginManifest` which implements the {@link IApiDocumenterPluginManifest} interface.
+   */
+  packageName: string;
+
+  /**
+   * A list of features to be enabled.  The features are defined in {@link IApiDocumenterPluginManifest.features}.
+   * The `enabledFeatureNames` strings are matched with {@link IFeatureDefinition.featureName}.
+   */
+  enabledFeatureNames: string[];
+}
+
 /**
  * This interface represents the api-extractor.json file format.
  */
 export interface IConfigFile {
+  /**
+   * Specifies the output target.
+   */
+  outputTarget: 'docfx' | 'markdown';
+
+  /** {@inheritDoc IConfigPlugin} */
+  plugins?: IConfigPlugin[];
+
   /** {@inheritDoc IConfigTableOfContents} */
   tableOfContents?: IConfigTableOfContents;
 }
diff --git a/apps/api-documenter/src/schemas/api-documenter.schema.json b/apps/api-documenter/src/schemas/api-documenter.schema.json
@@ -8,11 +8,26 @@
       "type": "string"
     },
 
+    "outputTarget": {
+      "description": "Specifies what type of documentation will be generated",
+      "type": "string",
+      "enum": [
+        "docfx",
+        "markdown"
+      ]
+    },
+
+    "plugins": {
+      "description": "Specifies plugin packages to be loaded",
+      "type": "array"
+    },
+
     "tableOfContents": {
       "description": "Configures how the table of contents is generated.",
       "type": "object",
       "additionalProperties": true
     },
   },
+
   "additionalProperties": false
 }
