Introduce a simple plugin contract for API Documenter

octogonz · octogonz · commit 73289c58de38 · 2019-09-04T23:15:46.000-07:00
diff --git a/apps/api-documenter/config/api-extractor.json b/apps/api-documenter/config/api-extractor.json
@@ -0,0 +1,20 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "../../../common/reviews/api"
+  },
+
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "../../../common/temp/api/<unscopedPackageName>.api.json"
+  },
+
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "<projectFolder>/dist/rollup.d.ts",
+  }
+}
diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json
@@ -14,6 +14,8 @@
   "bin": {
     "api-documenter": "./bin/api-documenter"
   },
+  "main": "lib/index.js",
+  "typings": "dist/rollup.d.ts",
   "dependencies": {
     "@microsoft/api-extractor-model": "7.3.4",
     "@microsoft/node-core-library": "3.14.1",
diff --git a/apps/api-documenter/src/index.ts b/apps/api-documenter/src/index.ts
@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+export { MarkdownDocumenterExtension } from './plugin/MarkdownDocumenterExtension';
+export { IExtensionDefinition, IApiDocumenterPluginManifest } from './plugin/IApiDocumenterPluginManifest';
diff --git a/apps/api-documenter/src/plugin/IApiDocumenterPluginManifest.ts b/apps/api-documenter/src/plugin/IApiDocumenterPluginManifest.ts
@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { MarkdownDocumenterExtension } from './MarkdownDocumenterExtension';
+
+export interface IExtensionDefinition {
+  /**
+   * The name of this extension, as it will appear in the config file.
+   *
+   * The name should consist of one or more words separated by hyphens.  Each word should consist of lower case
+   * letters and numbers.  Example: `my-extension`
+   */
+  name: string;
+
+  /**
+   * The name of the base class.
+   */
+  kind: 'MarkdownDocumenterExtension';
+
+  /**
+   * Your subclass that extends from the base class.
+   */
+  subclass: { new(): MarkdownDocumenterExtension };
+}
+
+export interface IApiDocumenterPluginManifest {
+  extensions: IExtensionDefinition[];
+}
diff --git a/apps/api-documenter/src/plugin/MarkdownDocumenterExtension.ts b/apps/api-documenter/src/plugin/MarkdownDocumenterExtension.ts
@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * @public
+ */
+export class MarkdownDocumenterExtension {
+}
diff --git a/common/reviews/api/api-documenter.api.md b/common/reviews/api/api-documenter.api.md
@@ -0,0 +1,29 @@
+## API Report File for "@microsoft/api-documenter"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export interface IApiDocumenterPluginManifest {
+    // (undocumented)
+    extensions: IExtensionDefinition[];
+}
+
+// @public (undocumented)
+export interface IExtensionDefinition {
+    kind: 'MarkdownDocumenterExtension';
+    name: string;
+    subclass: {
+        new (): MarkdownDocumenterExtension;
+    };
+}
+
+// @public (undocumented)
+export class MarkdownDocumenterExtension {
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```
