@microsoft/api-documenter 7.19.21 → 7.19.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/cli/ApiDocumenterCommandLine.d.ts +0 -1
- package/lib/cli/ApiDocumenterCommandLine.d.ts.map +1 -1
- package/lib/cli/ApiDocumenterCommandLine.js +0 -4
- package/lib/cli/ApiDocumenterCommandLine.js.map +1 -1
- package/lib/cli/BaseAction.d.ts +4 -4
- package/lib/cli/BaseAction.d.ts.map +1 -1
- package/lib/cli/BaseAction.js +4 -3
- package/lib/cli/BaseAction.js.map +1 -1
- package/lib/cli/YamlAction.d.ts +3 -4
- package/lib/cli/YamlAction.d.ts.map +1 -1
- package/lib/cli/YamlAction.js +0 -4
- package/lib/cli/YamlAction.js.map +1 -1
- package/package.json +6 -6
package/dist/tsdoc-metadata.json
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { CommandLineParser } from '@rushstack/ts-command-line';
|
|
2
2
|
export declare class ApiDocumenterCommandLine extends CommandLineParser {
|
|
3
3
|
constructor();
|
|
4
|
-
protected onDefineParameters(): void;
|
|
5
4
|
private _populateActions;
|
|
6
5
|
}
|
|
7
6
|
//# sourceMappingURL=ApiDocumenterCommandLine.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiDocumenterCommandLine.d.ts","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,qBAAa,wBAAyB,SAAQ,iBAAiB;;IAW7D,
|
|
1
|
+
{"version":3,"file":"ApiDocumenterCommandLine.d.ts","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,qBAAa,wBAAyB,SAAQ,iBAAiB;;IAW7D,OAAO,CAAC,gBAAgB;CAKzB"}
|
|
@@ -16,10 +16,6 @@ class ApiDocumenterCommandLine extends ts_command_line_1.CommandLineParser {
|
|
|
16
16
|
});
|
|
17
17
|
this._populateActions();
|
|
18
18
|
}
|
|
19
|
-
onDefineParameters() {
|
|
20
|
-
// override
|
|
21
|
-
// No parameters
|
|
22
|
-
}
|
|
23
19
|
_populateActions() {
|
|
24
20
|
this.addAction(new MarkdownAction_1.MarkdownAction(this));
|
|
25
21
|
this.addAction(new YamlAction_1.YamlAction(this));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiDocumenterCommandLine.js","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,gEAA+D;AAC/D,qDAAkD;AAClD,6CAA0C;AAC1C,qDAAkD;AAElD,MAAa,wBAAyB,SAAQ,mCAAiB;IAC7D;QACE,KAAK,CAAC;YACJ,YAAY,EAAE,gBAAgB;YAC9B,eAAe,EACb,oDAAoD;gBACpD,6DAA6D;SAChE,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;
|
|
1
|
+
{"version":3,"file":"ApiDocumenterCommandLine.js","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,gEAA+D;AAC/D,qDAAkD;AAClD,6CAA0C;AAC1C,qDAAkD;AAElD,MAAa,wBAAyB,SAAQ,mCAAiB;IAC7D;QACE,KAAK,CAAC;YACJ,YAAY,EAAE,gBAAgB;YAC9B,eAAe,EACb,oDAAoD;gBACpD,6DAA6D;SAChE,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAEO,gBAAgB;QACtB,IAAI,CAAC,SAAS,CAAC,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,IAAI,uBAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AAhBD,4DAgBC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { CommandLineParser } from '@rushstack/ts-command-line';\nimport { MarkdownAction } from './MarkdownAction';\nimport { YamlAction } from './YamlAction';\nimport { GenerateAction } from './GenerateAction';\n\nexport class ApiDocumenterCommandLine extends CommandLineParser {\n public constructor() {\n super({\n toolFilename: 'api-documenter',\n toolDescription:\n 'Reads *.api.json files produced by api-extractor, ' +\n ' and generates API documentation in various output formats.'\n });\n this._populateActions();\n }\n\n private _populateActions(): void {\n this.addAction(new MarkdownAction(this));\n this.addAction(new YamlAction(this));\n this.addAction(new GenerateAction(this));\n }\n}\n"]}
|
package/lib/cli/BaseAction.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CommandLineAction } from '@rushstack/ts-command-line';
|
|
1
|
+
import { CommandLineAction, type ICommandLineActionOptions } from '@rushstack/ts-command-line';
|
|
2
2
|
import { ApiModel } from '@microsoft/api-extractor-model';
|
|
3
3
|
export interface IBuildApiModelResult {
|
|
4
4
|
apiModel: ApiModel;
|
|
@@ -6,9 +6,9 @@ export interface IBuildApiModelResult {
|
|
|
6
6
|
outputFolder: string;
|
|
7
7
|
}
|
|
8
8
|
export declare abstract class BaseAction extends CommandLineAction {
|
|
9
|
-
private _inputFolderParameter;
|
|
10
|
-
private _outputFolderParameter;
|
|
11
|
-
protected
|
|
9
|
+
private readonly _inputFolderParameter;
|
|
10
|
+
private readonly _outputFolderParameter;
|
|
11
|
+
protected constructor(options: ICommandLineActionOptions);
|
|
12
12
|
protected buildApiModel(): IBuildApiModelResult;
|
|
13
13
|
private _applyInheritDoc;
|
|
14
14
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseAction.d.ts","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":"AAOA,OAAO,
|
|
1
|
+
{"version":3,"file":"BaseAction.d.ts","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,iBAAiB,EAEjB,KAAK,yBAAyB,EAC/B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,QAAQ,EAKT,MAAM,gCAAgC,CAAC;AAExC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,8BAAsB,UAAW,SAAQ,iBAAiB;IACxD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA6B;IACnE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA6B;IAEpE,SAAS,aAAa,OAAO,EAAE,yBAAyB;IAwBxD,SAAS,CAAC,aAAa,IAAI,oBAAoB;IA2B/C,OAAO,CAAC,gBAAgB;IAuCxB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;CAe3B"}
|
package/lib/cli/BaseAction.js
CHANGED
|
@@ -30,12 +30,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
31
|
exports.BaseAction = void 0;
|
|
32
32
|
const path = __importStar(require("path"));
|
|
33
|
-
const
|
|
33
|
+
const safe_1 = __importDefault(require("colors/safe"));
|
|
34
34
|
const ts_command_line_1 = require("@rushstack/ts-command-line");
|
|
35
35
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
36
36
|
const api_extractor_model_1 = require("@microsoft/api-extractor-model");
|
|
37
37
|
class BaseAction extends ts_command_line_1.CommandLineAction {
|
|
38
|
-
|
|
38
|
+
constructor(options) {
|
|
39
|
+
super(options);
|
|
39
40
|
// override
|
|
40
41
|
this._inputFolderParameter = this.defineStringParameter({
|
|
41
42
|
parameterLongName: '--input-folder',
|
|
@@ -82,7 +83,7 @@ class BaseAction extends ts_command_line_1.CommandLineAction {
|
|
|
82
83
|
// Attempt to resolve the declaration reference
|
|
83
84
|
const result = apiModel.resolveDeclarationReference(inheritDocTag.declarationReference, apiItem);
|
|
84
85
|
if (result.errorMessage) {
|
|
85
|
-
console.log(
|
|
86
|
+
console.log(safe_1.default.yellow(`Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` + result.errorMessage));
|
|
86
87
|
}
|
|
87
88
|
else {
|
|
88
89
|
if (result.resolvedApiItem instanceof api_extractor_model_1.ApiDocumentedItem &&
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseAction.js","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAE7B,
|
|
1
|
+
{"version":3,"file":"BaseAction.js","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAE7B,uDAAiC;AAEjC,gEAIoC;AACpC,oEAA0D;AAC1D,wEAMwC;AAQxC,MAAsB,UAAW,SAAQ,mCAAiB;IAIxD,YAAsB,OAAkC;QACtD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,WAAW;QACX,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACtD,iBAAiB,EAAE,gBAAgB;YACnC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,6EAA6E;gBAC7E,uCAAuC;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACvD,iBAAiB,EAAE,iBAAiB;YACpC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,sEAAsE;gBACtE,yCAAyC;gBACzC,kCAAkC,IAAI,CAAC,UAAU,GAAG;SACvD,CAAC,CAAC;IACL,CAAC;IAES,aAAa;QACrB,MAAM,QAAQ,GAAa,IAAI,8BAAQ,EAAE,CAAC;QAE1C,MAAM,WAAW,GAAW,IAAI,CAAC,qBAAqB,CAAC,KAAK,IAAI,SAAS,CAAC;QAC1E,IAAI,CAAC,8BAAU,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,WAAW,CAAC,CAAC;SACpE;QAED,MAAM,YAAY,GAAW,IAAI,CAAC,sBAAsB,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;QACzF,8BAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAEtC,KAAK,MAAM,QAAQ,IAAI,8BAAU,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE;YAClE,IAAI,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;gBACnC,MAAM,YAAY,GAAW,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC9D,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;aACpC;SACF;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE1C,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;IACjD,CAAC;IAED,sGAAsG;IACtG,sEAAsE;IACtE,2DAA2D;IACnD,gBAAgB,CAAC,OAAgB,EAAE,QAAkB;QAC3D,IAAI,OAAO,YAAY,uCAAiB,EAAE;YACxC,IAAI,OAAO,CAAC,YAAY,EAAE;gBACxB,MAAM,aAAa,GAAuC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;gBAE7F,IAAI,aAAa,IAAI,aAAa,CAAC,oBAAoB,EAAE;oBACvD,+CAA+C;oBAC/C,MAAM,MAAM,GAAuC,QAAQ,CAAC,2BAA2B,CACrF,aAAa,CAAC,oBAAoB,EAClC,OAAO,CACR,CAAC;oBAEF,IAAI,MAAM,CAAC,YAAY,EAAE;wBACvB,OAAO,CAAC,GAAG,CACT,cAAM,CAAC,MAAM,CACX,2CAA2C,OAAO,CAAC,WAAW,IAAI,GAAG,MAAM,CAAC,YAAY,CACzF,CACF,CAAC;qBACH;yBAAM;wBACL,IACE,MAAM,CAAC,eAAe,YAAY,uCAAiB;4BACnD,MAAM,CAAC,eAAe,CAAC,YAAY;4BACnC,MAAM,CAAC,eAAe,KAAK,OAAO,EAClC;4BACA,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;yBACpF;qBACF;iBACF;aACF;SACF;QAED,kBAAkB;QAClB,IAAI,2CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;YAChD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;gBACpC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aACzC;SACF;IACH,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,gBAAkC,EAAE,gBAAkC;QAC/F,gBAAgB,CAAC,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC;QAClE,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,gBAAgB,CAAC,MAAM,EAAE;YAC3C,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACpC;QACD,KAAK,MAAM,SAAS,IAAI,gBAAgB,CAAC,UAAU,EAAE;YACnD,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC5C;QACD,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,aAAa,GAAG,SAAS,CAAC;IAC7C,CAAC;CACF;AAjHD,gCAiHC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport * as tsdoc from '@microsoft/tsdoc';\nimport colors from 'colors/safe';\n\nimport {\n CommandLineAction,\n CommandLineStringParameter,\n type ICommandLineActionOptions\n} from '@rushstack/ts-command-line';\nimport { FileSystem } from '@rushstack/node-core-library';\nimport {\n ApiModel,\n ApiItem,\n ApiItemContainerMixin,\n ApiDocumentedItem,\n IResolveDeclarationReferenceResult\n} from '@microsoft/api-extractor-model';\n\nexport interface IBuildApiModelResult {\n apiModel: ApiModel;\n inputFolder: string;\n outputFolder: string;\n}\n\nexport abstract class BaseAction extends CommandLineAction {\n private readonly _inputFolderParameter: CommandLineStringParameter;\n private readonly _outputFolderParameter: CommandLineStringParameter;\n\n protected constructor(options: ICommandLineActionOptions) {\n super(options);\n\n // override\n this._inputFolderParameter = this.defineStringParameter({\n parameterLongName: '--input-folder',\n parameterShortName: '-i',\n argumentName: 'FOLDER1',\n description:\n `Specifies the input folder containing the *.api.json files to be processed.` +\n ` If omitted, the default is \"./input\"`\n });\n\n this._outputFolderParameter = this.defineStringParameter({\n parameterLongName: '--output-folder',\n parameterShortName: '-o',\n argumentName: 'FOLDER2',\n description:\n `Specifies the output folder where the documentation will be written.` +\n ` ANY EXISTING CONTENTS WILL BE DELETED!` +\n ` If omitted, the default is \"./${this.actionName}\"`\n });\n }\n\n protected buildApiModel(): IBuildApiModelResult {\n const apiModel: ApiModel = new ApiModel();\n\n const inputFolder: string = this._inputFolderParameter.value || './input';\n if (!FileSystem.exists(inputFolder)) {\n throw new Error('The input folder does not exist: ' + inputFolder);\n }\n\n const outputFolder: string = this._outputFolderParameter.value || `./${this.actionName}`;\n FileSystem.ensureFolder(outputFolder);\n\n for (const filename of FileSystem.readFolderItemNames(inputFolder)) {\n if (filename.match(/\\.api\\.json$/i)) {\n console.log(`Reading ${filename}`);\n const filenamePath: string = path.join(inputFolder, filename);\n apiModel.loadPackage(filenamePath);\n }\n }\n\n this._applyInheritDoc(apiModel, apiModel);\n\n return { apiModel, inputFolder, outputFolder };\n }\n\n // TODO: This is a temporary workaround. The long term plan is for API Extractor's DocCommentEnhancer\n // to apply all @inheritDoc tags before the .api.json file is written.\n // See DocCommentEnhancer._applyInheritDoc() for more info.\n private _applyInheritDoc(apiItem: ApiItem, apiModel: ApiModel): void {\n if (apiItem instanceof ApiDocumentedItem) {\n if (apiItem.tsdocComment) {\n const inheritDocTag: tsdoc.DocInheritDocTag | undefined = apiItem.tsdocComment.inheritDocTag;\n\n if (inheritDocTag && inheritDocTag.declarationReference) {\n // Attempt to resolve the declaration reference\n const result: IResolveDeclarationReferenceResult = apiModel.resolveDeclarationReference(\n inheritDocTag.declarationReference,\n apiItem\n );\n\n if (result.errorMessage) {\n console.log(\n colors.yellow(\n `Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` + result.errorMessage\n )\n );\n } else {\n if (\n result.resolvedApiItem instanceof ApiDocumentedItem &&\n result.resolvedApiItem.tsdocComment &&\n result.resolvedApiItem !== apiItem\n ) {\n this._copyInheritedDocs(apiItem.tsdocComment, result.resolvedApiItem.tsdocComment);\n }\n }\n }\n }\n }\n\n // Recurse members\n if (ApiItemContainerMixin.isBaseClassOf(apiItem)) {\n for (const member of apiItem.members) {\n this._applyInheritDoc(member, apiModel);\n }\n }\n }\n\n /**\n * Copy the content from `sourceDocComment` to `targetDocComment`.\n * This code is borrowed from DocCommentEnhancer as a temporary workaround.\n */\n private _copyInheritedDocs(targetDocComment: tsdoc.DocComment, sourceDocComment: tsdoc.DocComment): void {\n targetDocComment.summarySection = sourceDocComment.summarySection;\n targetDocComment.remarksBlock = sourceDocComment.remarksBlock;\n\n targetDocComment.params.clear();\n for (const param of sourceDocComment.params) {\n targetDocComment.params.add(param);\n }\n for (const typeParam of sourceDocComment.typeParams) {\n targetDocComment.typeParams.add(typeParam);\n }\n targetDocComment.returnsBlock = sourceDocComment.returnsBlock;\n\n targetDocComment.inheritDocTag = undefined;\n }\n}\n"]}
|
package/lib/cli/YamlAction.d.ts
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
|
|
2
2
|
import { BaseAction } from './BaseAction';
|
|
3
3
|
export declare class YamlAction extends BaseAction {
|
|
4
|
-
private _officeParameter;
|
|
5
|
-
private _newDocfxNamespacesParameter;
|
|
6
|
-
private _yamlFormatParameter;
|
|
4
|
+
private readonly _officeParameter;
|
|
5
|
+
private readonly _newDocfxNamespacesParameter;
|
|
6
|
+
private readonly _yamlFormatParameter;
|
|
7
7
|
constructor(parser: ApiDocumenterCommandLine);
|
|
8
|
-
protected onDefineParameters(): void;
|
|
9
8
|
protected onExecute(): Promise<void>;
|
|
10
9
|
}
|
|
11
10
|
//# sourceMappingURL=YamlAction.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"YamlAction.d.ts","sourceRoot":"","sources":["../../src/cli/YamlAction.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,gBAAgB,
|
|
1
|
+
{"version":3,"file":"YamlAction.d.ts","sourceRoot":"","sources":["../../src/cli/YamlAction.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2B;IAC5D,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAA2B;IACxE,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA6B;gBAE/C,MAAM,EAAE,wBAAwB;cAiCnC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;CAc3C"}
|
package/lib/cli/YamlAction.js
CHANGED
|
@@ -15,10 +15,6 @@ class YamlAction extends BaseAction_1.BaseAction {
|
|
|
15
15
|
' to the universal reference YAML format, which is used by the docs.microsoft.com' +
|
|
16
16
|
' pipeline.'
|
|
17
17
|
});
|
|
18
|
-
}
|
|
19
|
-
onDefineParameters() {
|
|
20
|
-
// override
|
|
21
|
-
super.onDefineParameters();
|
|
22
18
|
this._officeParameter = this.defineFlagParameter({
|
|
23
19
|
parameterLongName: '--office',
|
|
24
20
|
description: `Enables some additional features specific to Office Add-ins`
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"YamlAction.js","sourceRoot":"","sources":["../../src/cli/YamlAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAK3D,6CAA0C;AAE1C,kEAA+D;AAC/D,8EAA2E;AAE3E,MAAa,UAAW,SAAQ,uBAAU;IAKxC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,MAAM;YAClB,OAAO,EAAE,kEAAkE;YAC3E,aAAa,EACX,iEAAiE;gBACjE,kFAAkF;gBAClF,YAAY;SACf,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"YamlAction.js","sourceRoot":"","sources":["../../src/cli/YamlAction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAK3D,6CAA0C;AAE1C,kEAA+D;AAC/D,8EAA2E;AAE3E,MAAa,UAAW,SAAQ,uBAAU;IAKxC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,MAAM;YAClB,OAAO,EAAE,kEAAkE;YAC3E,aAAa,EACX,iEAAiE;gBACjE,kFAAkF;gBAClF,YAAY;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC/C,iBAAiB,EAAE,UAAU;YAC7B,WAAW,EAAE,6DAA6D;SAC3E,CAAC,CAAC;QACH,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC3D,iBAAiB,EAAE,wBAAwB;YAC3C,WAAW,EACT,mGAAmG;gBACnG,oGAAoG;gBACpG,4GAA4G;gBAC5G,0EAA0E;SAC7E,CAAC,CAAC;QACH,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACrD,iBAAiB,EAAE,eAAe;YAClC,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YAC5B,YAAY,EAAE,KAAK;YACnB,WAAW,EACT,6GAA6G;gBAC7G,yFAAyF;gBACzF,uDAAuD;SAC1D,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,SAAS;QACvB,WAAW;QACX,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAErE,MAAM,cAAc,GAAmB,IAAI,CAAC,gBAAgB,CAAC,KAAK;YAChE,CAAC,CAAC,IAAI,2CAAoB,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC;YAC1F,CAAC,CAAC,IAAI,+BAAc,CAChB,QAAQ,EACR,IAAI,CAAC,4BAA4B,CAAC,KAAK,EACvC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAChC,CAAC;QAEN,cAAc,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;CACF;AApDD,gCAoDC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { CommandLineFlagParameter, CommandLineChoiceParameter } from '@rushstack/ts-command-line';\n\nimport { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';\nimport { BaseAction } from './BaseAction';\n\nimport { YamlDocumenter } from '../documenters/YamlDocumenter';\nimport { OfficeYamlDocumenter } from '../documenters/OfficeYamlDocumenter';\n\nexport class YamlAction extends BaseAction {\n private readonly _officeParameter: CommandLineFlagParameter;\n private readonly _newDocfxNamespacesParameter: CommandLineFlagParameter;\n private readonly _yamlFormatParameter: CommandLineChoiceParameter;\n\n public constructor(parser: ApiDocumenterCommandLine) {\n super({\n actionName: 'yaml',\n summary: 'Generate documentation as universal reference YAML files (*.yml)',\n documentation:\n 'Generates API documentation as a collection of files conforming' +\n ' to the universal reference YAML format, which is used by the docs.microsoft.com' +\n ' pipeline.'\n });\n\n this._officeParameter = this.defineFlagParameter({\n parameterLongName: '--office',\n description: `Enables some additional features specific to Office Add-ins`\n });\n this._newDocfxNamespacesParameter = this.defineFlagParameter({\n parameterLongName: '--new-docfx-namespaces',\n description:\n `This enables an experimental feature that will be officially released with the next major version` +\n ` of API Documenter. It requires DocFX 2.46 or newer. It enables documentation for namespaces and` +\n ` adds them to the table of contents. This will also affect file layout as namespaced items will be nested` +\n ` under a directory for the namespace instead of just within the package.`\n });\n this._yamlFormatParameter = this.defineChoiceParameter({\n parameterLongName: '--yaml-format',\n alternatives: ['udp', 'sdp'],\n defaultValue: 'sdp',\n description:\n `Specifies the YAML format - udp or sdp. Universal Document Processor (udp) should be used if you generating` +\n ` YAML files for DocFX 2.x. Schema Driven Processor (sdp) should be used with DocFX 3.x.` +\n ` NOTE: This parameter is ignored if you use --office.`\n });\n }\n\n protected async onExecute(): Promise<void> {\n // override\n const { apiModel, inputFolder, outputFolder } = this.buildApiModel();\n\n const yamlDocumenter: YamlDocumenter = this._officeParameter.value\n ? new OfficeYamlDocumenter(apiModel, inputFolder, this._newDocfxNamespacesParameter.value)\n : new YamlDocumenter(\n apiModel,\n this._newDocfxNamespacesParameter.value,\n this._yamlFormatParameter.value\n );\n\n yamlDocumenter.generateFiles(outputFolder);\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/api-documenter",
|
|
3
|
-
"version": "7.19.
|
|
3
|
+
"version": "7.19.23",
|
|
4
4
|
"description": "Read JSON files from api-extractor, generate documentation pages",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,18 +15,18 @@
|
|
|
15
15
|
"main": "lib/index.js",
|
|
16
16
|
"typings": "dist/rollup.d.ts",
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@microsoft/api-extractor-model": "7.25.
|
|
19
|
-
"@microsoft/tsdoc": "0.14.
|
|
18
|
+
"@microsoft/api-extractor-model": "7.25.2",
|
|
19
|
+
"@microsoft/tsdoc": "0.14.2",
|
|
20
20
|
"@rushstack/node-core-library": "3.53.2",
|
|
21
|
-
"@rushstack/ts-command-line": "4.
|
|
21
|
+
"@rushstack/ts-command-line": "4.13.0",
|
|
22
22
|
"colors": "~1.2.1",
|
|
23
23
|
"js-yaml": "~3.13.1",
|
|
24
24
|
"resolve": "~1.17.0"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"@rushstack/eslint-config": "3.1.1",
|
|
28
|
-
"@rushstack/heft": "0.48.
|
|
29
|
-
"@rushstack/heft-node-rig": "1.11.
|
|
28
|
+
"@rushstack/heft": "0.48.7",
|
|
29
|
+
"@rushstack/heft-node-rig": "1.11.7",
|
|
30
30
|
"@types/heft-jest": "1.0.1",
|
|
31
31
|
"@types/js-yaml": "3.12.1",
|
|
32
32
|
"@types/node": "12.20.24",
|