From a3010f737eba8c4e8de1a9874ac2b432160a11bc Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 08:22:38 -0700 Subject: [PATCH 01/23] adds tsdoc-config and updates tsdoc to have compatible type signatures --- apps/api-extractor/package.json | 1 + common/config/rush/browser-approved-packages.json | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index 2ebc2a6315b..1e89864cf8b 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -35,6 +35,7 @@ }, "dependencies": { "@microsoft/api-extractor-model": "workspace:*", + "@microsoft/tsdoc-config": "~0.13.4", "@microsoft/tsdoc": "0.12.24", "@rushstack/node-core-library": "workspace:*", "@rushstack/rig-package": "workspace:*", diff --git a/common/config/rush/browser-approved-packages.json b/common/config/rush/browser-approved-packages.json index 5e3f614e8b6..85219dc4491 100644 --- a/common/config/rush/browser-approved-packages.json +++ b/common/config/rush/browser-approved-packages.json @@ -9,6 +9,10 @@ { "name": "react-dom", "allowedCategories": [ "tests" ] + }, + { + "name": "@microsoft/tsdoc-config", + "allowedCategories": [ "libraries" ] } ] } From 03b0127998e8c63127eaf544ce94e2810543bdd7 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 08:58:56 -0700 Subject: [PATCH 02/23] construct tsdoc configuration in ExtractorConfig --- apps/api-extractor/src/api/ExtractorConfig.ts | 19 +++++++++++++++++++ apps/api-extractor/src/collector/Collector.ts | 9 ++++++--- apps/api-extractor/tsdoc.json | 17 +++++++++++++++++ common/reviews/api/api-extractor.api.md | 2 ++ 4 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 apps/api-extractor/tsdoc.json diff --git a/apps/api-extractor/src/api/ExtractorConfig.ts b/apps/api-extractor/src/api/ExtractorConfig.ts index ecf7fbff4ff..04635caa0a9 100644 --- a/apps/api-extractor/src/api/ExtractorConfig.ts +++ b/apps/api-extractor/src/api/ExtractorConfig.ts @@ -21,6 +21,8 @@ import { RigConfig } from '@rushstack/rig-package'; import { IConfigFile, IExtractorMessagesConfig } from './IConfigFile'; import { PackageMetadataManager } from '../analyzer/PackageMetadataManager'; import { MessageRouter } from '../collector/MessageRouter'; +import { TSDocConfiguration } from '@microsoft/tsdoc'; +import { TSDocConfigFile } from '@microsoft/tsdoc-config'; /** * Tokens used during variable expansion of path fields from api-extractor.json. @@ -149,6 +151,7 @@ interface IExtractorConfigParameters { omitTrimmingComments: boolean; tsdocMetadataEnabled: boolean; tsdocMetadataFilePath: string; + tsdocConfiguration: TSDocConfiguration; newlineKind: NewlineKind; messages: IExtractorMessagesConfig; testMode: boolean; @@ -236,6 +239,11 @@ export class ExtractorConfig { /** {@inheritDoc IConfigTsdocMetadata.tsdocMetadataFilePath} */ public readonly tsdocMetadataFilePath: string; + /** + * The TSDocConfiguration to use for parsing TSDoc comments + */ + public readonly tsdocConfiguration: TSDocConfiguration; + /** * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files * will be written with Windows-style newlines. @@ -269,6 +277,7 @@ export class ExtractorConfig { this.omitTrimmingComments = parameters.omitTrimmingComments; this.tsdocMetadataEnabled = parameters.tsdocMetadataEnabled; this.tsdocMetadataFilePath = parameters.tsdocMetadataFilePath; + this.tsdocConfiguration = parameters.tsdocConfiguration; this.newlineKind = parameters.newlineKind; this.messages = parameters.messages; this.testMode = parameters.testMode; @@ -901,6 +910,15 @@ export class ExtractorConfig { break; } + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadForFolder(__filename); + + if (tsdocConfigFile.hasErrors) { + throw new Error(tsdocConfigFile.getErrorSummary()); + } + + const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration(); + tsdocConfigFile.configureParser(tsdocConfiguration); + return new ExtractorConfig({ projectFolder: projectFolder, packageJson, @@ -922,6 +940,7 @@ export class ExtractorConfig { omitTrimmingComments, tsdocMetadataEnabled, tsdocMetadataFilePath, + tsdocConfiguration, newlineKind, messages: configObject.messages || {}, testMode: !!configObject.testMode diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts index 70bb262a18a..99e3147ec38 100644 --- a/apps/api-extractor/src/collector/Collector.ts +++ b/apps/api-extractor/src/collector/Collector.ts @@ -4,7 +4,7 @@ import * as ts from 'typescript'; import * as tsdoc from '@microsoft/tsdoc'; import { PackageJsonLookup, Sort, InternalError } from '@rushstack/node-core-library'; -import { ReleaseTag, AedocDefinitions } from '@microsoft/api-extractor-model'; +import { ReleaseTag } from '@microsoft/api-extractor-model'; import { ExtractorMessageId } from '../api/ExtractorMessageId'; @@ -120,7 +120,7 @@ export class Collector { this.typeChecker = options.program.getTypeChecker(); this.globalVariableAnalyzer = TypeScriptInternals.getGlobalVariableAnalyzer(this.program); - this._tsdocParser = new tsdoc.TSDocParser(AedocDefinitions.tsdocConfiguration); + this._tsdocParser = new tsdoc.TSDocParser(this.extractorConfig.tsdocConfiguration); this.bundledPackageNames = new Set(this.extractorConfig.bundledPackages); @@ -716,8 +716,11 @@ export class Collector { options.isOverride = modifierTagSet.isOverride(); options.isSealed = modifierTagSet.isSealed(); options.isVirtual = modifierTagSet.isVirtual(); + const preapprovedTag: tsdoc.TSDocTagDefinition | void = this.extractorConfig.tsdocConfiguration.tryGetTagDefinition( + '@preapproved' + ); - if (modifierTagSet.hasTag(AedocDefinitions.preapprovedTag)) { + if (preapprovedTag && modifierTagSet.hasTag(preapprovedTag)) { // This feature only makes sense for potentially big declarations. switch (astDeclaration.declaration.kind) { case ts.SyntaxKind.ClassDeclaration: diff --git a/apps/api-extractor/tsdoc.json b/apps/api-extractor/tsdoc.json new file mode 100644 index 00000000000..673f724ebfd --- /dev/null +++ b/apps/api-extractor/tsdoc.json @@ -0,0 +1,17 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "tagDefinitions": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ] +} diff --git a/common/reviews/api/api-extractor.api.md b/common/reviews/api/api-extractor.api.md index ed8969c22d0..dd791a82ff5 100644 --- a/common/reviews/api/api-extractor.api.md +++ b/common/reviews/api/api-extractor.api.md @@ -10,6 +10,7 @@ import { NewlineKind } from '@rushstack/node-core-library'; import { PackageJsonLookup } from '@rushstack/node-core-library'; import { RigConfig } from '@rushstack/rig-package'; import * as tsdoc from '@microsoft/tsdoc'; +import { TSDocConfiguration } from '@microsoft/tsdoc'; // @public export class CompilerState { @@ -72,6 +73,7 @@ export class ExtractorConfig { readonly testMode: boolean; static tryLoadForFolder(options: IExtractorConfigLoadForFolderOptions): IExtractorConfigPrepareOptions | undefined; readonly tsconfigFilePath: string; + readonly tsdocConfiguration: TSDocConfiguration; readonly tsdocMetadataEnabled: boolean; readonly tsdocMetadataFilePath: string; readonly untrimmedFilePath: string; From ff63440aa507cf625350cefe6987f50ebae1f651 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 13:26:02 -0700 Subject: [PATCH 03/23] wire tsdocConfiguration throughout the api-extractor --- apps/api-extractor/src/api/Extractor.ts | 3 ++- apps/api-extractor/src/collector/MessageRouter.ts | 7 +++++-- apps/api-extractor/src/enhancers/DocCommentEnhancer.ts | 4 ++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/apps/api-extractor/src/api/Extractor.ts b/apps/api-extractor/src/api/Extractor.ts index 6d7e4a96da2..e91e3acac64 100644 --- a/apps/api-extractor/src/api/Extractor.ts +++ b/apps/api-extractor/src/api/Extractor.ts @@ -205,7 +205,8 @@ export class Extractor { messageCallback: options.messageCallback, messagesConfig: extractorConfig.messages || {}, showVerboseMessages: !!options.showVerboseMessages, - showDiagnostics: !!options.showDiagnostics + showDiagnostics: !!options.showDiagnostics, + tsdocConfiguration: extractorConfig.tsdocConfiguration }); this._checkCompilerCompatibility(extractorConfig, messageRouter); diff --git a/apps/api-extractor/src/collector/MessageRouter.ts b/apps/api-extractor/src/collector/MessageRouter.ts index 9d2609b25e9..2f3106b65b1 100644 --- a/apps/api-extractor/src/collector/MessageRouter.ts +++ b/apps/api-extractor/src/collector/MessageRouter.ts @@ -5,7 +5,6 @@ import colors from 'colors'; import * as ts from 'typescript'; import * as tsdoc from '@microsoft/tsdoc'; import { Sort, InternalError, LegacyAdapters } from '@rushstack/node-core-library'; -import { AedocDefinitions } from '@microsoft/api-extractor-model'; import { AstDeclaration } from '../analyzer/AstDeclaration'; import { AstSymbol } from '../analyzer/AstSymbol'; @@ -32,6 +31,7 @@ export interface IMessageRouterOptions { messagesConfig: IExtractorMessagesConfig; showVerboseMessages: boolean; showDiagnostics: boolean; + tsdocConfiguration: tsdoc.TSDocConfiguration; } export class MessageRouter { @@ -49,6 +49,8 @@ export class MessageRouter { private readonly _sourceMapper: SourceMapper; + private readonly _tsdocConfiguration: tsdoc.TSDocConfiguration; + // Normalized representation of the routing rules from api-extractor.json private _reportingRuleByMessageId: Map = new Map(); private _compilerDefaultRule: IReportingRule = { @@ -81,6 +83,7 @@ export class MessageRouter { this._messages = []; this._associatedMessagesForAstDeclaration = new Map(); this._sourceMapper = new SourceMapper(); + this._tsdocConfiguration = options.tsdocConfiguration; // showDiagnostics implies showVerboseMessages this.showVerboseMessages = options.showVerboseMessages || options.showDiagnostics; @@ -149,7 +152,7 @@ export class MessageRouter { `Error in API Extractor config: The messages.tsdocMessageReporting table contains` + ` an invalid entry "${messageId}". The name should begin with the "tsdoc-" prefix.` ); - } else if (!AedocDefinitions.tsdocConfiguration.isKnownMessageId(messageId)) { + } else if (!this._tsdocConfiguration.isKnownMessageId(messageId)) { throw new Error( `Error in API Extractor config: The messages.tsdocMessageReporting table contains` + ` an unrecognized identifier "${messageId}". Is it spelled correctly?` diff --git a/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts b/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts index 75e6863ef48..eda5c0c48f8 100644 --- a/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts +++ b/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts @@ -8,7 +8,7 @@ import { Collector } from '../collector/Collector'; import { AstSymbol } from '../analyzer/AstSymbol'; import { AstDeclaration } from '../analyzer/AstDeclaration'; import { ApiItemMetadata } from '../collector/ApiItemMetadata'; -import { AedocDefinitions, ReleaseTag } from '@microsoft/api-extractor-model'; +import { ReleaseTag } from '@microsoft/api-extractor-model'; import { ExtractorMessageId } from '../api/ExtractorMessageId'; import { VisitorState } from '../collector/VisitorState'; import { ResolverFailure } from '../analyzer/AstReferenceResolver'; @@ -74,7 +74,7 @@ export class DocCommentEnhancer { // The class that contains this constructor const classDeclaration: AstDeclaration = astDeclaration.parent!; - const configuration: tsdoc.TSDocConfiguration = AedocDefinitions.tsdocConfiguration; + const configuration: tsdoc.TSDocConfiguration = this._collector.extractorConfig.tsdocConfiguration; if (!metadata.tsdocComment) { metadata.tsdocComment = new tsdoc.DocComment({ configuration }); From 5451da74462e0698948ea1e2b5546b1b4120a933 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 17:39:34 -0700 Subject: [PATCH 04/23] remove references to AedocDefinitions and replace with configurable tags implementation --- .../src/aedoc/AedocDefinitions.ts | 1 + .../src/items/ApiDocumentedItem.ts | 17 +++++++++-- .../src/model/ApiPackage.ts | 28 +++++++++++++++++-- .../src/model/DeserializerContext.ts | 5 ++++ apps/api-extractor/src/api/ExtractorConfig.ts | 5 +++- .../src/generators/ApiModelGenerator.ts | 14 +++++++++- 6 files changed, 63 insertions(+), 7 deletions(-) diff --git a/apps/api-extractor-model/src/aedoc/AedocDefinitions.ts b/apps/api-extractor-model/src/aedoc/AedocDefinitions.ts index 36abf321929..a639404d66a 100644 --- a/apps/api-extractor-model/src/aedoc/AedocDefinitions.ts +++ b/apps/api-extractor-model/src/aedoc/AedocDefinitions.ts @@ -5,6 +5,7 @@ import { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, StandardTag /** * @internal + * @deprecated - tsdoc configuration is now constructed from tsdoc.json files associated with each package. */ export class AedocDefinitions { public static readonly betaDocumentation: TSDocTagDefinition = new TSDocTagDefinition({ diff --git a/apps/api-extractor-model/src/items/ApiDocumentedItem.ts b/apps/api-extractor-model/src/items/ApiDocumentedItem.ts index 2e7246fe9a1..271c14c1f22 100644 --- a/apps/api-extractor-model/src/items/ApiDocumentedItem.ts +++ b/apps/api-extractor-model/src/items/ApiDocumentedItem.ts @@ -3,7 +3,6 @@ import * as tsdoc from '@microsoft/tsdoc'; import { ApiItem, IApiItemOptions, IApiItemJson } from './ApiItem'; -import { AedocDefinitions } from '../aedoc/AedocDefinitions'; import { DeserializerContext } from '../model/DeserializerContext'; /** @@ -47,7 +46,21 @@ export class ApiDocumentedItem extends ApiItem { const documentedJson: IApiDocumentedItemJson = jsonObject as IApiDocumentedItemJson; if (documentedJson.docComment) { - const tsdocParser: tsdoc.TSDocParser = new tsdoc.TSDocParser(AedocDefinitions.tsdocConfiguration); + const tsdocConfiguration: tsdoc.TSDocConfiguration = new tsdoc.TSDocConfiguration(); + + // Set support for standard tags + tsdocConfiguration.setSupportForTags(tsdocConfiguration.tagDefinitions, true); + + if (Array.isArray(context.nonStandardTSDocTags)) { + tsdocConfiguration.addTagDefinitions( + context.nonStandardTSDocTags.map( + (tag: tsdoc.ITSDocTagDefinitionParameters) => new tsdoc.TSDocTagDefinition(tag) + ), + true + ); + } + + const tsdocParser: tsdoc.TSDocParser = new tsdoc.TSDocParser(tsdocConfiguration); // NOTE: For now, we ignore TSDoc errors found in a serialized .api.json file. // Normally these errors would have already been reported by API Extractor during analysis. diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index d3a008ba3c7..ae289f7588c 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -14,6 +14,7 @@ import { ApiDocumentedItem, IApiDocumentedItemOptions } from '../items/ApiDocume import { ApiEntryPoint } from './ApiEntryPoint'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext'; +import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; /** * Constructor options for {@link ApiPackage}. @@ -22,7 +23,12 @@ import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, - IApiDocumentedItemOptions {} + IApiDocumentedItemOptions { + /** + * Any non-standard TSDoc tag definitions the package uses. + */ + nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; +} export interface IApiPackageMetadataJson { /** @@ -58,6 +64,11 @@ export interface IApiPackageMetadataJson { * `IApiPackageMetadataJson.schemaVersion`. */ oldestForwardsCompatibleVersion?: ApiJsonSchemaVersion; + + /** + * The TSDoc tags used by the package + */ + nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; } export interface IApiPackageJson extends IApiItemJson { @@ -105,8 +116,17 @@ export interface IApiPackageSaveOptions extends IJsonFileSaveOptions { * @public */ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumentedItem)) { + /** + * Non-standard TSDoc Tags associated to the package. + */ + public readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; + public constructor(options: IApiPackageOptions) { super(options); + + if (Array.isArray(options.nonStandardTSDocTags)) { + this.nonStandardTSDocTags = options.nonStandardTSDocTags; + } } public static loadFromJsonFile(apiJsonFilename: string): ApiPackage { @@ -161,7 +181,8 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented apiJsonFilename, toolPackage: jsonObject.metadata.toolPackage, toolVersion: jsonObject.metadata.toolVersion, - versionToDeserialize: versionToDeserialize + versionToDeserialize: versionToDeserialize, + nonStandardTSDocTags: jsonObject.metadata.nonStandardTSDocTags }); return ApiItem.deserialize(jsonObject, context) as ApiPackage; @@ -208,7 +229,8 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented // the version is bumped. Instead we write a placeholder string. toolVersion: options.testMode ? '[test mode]' : options.toolVersion || packageJson.version, schemaVersion: ApiJsonSchemaVersion.LATEST, - oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE + oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE, + nonStandardTSDocTags: this.nonStandardTSDocTags } } as IApiPackageJson; this.serializeInto(jsonObject); diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts index 62fa4f81391..15a6a980cd3 100644 --- a/apps/api-extractor-model/src/model/DeserializerContext.ts +++ b/apps/api-extractor-model/src/model/DeserializerContext.ts @@ -1,6 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; + export enum ApiJsonSchemaVersion { /** * The initial release. @@ -72,10 +74,13 @@ export class DeserializerContext { */ public readonly versionToDeserialize: ApiJsonSchemaVersion; + public readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; + public constructor(options: DeserializerContext) { this.apiJsonFilename = options.apiJsonFilename; this.toolPackage = options.toolPackage; this.toolVersion = options.toolVersion; this.versionToDeserialize = options.versionToDeserialize; + this.nonStandardTSDocTags = options.nonStandardTSDocTags; } } diff --git a/apps/api-extractor/src/api/ExtractorConfig.ts b/apps/api-extractor/src/api/ExtractorConfig.ts index 04635caa0a9..39e6709b07f 100644 --- a/apps/api-extractor/src/api/ExtractorConfig.ts +++ b/apps/api-extractor/src/api/ExtractorConfig.ts @@ -910,7 +910,10 @@ export class ExtractorConfig { break; } - const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadForFolder(__filename); + const packageTSDocConfigPath: string = TSDocConfigFile.findConfigPathForFolder(projectFolder); + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadForFolder( + FileSystem.exists(packageTSDocConfigPath) ? packageTSDocConfigPath : __filename + ); if (tsdocConfigFile.hasErrors) { throw new Error(tsdocConfigFile.getErrorSummary()); diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts index 1cb36101e73..18ffc2cbf93 100644 --- a/apps/api-extractor/src/generators/ApiModelGenerator.ts +++ b/apps/api-extractor/src/generators/ApiModelGenerator.ts @@ -64,10 +64,22 @@ export class ApiModelGenerator { public buildApiPackage(): ApiPackage { const packageDocComment: tsdoc.DocComment | undefined = this._collector.workingPackage.tsdocComment; + const nonStandardTSDocTags: tsdoc.ITSDocTagDefinitionParameters[] = this._collector.extractorConfig.tsdocConfiguration.tagDefinitions + .filter((tag: tsdoc.TSDocTagDefinition) => tag.standardization === tsdoc.Standardization.None) + .map( + (tag: tsdoc.TSDocTagDefinition): tsdoc.ITSDocTagDefinitionParameters => { + return { + tagName: tag.tagName, + syntaxKind: tag.syntaxKind, + allowMultiple: tag.allowMultiple + }; + } + ); const apiPackage: ApiPackage = new ApiPackage({ name: this._collector.workingPackage.name, - docComment: packageDocComment + docComment: packageDocComment, + nonStandardTSDocTags }); this._apiModel.addMember(apiPackage); From 61bdcb6f10effb958ba45c9e9b38117fcd5dce0a Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 17:40:00 -0700 Subject: [PATCH 05/23] update test fixtures --- .../etc/api-documenter-test.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../typeOf/api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../typeOf2/api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- common/reviews/api/api-extractor-model.api.md | 5 ++++- 31 files changed, 544 insertions(+), 31 deletions(-) diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index eb7c43cf10d..0088079fbd2 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-documenter-test!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index 655d30ae318..00c473e91e1 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json index e7afa61f5ff..b09b6e1e9a6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json index 57eaf238582..314d52cbc20 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 6ff1f4fac35..997b87294ca 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json index 393a86dcafa..662a74cbda6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index 3a5b76fd8dd..0ee4b3a56e3 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index d7ed0cac8b1..041d06fe118 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index 7a6e617b407..79043c40dad 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index ee0930c3383..3a9caa31703 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index f77ec75f57e..d31aab7f080 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index 4354fcdc45c..d6a8b7bd011 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index f2b4f55952a..8fece1fa376 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index 5f9ae0b2d34..046602759ad 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 93dcfe24874..5650182cd97 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index c729a0ebc98..4fb76e66842 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index 2c8a99bd068..f6b523509e0 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index d7e603c111e..977cd2bf97f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index d7e603c111e..977cd2bf97f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index 3b7acb4d56b..d72d5d12d2d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index 97166819e35..b0af895079a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index 97166819e35..b0af895079a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json index 06c9447a2cf..27a568e0afa 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index 98d8fecbf06..aac00496ed6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 8eb17a9a6a4..5a1021462a0 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json index 436ba8d70c6..3c2e58c988e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index d7e603c111e..977cd2bf97f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index c15727f370c..e7c62d320cf 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json index 2f55e1cf757..d330a68a15f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index 5dac136f7b8..cffb35d8eae 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index 0db3f2cf0a6..b7e93fa703a 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -7,13 +7,14 @@ import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; import { DocDeclarationReference } from '@microsoft/tsdoc'; import { IJsonFileSaveOptions } from '@rushstack/node-core-library'; +import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; import * as tsdoc from '@microsoft/tsdoc'; import { TSDocConfiguration } from '@microsoft/tsdoc'; import { TSDocTagDefinition } from '@microsoft/tsdoc'; // Warning: (ae-internal-missing-underscore) The name "AedocDefinitions" should be prefixed with an underscore because the declaration is marked as @internal // -// @internal (undocumented) +// @internal @deprecated (undocumented) export class AedocDefinitions { // (undocumented) static readonly betaDocumentation: TSDocTagDefinition; @@ -443,6 +444,7 @@ export class ApiPackage extends ApiPackage_base { get kind(): ApiItemKind; // (undocumented) static loadFromJsonFile(apiJsonFilename: string): ApiPackage; + readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; // (undocumented) saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void; } @@ -745,6 +747,7 @@ export interface IApiOptionalMixinOptions extends IApiItemOptions { // @public export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions { + nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; } // @public From 6bd65e429cdc1de414d76ac3858f8f7d77cec3a7 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Fri, 19 Jun 2020 23:29:04 -0700 Subject: [PATCH 06/23] rush change results --- .../users-nirice-custom-tags_2020-06-20-06-28.json | 11 +++++++++++ .../users-nirice-custom-tags_2020-06-20-06-28.json | 11 +++++++++++ .../users-nirice-custom-tags_2020-06-20-06-28.json | 11 +++++++++++ 3 files changed, 33 insertions(+) create mode 100644 common/changes/@microsoft/api-documenter/users-nirice-custom-tags_2020-06-20-06-28.json create mode 100644 common/changes/@microsoft/api-extractor-model/users-nirice-custom-tags_2020-06-20-06-28.json create mode 100644 common/changes/@microsoft/api-extractor/users-nirice-custom-tags_2020-06-20-06-28.json diff --git a/common/changes/@microsoft/api-documenter/users-nirice-custom-tags_2020-06-20-06-28.json b/common/changes/@microsoft/api-documenter/users-nirice-custom-tags_2020-06-20-06-28.json new file mode 100644 index 00000000000..22e22be5afe --- /dev/null +++ b/common/changes/@microsoft/api-documenter/users-nirice-custom-tags_2020-06-20-06-28.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-documenter", + "comment": "Implements package-defined TSDoc tags into api-extractor", + "type": "minor" + } + ], + "packageName": "@microsoft/api-documenter", + "email": "nicholasrice@users.noreply.github.com" +} \ No newline at end of file diff --git a/common/changes/@microsoft/api-extractor-model/users-nirice-custom-tags_2020-06-20-06-28.json b/common/changes/@microsoft/api-extractor-model/users-nirice-custom-tags_2020-06-20-06-28.json new file mode 100644 index 00000000000..2fd6e3b7d78 --- /dev/null +++ b/common/changes/@microsoft/api-extractor-model/users-nirice-custom-tags_2020-06-20-06-28.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-extractor-model", + "comment": "Implements package-defined TSDoc tags in", + "type": "minor" + } + ], + "packageName": "@microsoft/api-extractor-model", + "email": "nicholasrice@users.noreply.github.com" +} \ No newline at end of file diff --git a/common/changes/@microsoft/api-extractor/users-nirice-custom-tags_2020-06-20-06-28.json b/common/changes/@microsoft/api-extractor/users-nirice-custom-tags_2020-06-20-06-28.json new file mode 100644 index 00000000000..a137a09e2d4 --- /dev/null +++ b/common/changes/@microsoft/api-extractor/users-nirice-custom-tags_2020-06-20-06-28.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-extractor", + "comment": "Implements package-defined TSDoc tags in", + "type": "minor" + } + ], + "packageName": "@microsoft/api-extractor", + "email": "nicholasrice@users.noreply.github.com" +} \ No newline at end of file From 7ef3840268a62759a4855721c89d8839f49bd749 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Mon, 29 Jun 2020 17:01:18 -0700 Subject: [PATCH 07/23] move tsdoc configuration construction to DeserializerContext --- .../src/items/ApiDocumentedItem.ts | 16 +--------------- .../src/model/ApiPackage.ts | 18 ++++++++++++++++-- .../src/model/DeserializerContext.ts | 9 ++++++--- 3 files changed, 23 insertions(+), 20 deletions(-) diff --git a/apps/api-extractor-model/src/items/ApiDocumentedItem.ts b/apps/api-extractor-model/src/items/ApiDocumentedItem.ts index 271c14c1f22..a51b514e933 100644 --- a/apps/api-extractor-model/src/items/ApiDocumentedItem.ts +++ b/apps/api-extractor-model/src/items/ApiDocumentedItem.ts @@ -46,21 +46,7 @@ export class ApiDocumentedItem extends ApiItem { const documentedJson: IApiDocumentedItemJson = jsonObject as IApiDocumentedItemJson; if (documentedJson.docComment) { - const tsdocConfiguration: tsdoc.TSDocConfiguration = new tsdoc.TSDocConfiguration(); - - // Set support for standard tags - tsdocConfiguration.setSupportForTags(tsdocConfiguration.tagDefinitions, true); - - if (Array.isArray(context.nonStandardTSDocTags)) { - tsdocConfiguration.addTagDefinitions( - context.nonStandardTSDocTags.map( - (tag: tsdoc.ITSDocTagDefinitionParameters) => new tsdoc.TSDocTagDefinition(tag) - ), - true - ); - } - - const tsdocParser: tsdoc.TSDocParser = new tsdoc.TSDocParser(tsdocConfiguration); + const tsdocParser: tsdoc.TSDocParser = new tsdoc.TSDocParser(context.tsdocConfiguration); // NOTE: For now, we ignore TSDoc errors found in a serialized .api.json file. // Normally these errors would have already been reported by API Extractor during analysis. diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index ae289f7588c..a99bc075d8a 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -14,7 +14,7 @@ import { ApiDocumentedItem, IApiDocumentedItemOptions } from '../items/ApiDocume import { ApiEntryPoint } from './ApiEntryPoint'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext'; -import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; +import { ITSDocTagDefinitionParameters, TSDocConfiguration, TSDocTagDefinition } from '@microsoft/tsdoc'; /** * Constructor options for {@link ApiPackage}. @@ -177,12 +177,26 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented } } + const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration(); + + // Set support for standard tags + tsdocConfiguration.setSupportForTags(tsdocConfiguration.tagDefinitions, true); + + if (Array.isArray(jsonObject.metadata.nonStandardTSDocTags)) { + tsdocConfiguration.addTagDefinitions( + jsonObject.metadata.nonStandardTSDocTags.map( + (tag: ITSDocTagDefinitionParameters) => new TSDocTagDefinition(tag) + ), + true + ); + } + const context: DeserializerContext = new DeserializerContext({ apiJsonFilename, toolPackage: jsonObject.metadata.toolPackage, toolVersion: jsonObject.metadata.toolVersion, versionToDeserialize: versionToDeserialize, - nonStandardTSDocTags: jsonObject.metadata.nonStandardTSDocTags + tsdocConfiguration }); return ApiItem.deserialize(jsonObject, context) as ApiPackage; diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts index 15a6a980cd3..fdfc3bc4f56 100644 --- a/apps/api-extractor-model/src/model/DeserializerContext.ts +++ b/apps/api-extractor-model/src/model/DeserializerContext.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; +import { TSDocConfiguration } from '@microsoft/tsdoc'; export enum ApiJsonSchemaVersion { /** @@ -74,13 +74,16 @@ export class DeserializerContext { */ public readonly versionToDeserialize: ApiJsonSchemaVersion; - public readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; + /** + * The TSDoc configuration for the context. + */ + public readonly tsdocConfiguration: TSDocConfiguration; public constructor(options: DeserializerContext) { this.apiJsonFilename = options.apiJsonFilename; this.toolPackage = options.toolPackage; this.toolVersion = options.toolVersion; this.versionToDeserialize = options.versionToDeserialize; - this.nonStandardTSDocTags = options.nonStandardTSDocTags; + this.tsdocConfiguration = options.tsdocConfiguration; } } From b1004b03dd4f72cc44e3606304195e39abbb0c86 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 15 Jan 2021 20:02:28 -0800 Subject: [PATCH 08/23] Bump version --- apps/api-extractor/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index 1e89864cf8b..6c6018547c5 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -35,7 +35,7 @@ }, "dependencies": { "@microsoft/api-extractor-model": "workspace:*", - "@microsoft/tsdoc-config": "~0.13.4", + "@microsoft/tsdoc-config": "~0.13.9", "@microsoft/tsdoc": "0.12.24", "@rushstack/node-core-library": "workspace:*", "@rushstack/rig-package": "workspace:*", From 26d4b2cf26686e9149d5c414035e93f3810f8750 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 15 Jan 2021 20:02:34 -0800 Subject: [PATCH 09/23] rush update --- .../rush/nonbrowser-approved-packages.json | 410 +++++++++--------- 1 file changed, 207 insertions(+), 203 deletions(-) diff --git a/common/config/rush/nonbrowser-approved-packages.json b/common/config/rush/nonbrowser-approved-packages.json index bdba6789b26..27a2eb2eb96 100644 --- a/common/config/rush/nonbrowser-approved-packages.json +++ b/common/config/rush/nonbrowser-approved-packages.json @@ -4,815 +4,819 @@ "packages": [ { "name": "@azure/identity", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@azure/storage-blob", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@jest/core", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@jest/reporters", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@jest/transform", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@jest/types", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/api-documenter", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/api-extractor", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/api-extractor-model", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build-mocha", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build-sass", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build-serve", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build-typescript", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/gulp-core-build-webpack", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/load-themed-styles", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/node-library-build", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-lib", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/rush-stack", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-2.4", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-2.7", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-2.8", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-2.9", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.0", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.1", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.2", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.3", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.4", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.5", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.6", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.7", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.8", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/rush-stack-compiler-3.9", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@microsoft/rush-stack-compiler-shared", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/sp-tslint-rules", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/teams-js", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/ts-command-line", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@microsoft/tsdoc", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] + }, + { + "name": "@microsoft/tsdoc-config", + "allowedCategories": [ "libraries" ] }, { "name": "@microsoft/web-library-build", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@pnpm/link-bins", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@pnpm/logger", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/debug-certificate-manager", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/eslint-config", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/eslint-patch", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/eslint-plugin", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/eslint-plugin-packlets", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/eslint-plugin-security", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/heft", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/heft-config-file", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/heft-node-rig", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/heft-web-rig", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/localization-plugin", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@rushstack/module-minifier-plugin", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "@rushstack/node-core-library", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/package-deps-hash", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/pre-compile-hardlink-or-copy-plugin", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/rig-package", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/set-webpack-public-path-plugin", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/stream-collator", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/terminal", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/tree-pattern", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@rushstack/ts-command-line", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "@rushstack/typings-generator", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@typescript-eslint/eslint-plugin", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@typescript-eslint/experimental-utils", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@typescript-eslint/parser", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@typescript-eslint/typescript-estree", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "@yarnpkg/lockfile", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "ajv", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "api-extractor-lib1-test", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "api-extractor-lib2-test", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "api-extractor-lib3-test", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "api-extractor-test-01", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "api-extractor-test-02", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "argparse", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "autoprefixer", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "builtin-modules", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "buttono", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "chalk", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "chokidar", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "clean-css", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "cli-table", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "colors", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "css-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "deasync", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "decache", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "decomment", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "del", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "doc-plugin-rush-stack", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "end-of-stream", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "eslint", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "eslint-plugin-promise", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "eslint-plugin-react", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "eslint-plugin-security", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "eslint-plugin-tsdoc", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "express", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "fast-glob", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "file-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "fs-extra", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "fsevents", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "git-repo-info", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "glob", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "glob-escape", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "globby", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "gulp-cache", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-changed", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-clean-css", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-clip-empty-files", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-clone", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-connect", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-decomment", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-flatten", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-if", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-istanbul", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-mocha", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-open", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-plumber", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-postcss", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-replace", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-sass", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-sourcemaps", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-texttojs", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "gulp-typescript", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "heft-action-plugin", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "heft-example-plugin-01", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "heft-example-plugin-02", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "heft-minimal-rig-test", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "html-webpack-plugin", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "https-proxy-agent", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "ignore", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "import-lazy", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "inquirer", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "istanbul-instrumenter-loader", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jest", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "jest-cli", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jest-environment-jsdom", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jest-nunit-reporter", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jest-resolve", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jest-snapshot", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jju", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "js-yaml", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jsdom", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jsonpath-plus", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "jszip", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "loader-utils", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "lodash", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "lodash.merge", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "lolex", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "long", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "md5", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "merge2", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "minimatch", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "mocha", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "node-fetch", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "node-forge", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "node-notifier", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "node-sass", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "npm-package-arg", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "npm-packlist", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "object-assign", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "orchestrator", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "postcss", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "postcss-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "postcss-modules", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "prettier", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "pretty-hrtime", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "pseudolocale", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "read-package-tree", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "resolve", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "sass-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "semver", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "source-map", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "source-map-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "ssri", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "strict-uri-encode", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "string-argv", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "strip-json-comments", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "style-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "sudo", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "tapable", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "tar", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "terser", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "through2", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "timsort", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "true-case-path", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "ts-jest", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "ts-loader", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "tslint", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "tslint-microsoft-contrib", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "typescript", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "uglify-js", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "vinyl", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "webpack", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "webpack-bundle-analyzer", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "webpack-cli", - "allowedCategories": ["tests"] + "allowedCategories": [ "tests" ] }, { "name": "webpack-dev-server", - "allowedCategories": ["libraries", "tests"] + "allowedCategories": [ "libraries", "tests" ] }, { "name": "webpack-sources", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "wordwrap", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "xml", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "xmldoc", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "yargs", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] }, { "name": "z-schema", - "allowedCategories": ["libraries"] + "allowedCategories": [ "libraries" ] } ] } From 0a5d0a44984f69976fed3a86d860c206e53aee9b Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 15 Jan 2021 20:06:14 -0800 Subject: [PATCH 10/23] rush rebuild --- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../api-extractor-scenarios.api.json | 19 ++++++++++++++++++- .../typeOf3/api-extractor-scenarios.api.json | 19 ++++++++++++++++++- 4 files changed, 72 insertions(+), 4 deletions(-) diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json index 3373b9538bf..a2c9c17cf07 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json index 618f33ef94e..c83c2846287 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json index 28990cfed4b..8813628cafd 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json index 2a684d8d695..f806195daae 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json @@ -3,7 +3,24 @@ "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 + "oldestForwardsCompatibleVersion": 1001, + "nonStandardTSDocTags": [ + { + "tagName": "@betaDocumentation", + "syntaxKind": 2, + "allowMultiple": false + }, + { + "tagName": "@internalRemarks", + "syntaxKind": 1, + "allowMultiple": false + }, + { + "tagName": "@preapproved", + "syntaxKind": 2, + "allowMultiple": false + } + ] }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", From 32b306eea7dd657bcef83d8d69bf1f22fc2bcbfc Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Mon, 22 Mar 2021 10:59:43 -0700 Subject: [PATCH 11/23] rush update --- common/config/rush/pnpm-lock.yaml | 11 +++++++++++ common/config/rush/repo-state.json | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 1596816c93d..1a7572b6f4b 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -39,6 +39,7 @@ importers: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc-config': 0.13.9 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/rig-package': link:../../libraries/rig-package '@rushstack/ts-command-line': link:../../libraries/ts-command-line @@ -60,6 +61,7 @@ importers: specifiers: '@microsoft/api-extractor-model': workspace:* '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc-config': ~0.13.9 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.23.1 '@rushstack/heft-node-rig': 0.2.0 @@ -3144,6 +3146,15 @@ packages: dev: true resolution: integrity: sha512-AxDfMpiVqh3hsqTxMEYtQoz866WB/sw/Jl0pgTLh6sMHHmIBNMd+E0pVcP9WNk8zTkr9LCphJ5SziU1C8BgZMA== + /@microsoft/tsdoc-config/0.13.9: + dependencies: + '@microsoft/tsdoc': 0.12.24 + ajv: 6.12.6 + jju: 1.4.0 + resolve: 1.19.0 + dev: false + resolution: + integrity: sha512-VqqZn+rT9f6XujFPFR2aN9XKF/fuir/IzKVzoxI0vXIzxysp4ee6S2jCakmlGFHEasibifFTsJr7IYmRPxfzYw== /@microsoft/tsdoc-config/0.14.0: dependencies: '@microsoft/tsdoc': 0.13.0 diff --git a/common/config/rush/repo-state.json b/common/config/rush/repo-state.json index 7784597fa32..5d83348b5e9 100644 --- a/common/config/rush/repo-state.json +++ b/common/config/rush/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "33032d34ac194c762c36f3665faba0f374ad3c7a", + "pnpmShrinkwrapHash": "22ebb84864cc083a3a792fef455dcb8343f9e5c0", "preferredVersionsHash": "2519e88d149a9cb84227de92c71a8d8063bdcfd4" } From 9ecc08f6733c8d8a03184a2b85a607150db410c2 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Mon, 22 Mar 2021 13:41:14 -0700 Subject: [PATCH 12/23] update tsdoc and tsdoc-config --- apps/api-documenter/package.json | 2 +- apps/api-extractor-model/package.json | 2 +- apps/api-extractor/package.json | 4 +-- common/config/rush/pnpm-lock.yaml | 30 +++++++------------ common/config/rush/repo-state.json | 2 +- .../doc-plugin-rush-stack/package.json | 2 +- 6 files changed, 17 insertions(+), 25 deletions(-) diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json index 33397f1fd76..160bc76dda6 100644 --- a/apps/api-documenter/package.json +++ b/apps/api-documenter/package.json @@ -18,7 +18,7 @@ "typings": "dist/rollup.d.ts", "dependencies": { "@microsoft/api-extractor-model": "workspace:*", - "@microsoft/tsdoc": "0.12.24", + "@microsoft/tsdoc": "0.13.0", "@rushstack/node-core-library": "workspace:*", "@rushstack/ts-command-line": "workspace:*", "colors": "~1.2.1", diff --git a/apps/api-extractor-model/package.json b/apps/api-extractor-model/package.json index e64aad397b7..f91bf4e2ab5 100644 --- a/apps/api-extractor-model/package.json +++ b/apps/api-extractor-model/package.json @@ -14,7 +14,7 @@ "build": "heft test --clean" }, "dependencies": { - "@microsoft/tsdoc": "0.12.24", + "@microsoft/tsdoc": "0.13.0", "@rushstack/node-core-library": "workspace:*" }, "devDependencies": { diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index 6c6018547c5..42d7f394a47 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -35,8 +35,8 @@ }, "dependencies": { "@microsoft/api-extractor-model": "workspace:*", - "@microsoft/tsdoc-config": "~0.13.9", - "@microsoft/tsdoc": "0.12.24", + "@microsoft/tsdoc-config": "~0.14.0", + "@microsoft/tsdoc": "0.13.0", "@rushstack/node-core-library": "workspace:*", "@rushstack/rig-package": "workspace:*", "@rushstack/ts-command-line": "workspace:*", diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 1a7572b6f4b..932117febbf 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -4,7 +4,7 @@ importers: ../../apps/api-documenter: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/ts-command-line': link:../../libraries/ts-command-line colors: 1.2.5 @@ -21,7 +21,7 @@ importers: jest: 25.4.0 specifiers: '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': workspace:* '@rushstack/heft-node-rig': workspace:* @@ -38,8 +38,8 @@ importers: ../../apps/api-extractor: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model - '@microsoft/tsdoc': 0.12.24 - '@microsoft/tsdoc-config': 0.13.9 + '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': 0.14.0 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/rig-package': link:../../libraries/rig-package '@rushstack/ts-command-line': link:../../libraries/ts-command-line @@ -60,8 +60,8 @@ importers: '@types/semver': 7.3.4 specifiers: '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 - '@microsoft/tsdoc-config': ~0.13.9 + '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': ~0.14.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.23.1 '@rushstack/heft-node-rig': 0.2.0 @@ -81,7 +81,7 @@ importers: typescript: ~4.1.3 ../../apps/api-extractor-model: dependencies: - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library devDependencies: '@rushstack/eslint-config': link:../../stack/eslint-config @@ -90,7 +90,7 @@ importers: '@types/heft-jest': 1.0.1 '@types/node': 10.17.13 specifiers: - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.23.1 '@rushstack/heft-node-rig': 0.2.0 @@ -1578,7 +1578,7 @@ importers: dependencies: '@microsoft/api-documenter': link:../../apps/api-documenter '@microsoft/api-extractor-model': link:../../apps/api-extractor-model - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library js-yaml: 3.13.1 devDependencies: @@ -1590,7 +1590,7 @@ importers: specifiers: '@microsoft/api-documenter': workspace:* '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': workspace:* '@rushstack/heft-node-rig': workspace:* @@ -3146,15 +3146,6 @@ packages: dev: true resolution: integrity: sha512-AxDfMpiVqh3hsqTxMEYtQoz866WB/sw/Jl0pgTLh6sMHHmIBNMd+E0pVcP9WNk8zTkr9LCphJ5SziU1C8BgZMA== - /@microsoft/tsdoc-config/0.13.9: - dependencies: - '@microsoft/tsdoc': 0.12.24 - ajv: 6.12.6 - jju: 1.4.0 - resolve: 1.19.0 - dev: false - resolution: - integrity: sha512-VqqZn+rT9f6XujFPFR2aN9XKF/fuir/IzKVzoxI0vXIzxysp4ee6S2jCakmlGFHEasibifFTsJr7IYmRPxfzYw== /@microsoft/tsdoc-config/0.14.0: dependencies: '@microsoft/tsdoc': 0.13.0 @@ -3164,6 +3155,7 @@ packages: resolution: integrity: sha512-KSj15FwyaxMCGJkC320rvNXxuJNCOVO02pNqIEdf5cbLakvHK8afoHTmcjdBEWl0cfBFZlMu/1DhL4VCzZq0rQ== /@microsoft/tsdoc/0.12.24: + dev: true resolution: integrity: sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg== /@microsoft/tsdoc/0.13.0: diff --git a/common/config/rush/repo-state.json b/common/config/rush/repo-state.json index 5d83348b5e9..f9a60e30091 100644 --- a/common/config/rush/repo-state.json +++ b/common/config/rush/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "22ebb84864cc083a3a792fef455dcb8343f9e5c0", + "pnpmShrinkwrapHash": "ea22a748a6e6a9766a8de6ab26684ccff600bb05", "preferredVersionsHash": "2519e88d149a9cb84227de92c71a8d8063bdcfd4" } diff --git a/repo-scripts/doc-plugin-rush-stack/package.json b/repo-scripts/doc-plugin-rush-stack/package.json index e11449e4c25..d4f1dc45d22 100644 --- a/repo-scripts/doc-plugin-rush-stack/package.json +++ b/repo-scripts/doc-plugin-rush-stack/package.json @@ -12,7 +12,7 @@ "dependencies": { "@microsoft/api-documenter": "workspace:*", "@microsoft/api-extractor-model": "workspace:*", - "@microsoft/tsdoc": "0.12.24", + "@microsoft/tsdoc": "0.13.0", "@rushstack/node-core-library": "workspace:*", "js-yaml": "~3.13.1" }, From 52829d88a4bc18b04636c46c266ae0691cdd87c6 Mon Sep 17 00:00:00 2001 From: nicholasrice Date: Tue, 23 Mar 2021 11:10:49 -0700 Subject: [PATCH 13/23] implement config emission and parsing, add test cases, and rush rebuild --- .../src/model/ApiPackage.ts | 62 ++++--- .../api/test/Extractor-custom-tags.test.ts | 58 ++++++ .../custom-tsdoc-tags/api-extractor.json | 17 ++ .../test-data/custom-tsdoc-tags/index.d.ts | 7 + .../test-data/custom-tsdoc-tags/package.json | 4 + .../test-data/custom-tsdoc-tags/tsconfig.json | 25 +++ .../test-data/custom-tsdoc-tags/tsdoc.json | 24 +++ .../src/generators/ApiModelGenerator.ts | 20 +-- apps/api-extractor/tsdoc.json | 33 +++- .../etc/api-documenter-test.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../typeOf/api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../typeOf2/api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../typeOf3/api-extractor-scenarios.api.json | 169 ++++++++++++++++-- .../api-extractor-scenarios.api.json | 169 ++++++++++++++++-- common/reviews/api/api-extractor-model.api.md | 7 +- 44 files changed, 5419 insertions(+), 584 deletions(-) create mode 100644 apps/api-extractor/src/api/test/Extractor-custom-tags.test.ts create mode 100644 apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/api-extractor.json create mode 100644 apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/index.d.ts create mode 100644 apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/package.json create mode 100644 apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsconfig.json create mode 100644 apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index a99bc075d8a..9bf50751506 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -14,7 +14,18 @@ import { ApiDocumentedItem, IApiDocumentedItemOptions } from '../items/ApiDocume import { ApiEntryPoint } from './ApiEntryPoint'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext'; -import { ITSDocTagDefinitionParameters, TSDocConfiguration, TSDocTagDefinition } from '@microsoft/tsdoc'; +import { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind } from '@microsoft/tsdoc'; + +interface ITagConfigJson { + tagName: string; + syntaxKind: 'inline' | 'block' | 'modifier'; + allowMultiple?: boolean; +} + +interface ITSDocConfigJson { + tagDefinitions: ITagConfigJson[]; + supportForTags: { [tagName: string]: boolean }; +} /** * Constructor options for {@link ApiPackage}. @@ -25,9 +36,9 @@ export interface IApiPackageOptions IApiNameMixinOptions, IApiDocumentedItemOptions { /** - * Any non-standard TSDoc tag definitions the package uses. + * The TSDoc tag definitions and support for the package */ - nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; + tsDocConfig: ITSDocConfigJson; } export interface IApiPackageMetadataJson { @@ -68,7 +79,7 @@ export interface IApiPackageMetadataJson { /** * The TSDoc tags used by the package */ - nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; + tsDocConfig: ITSDocConfigJson; } export interface IApiPackageJson extends IApiItemJson { @@ -117,16 +128,14 @@ export interface IApiPackageSaveOptions extends IJsonFileSaveOptions { */ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumentedItem)) { /** - * Non-standard TSDoc Tags associated to the package. + * TSDoc Tags for to the package. */ - public readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; + private readonly _tsdocConfig: ITSDocConfigJson; public constructor(options: IApiPackageOptions) { super(options); - if (Array.isArray(options.nonStandardTSDocTags)) { - this.nonStandardTSDocTags = options.nonStandardTSDocTags; - } + this._tsdocConfig = options.tsDocConfig; } public static loadFromJsonFile(apiJsonFilename: string): ApiPackage { @@ -178,18 +187,27 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented } const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration(); - - // Set support for standard tags - tsdocConfiguration.setSupportForTags(tsdocConfiguration.tagDefinitions, true); - - if (Array.isArray(jsonObject.metadata.nonStandardTSDocTags)) { - tsdocConfiguration.addTagDefinitions( - jsonObject.metadata.nonStandardTSDocTags.map( - (tag: ITSDocTagDefinitionParameters) => new TSDocTagDefinition(tag) - ), - true - ); - } + tsdocConfiguration.clear(true); + const { tagDefinitions, supportForTags } = jsonObject.metadata.tsDocConfig; + tsdocConfiguration.addTagDefinitions( + tagDefinitions.map((definition) => { + const { syntaxKind } = definition; + const formattedSyntaxKind: TSDocTagSyntaxKind = + syntaxKind === 'block' + ? TSDocTagSyntaxKind.BlockTag + : syntaxKind === 'inline' + ? TSDocTagSyntaxKind.InlineTag + : TSDocTagSyntaxKind.ModifierTag; + return new TSDocTagDefinition({ ...definition, syntaxKind: formattedSyntaxKind }); + }) + ); + + Object.entries(supportForTags).forEach(([name, supported]) => { + const tag: TSDocTagDefinition | undefined = tsdocConfiguration.tryGetTagDefinition(name); + if (tag) { + tsdocConfiguration.setSupportForTag(tag, supported); + } + }); const context: DeserializerContext = new DeserializerContext({ apiJsonFilename, @@ -244,7 +262,7 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented toolVersion: options.testMode ? '[test mode]' : options.toolVersion || packageJson.version, schemaVersion: ApiJsonSchemaVersion.LATEST, oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE, - nonStandardTSDocTags: this.nonStandardTSDocTags + tsDocConfig: this._tsdocConfig } } as IApiPackageJson; this.serializeInto(jsonObject); diff --git a/apps/api-extractor/src/api/test/Extractor-custom-tags.test.ts b/apps/api-extractor/src/api/test/Extractor-custom-tags.test.ts new file mode 100644 index 00000000000..720f60a6e21 --- /dev/null +++ b/apps/api-extractor/src/api/test/Extractor-custom-tags.test.ts @@ -0,0 +1,58 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. +// See LICENSE in the project root for license information. + +import { StandardTags } from '@microsoft/tsdoc'; +import * as path from 'path'; + +import { ExtractorConfig } from '../ExtractorConfig'; + +const testDataFolder: string = path.join(__dirname, 'test-data'); + +describe('Extractor-custom-tags', () => { + describe('should use a TSDocConfiguration', () => { + it.only("with custom TSDoc tags defined in the package's tsdoc.json", () => { + const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare( + path.join(testDataFolder, 'custom-tsdoc-tags/api-extractor.json') + ); + const { tsdocConfiguration } = extractorConfig; + + expect(tsdocConfiguration.tryGetTagDefinition('@block')).not.toBe(undefined); + expect(tsdocConfiguration.tryGetTagDefinition('@inline')).not.toBe(undefined); + expect(tsdocConfiguration.tryGetTagDefinition('@modifier')).not.toBe(undefined); + }); + it.only("with custom TSDoc tags enabled per the package's tsdoc.json", () => { + const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare( + path.join(testDataFolder, 'custom-tsdoc-tags/api-extractor.json') + ); + const { tsdocConfiguration } = extractorConfig; + const block = tsdocConfiguration.tryGetTagDefinition('@block')!; + const inline = tsdocConfiguration.tryGetTagDefinition('@inline')!; + const modifier = tsdocConfiguration.tryGetTagDefinition('@modifier')!; + + expect(tsdocConfiguration.isTagSupported(block)).toBe(true); + expect(tsdocConfiguration.isTagSupported(inline)).toBe(true); + expect(tsdocConfiguration.isTagSupported(modifier)).toBe(false); + }); + it.only("with standard tags and API Extractor custom tags defined and supported when the package's tsdoc.json extends API Extractor's tsdoc.json", () => { + const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare( + path.join(testDataFolder, 'custom-tsdoc-tags/api-extractor.json') + ); + const { tsdocConfiguration } = extractorConfig; + + expect(tsdocConfiguration.tryGetTagDefinition('@inline')).not.toBe(undefined); + expect(tsdocConfiguration.tryGetTagDefinition('@block')).not.toBe(undefined); + expect(tsdocConfiguration.tryGetTagDefinition('@modifier')).not.toBe(undefined); + + StandardTags.allDefinitions + .concat([ + tsdocConfiguration.tryGetTagDefinition('@betaDocumentation')!, + tsdocConfiguration.tryGetTagDefinition('@internalRemarks')!, + tsdocConfiguration.tryGetTagDefinition('@preapproved')! + ]) + .forEach((tag) => { + expect(tsdocConfiguration.tagDefinitions.includes(tag)); + expect(tsdocConfiguration.supportedTagDefinitions.includes(tag)); + }); + }); + }); +}); diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/api-extractor.json b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/api-extractor.json new file mode 100644 index 00000000000..abf864f30f5 --- /dev/null +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/api-extractor.json @@ -0,0 +1,17 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + "mainEntryPointFilePath": "/index.d.ts", + + "apiReport": { + "enabled": true + }, + + "docModel": { + "enabled": true + }, + + "dtsRollup": { + "enabled": true + } +} diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/index.d.ts b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/index.d.ts new file mode 100644 index 00000000000..8d125dc716d --- /dev/null +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/index.d.ts @@ -0,0 +1,7 @@ +/** + * @block + * + * @inline test + * @modifier + */ +interface CustomTagsTestInterface {} diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/package.json b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/package.json new file mode 100644 index 00000000000..77b62df1952 --- /dev/null +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/package.json @@ -0,0 +1,4 @@ +{ + "name": "config-lookup1", + "version": "1.0.0" +} diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsconfig.json b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsconfig.json new file mode 100644 index 00000000000..845c0343e3c --- /dev/null +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsconfig.json @@ -0,0 +1,25 @@ +{ + "$schema": "http://json.schemastore.org/tsconfig", + + "compilerOptions": { + "outDir": "lib", + "rootDir": "src", + + "forceConsistentCasingInFileNames": true, + "jsx": "react", + "declaration": true, + "sourceMap": true, + "declarationMap": true, + "inlineSources": true, + "experimentalDecorators": true, + "strictNullChecks": true, + "noUnusedLocals": true, + "types": ["heft-jest", "node"], + + "module": "commonjs", + "target": "es2017", + "lib": ["es2017"] + }, + "include": ["src/**/*.ts", "src/**/*.tsx"], + "exclude": ["node_modules", "lib"] +} diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json new file mode 100644 index 00000000000..767ec8d0b01 --- /dev/null +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "extends": ["../../../../../tsdoc.json"], + "tagDefinitions": [ + { + "tagName": "@block", + "syntaxKind": "block" + }, + { + "tagName": "@inline", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@modifier", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@block": true, + "@inline": true, + "@modifier": false + } +} diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts index 18ffc2cbf93..f7f84c11337 100644 --- a/apps/api-extractor/src/generators/ApiModelGenerator.ts +++ b/apps/api-extractor/src/generators/ApiModelGenerator.ts @@ -30,7 +30,8 @@ import { ApiVariable, ApiTypeAlias, ApiCallSignature, - IApiTypeParameterOptions + IApiTypeParameterOptions, + IApiPackageOptions } from '@microsoft/api-extractor-model'; import { Collector } from '../collector/Collector'; @@ -40,6 +41,7 @@ import { AstSymbol } from '../analyzer/AstSymbol'; import { DeclarationReferenceGenerator } from './DeclarationReferenceGenerator'; import { ApiItemMetadata } from '../collector/ApiItemMetadata'; import { DeclarationMetadata } from '../collector/DeclarationMetadata'; +import { TSDocConfigFile } from '@microsoft/tsdoc-config'; export class ApiModelGenerator { private readonly _collector: Collector; @@ -64,22 +66,14 @@ export class ApiModelGenerator { public buildApiPackage(): ApiPackage { const packageDocComment: tsdoc.DocComment | undefined = this._collector.workingPackage.tsdocComment; - const nonStandardTSDocTags: tsdoc.ITSDocTagDefinitionParameters[] = this._collector.extractorConfig.tsdocConfiguration.tagDefinitions - .filter((tag: tsdoc.TSDocTagDefinition) => tag.standardization === tsdoc.Standardization.None) - .map( - (tag: tsdoc.TSDocTagDefinition): tsdoc.ITSDocTagDefinitionParameters => { - return { - tagName: tag.tagName, - syntaxKind: tag.syntaxKind, - allowMultiple: tag.allowMultiple - }; - } - ); + const tsDocConfig: IApiPackageOptions['tsDocConfig'] = TSDocConfigFile.loadFromParser( + this._collector.extractorConfig.tsdocConfiguration + ).saveToObject() as IApiPackageOptions['tsDocConfig']; const apiPackage: ApiPackage = new ApiPackage({ name: this._collector.workingPackage.name, docComment: packageDocComment, - nonStandardTSDocTags + tsDocConfig }); this._apiModel.addMember(apiPackage); diff --git a/apps/api-extractor/tsdoc.json b/apps/api-extractor/tsdoc.json index 673f724ebfd..5269cdd09c5 100644 --- a/apps/api-extractor/tsdoc.json +++ b/apps/api-extractor/tsdoc.json @@ -13,5 +13,36 @@ "tagName": "@preapproved", "syntaxKind": "modifier" } - ] + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + } } diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 0088079fbd2..ab731c528a5 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-documenter-test!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index 00c473e91e1..476b7be0c4b 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json index b09b6e1e9a6..9fab05f4238 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json index 314d52cbc20..c4b2cf7061f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 997b87294ca..54dbd12c75f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json index 662a74cbda6..86501f231d5 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index 0ee4b3a56e3..5f010f59753 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index 041d06fe118..70953d62518 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index 79043c40dad..b9c1c5a29b6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index 3a9caa31703..f9da0227d09 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index d31aab7f080..bf6856a4c09 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index d6a8b7bd011..21d2918fc9f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index 8fece1fa376..7b25391ecac 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index 046602759ad..7cb7fc6efa4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 5650182cd97..1cb730a9729 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json index a2c9c17cf07..6d8a9424d99 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index 4fb76e66842..761ad5e3bf7 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index f6b523509e0..413677c040e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index 977cd2bf97f..5a667c4252d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index 977cd2bf97f..5a667c4252d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json index c83c2846287..77f92826513 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index d72d5d12d2d..251e5b070ab 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index b0af895079a..7510d0b41ed 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index b0af895079a..7510d0b41ed 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json index 27a568e0afa..b9ddf90a9f8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index aac00496ed6..a88cbbaa28e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json index 8813628cafd..a654163d74e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 5a1021462a0..1907fb01614 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json index 3c2e58c988e..baa415c254c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index 977cd2bf97f..5a667c4252d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index e7c62d320cf..9b626606122 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json index d330a68a15f..ea3d283754c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json index f806195daae..87dc41e8657 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index cffb35d8eae..95f33c5b7b5 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -4,23 +4,160 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "nonStandardTSDocTags": [ - { - "tagName": "@betaDocumentation", - "syntaxKind": 2, - "allowMultiple": false - }, - { - "tagName": "@internalRemarks", - "syntaxKind": 1, - "allowMultiple": false - }, - { - "tagName": "@preapproved", - "syntaxKind": 2, - "allowMultiple": false + "tsDocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true } - ] + } }, "kind": "Package", "canonicalReference": "api-extractor-scenarios!", diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index b7e93fa703a..a6d2784f826 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -7,7 +7,6 @@ import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; import { DocDeclarationReference } from '@microsoft/tsdoc'; import { IJsonFileSaveOptions } from '@rushstack/node-core-library'; -import { ITSDocTagDefinitionParameters } from '@microsoft/tsdoc'; import * as tsdoc from '@microsoft/tsdoc'; import { TSDocConfiguration } from '@microsoft/tsdoc'; import { TSDocTagDefinition } from '@microsoft/tsdoc'; @@ -444,10 +443,9 @@ export class ApiPackage extends ApiPackage_base { get kind(): ApiItemKind; // (undocumented) static loadFromJsonFile(apiJsonFilename: string): ApiPackage; - readonly nonStandardTSDocTags: ITSDocTagDefinitionParameters[] | void; // (undocumented) saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void; -} + } // @public export function ApiParameterListMixin(baseClass: TBaseClass): TBaseClass & (new (...args: any[]) => ApiParameterListMixin); @@ -747,7 +745,8 @@ export interface IApiOptionalMixinOptions extends IApiItemOptions { // @public export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions { - nonStandardTSDocTags?: ITSDocTagDefinitionParameters[]; + // Warning: (ae-forgotten-export) The symbol "ITSDocConfigJson" needs to be exported by the entry point index.d.ts + tsDocConfig: ITSDocConfigJson; } // @public From 7d49b39790201a044ef311f596d3b75067a64fc0 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 12:18:16 -0500 Subject: [PATCH 14/23] rush update --- common/config/rush/pnpm-lock.yaml | 32 ++++++++++-------------------- common/config/rush/repo-state.json | 2 +- 2 files changed, 12 insertions(+), 22 deletions(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 1cf5a043c75..dd1a2dcb1f2 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -4,7 +4,7 @@ importers: ../../apps/api-documenter: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/ts-command-line': link:../../libraries/ts-command-line colors: 1.2.5 @@ -21,7 +21,7 @@ importers: jest: 25.4.0 specifiers: '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': workspace:* '@rushstack/heft-node-rig': workspace:* @@ -38,7 +38,8 @@ importers: ../../apps/api-extractor: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': 0.14.0 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/rig-package': link:../../libraries/rig-package '@rushstack/ts-command-line': link:../../libraries/ts-command-line @@ -59,7 +60,8 @@ importers: '@types/semver': 7.3.4 specifiers: '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': ~0.14.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.28.0 '@rushstack/heft-node-rig': 1.0.8 @@ -79,7 +81,7 @@ importers: typescript: ~4.1.3 ../../apps/api-extractor-model: dependencies: - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library devDependencies: '@rushstack/eslint-config': link:../../stack/eslint-config @@ -88,7 +90,7 @@ importers: '@types/heft-jest': 1.0.1 '@types/node': 10.17.13 specifiers: - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.28.0 '@rushstack/heft-node-rig': 1.0.8 @@ -707,7 +709,6 @@ importers: '@types/heft-jest': 1.0.1 '@types/webpack-env': 1.13.0 eslint: 7.12.1 - file-loader: 6.0.0 tslint: 5.20.1_typescript@3.9.9 tslint-microsoft-contrib: 6.2.0_tslint@5.20.1+typescript@3.9.9 typescript: 3.9.9 @@ -718,7 +719,6 @@ importers: '@types/heft-jest': 1.0.1 '@types/webpack-env': 1.13.0 eslint: ~7.12.1 - file-loader: ~6.0.0 tslint: ~5.20.1 tslint-microsoft-contrib: ~6.2.0 typescript: ~3.9.7 @@ -1635,7 +1635,7 @@ importers: dependencies: '@microsoft/api-documenter': link:../../apps/api-documenter '@microsoft/api-extractor-model': link:../../apps/api-extractor-model - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/node-core-library': link:../../libraries/node-core-library js-yaml: 3.13.1 devDependencies: @@ -1647,7 +1647,7 @@ importers: specifiers: '@microsoft/api-documenter': workspace:* '@microsoft/api-extractor-model': workspace:* - '@microsoft/tsdoc': 0.12.24 + '@microsoft/tsdoc': 0.13.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': workspace:* '@rushstack/heft-node-rig': workspace:* @@ -3216,6 +3216,7 @@ packages: resolution: integrity: sha512-KSj15FwyaxMCGJkC320rvNXxuJNCOVO02pNqIEdf5cbLakvHK8afoHTmcjdBEWl0cfBFZlMu/1DhL4VCzZq0rQ== /@microsoft/tsdoc/0.12.24: + dev: true resolution: integrity: sha512-Mfmij13RUTmHEMi9vRUhMXD7rnGR2VvxeNYtaGtaJ4redwwjT4UXYJ+nzmVJF7hhd4pn/Fx5sncDKxMVFJSWPg== /@microsoft/tsdoc/0.13.0: @@ -7032,17 +7033,6 @@ packages: node: '>=4' resolution: integrity: sha512-bCg29ictuBaKUwwArK4ouCaqDgLZcysCFLmM/Yn/FDoqndh/9vNuQfXRDvTuXKLxfD/JtZQGKFT8MGcJBK644g== - /file-loader/6.0.0: - dependencies: - loader-utils: 2.0.0 - schema-utils: 2.7.1 - dev: true - engines: - node: '>= 10.13.0' - peerDependencies: - webpack: ^4.0.0 || ^5.0.0 - resolution: - integrity: sha512-/aMOAYEFXDdjG0wytpTL5YQLfZnnTmLNjn+AIrJ/6HVnTfDqLsVKUUwkDf4I4kgex36BvjuXEn/TX9B/1ESyqQ== /file-loader/6.0.0_webpack@4.44.2: dependencies: loader-utils: 2.0.0 diff --git a/common/config/rush/repo-state.json b/common/config/rush/repo-state.json index cb1b2d9da6a..01c9740759b 100644 --- a/common/config/rush/repo-state.json +++ b/common/config/rush/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "57c902edfe142f4d61707e91696df7aea34825f0", + "pnpmShrinkwrapHash": "45b4390cb50382e8203616e001620f3680ccfbc1", "preferredVersionsHash": "6a96c5550f3ce50aa19e8d1141c6c5d4176953ff" } From 9bbf43fee37c9738cfab2e9f8f3dce9ad8890fbf Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 16:26:48 -0700 Subject: [PATCH 15/23] Upgrade to tsdoc-config 0.15.0 which adds the loadFromObject() API --- apps/api-extractor/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index b38be012b2e..df1e59aaeb0 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -35,7 +35,7 @@ }, "dependencies": { "@microsoft/api-extractor-model": "workspace:*", - "@microsoft/tsdoc-config": "~0.14.0", + "@microsoft/tsdoc-config": "~0.15.0", "@microsoft/tsdoc": "0.13.0", "@rushstack/node-core-library": "workspace:*", "@rushstack/rig-package": "workspace:*", From ad628a8ef8f467b008f44b4c1a11154d799c8984 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 16:26:56 -0700 Subject: [PATCH 16/23] rush update --- common/config/rush/pnpm-lock.yaml | 13 +++++++++++-- common/config/rush/repo-state.json | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index dd1a2dcb1f2..342f397bf37 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -39,7 +39,7 @@ importers: dependencies: '@microsoft/api-extractor-model': link:../api-extractor-model '@microsoft/tsdoc': 0.13.0 - '@microsoft/tsdoc-config': 0.14.0 + '@microsoft/tsdoc-config': 0.15.0 '@rushstack/node-core-library': link:../../libraries/node-core-library '@rushstack/rig-package': link:../../libraries/rig-package '@rushstack/ts-command-line': link:../../libraries/ts-command-line @@ -61,7 +61,7 @@ importers: specifiers: '@microsoft/api-extractor-model': workspace:* '@microsoft/tsdoc': 0.13.0 - '@microsoft/tsdoc-config': ~0.14.0 + '@microsoft/tsdoc-config': ~0.15.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.28.0 '@rushstack/heft-node-rig': 1.0.8 @@ -3215,6 +3215,15 @@ packages: resolve: 1.19.0 resolution: integrity: sha512-KSj15FwyaxMCGJkC320rvNXxuJNCOVO02pNqIEdf5cbLakvHK8afoHTmcjdBEWl0cfBFZlMu/1DhL4VCzZq0rQ== + /@microsoft/tsdoc-config/0.15.0: + dependencies: + '@microsoft/tsdoc': 0.13.0 + ajv: 6.12.6 + jju: 1.4.0 + resolve: 1.19.0 + dev: false + resolution: + integrity: sha512-bd8CLWwB61cfXO3f5Vm6mlt/9pBVWaYWc5EV+jKRf332DhWv6QVqJ48sIatjqeQEyYEYhM0XMHFrO2Rj/n+NHw== /@microsoft/tsdoc/0.12.24: dev: true resolution: diff --git a/common/config/rush/repo-state.json b/common/config/rush/repo-state.json index 01c9740759b..2ec0eb8dcef 100644 --- a/common/config/rush/repo-state.json +++ b/common/config/rush/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "45b4390cb50382e8203616e001620f3680ccfbc1", + "pnpmShrinkwrapHash": "ff20ea84a75e093c3e42487211db9f008f23db3c", "preferredVersionsHash": "6a96c5550f3ce50aa19e8d1141c6c5d4176953ff" } From 00b9aeeb64855348b07282b6355c5d08bf44e2c4 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 16:28:03 -0700 Subject: [PATCH 17/23] Move tsdoc-config to nonbrowser-approved-packages.json --- common/config/rush/browser-approved-packages.json | 4 ---- common/config/rush/nonbrowser-approved-packages.json | 4 ++++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/common/config/rush/browser-approved-packages.json b/common/config/rush/browser-approved-packages.json index 85219dc4491..5e3f614e8b6 100644 --- a/common/config/rush/browser-approved-packages.json +++ b/common/config/rush/browser-approved-packages.json @@ -9,10 +9,6 @@ { "name": "react-dom", "allowedCategories": [ "tests" ] - }, - { - "name": "@microsoft/tsdoc-config", - "allowedCategories": [ "libraries" ] } ] } diff --git a/common/config/rush/nonbrowser-approved-packages.json b/common/config/rush/nonbrowser-approved-packages.json index dd37f30e3e6..c69192e14d7 100644 --- a/common/config/rush/nonbrowser-approved-packages.json +++ b/common/config/rush/nonbrowser-approved-packages.json @@ -154,6 +154,10 @@ "name": "@microsoft/tsdoc", "allowedCategories": [ "libraries" ] }, + { + "name": "@microsoft/tsdoc-config", + "allowedCategories": [ "libraries" ] + }, { "name": "@microsoft/web-library-build", "allowedCategories": [ "libraries", "tests" ] From ff5f10896d56b886fe40663bfea39af55319f35c Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 17:30:47 -0700 Subject: [PATCH 18/23] rush update --- common/config/rush/pnpm-lock.yaml | 2 ++ common/config/rush/repo-state.json | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 342f397bf37..a6c41a3666b 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -82,6 +82,7 @@ importers: ../../apps/api-extractor-model: dependencies: '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': 0.15.0 '@rushstack/node-core-library': link:../../libraries/node-core-library devDependencies: '@rushstack/eslint-config': link:../../stack/eslint-config @@ -91,6 +92,7 @@ importers: '@types/node': 10.17.13 specifiers: '@microsoft/tsdoc': 0.13.0 + '@microsoft/tsdoc-config': ~0.15.0 '@rushstack/eslint-config': workspace:* '@rushstack/heft': 0.28.0 '@rushstack/heft-node-rig': 1.0.8 diff --git a/common/config/rush/repo-state.json b/common/config/rush/repo-state.json index 2ec0eb8dcef..62def759d76 100644 --- a/common/config/rush/repo-state.json +++ b/common/config/rush/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "ff20ea84a75e093c3e42487211db9f008f23db3c", + "pnpmShrinkwrapHash": "6bfab918b192701d2a201e04b9446b0ac6cb0fc6", "preferredVersionsHash": "6a96c5550f3ce50aa19e8d1141c6c5d4176953ff" } From bbcbe92a17d3b7b7831fece43832e54e75870c6c Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 17:31:29 -0700 Subject: [PATCH 19/23] Use TSConfigFile.loadFromObject() to deserialize the TSDoc configuration --- apps/api-extractor-model/package.json | 1 + .../src/model/ApiPackage.ts | 83 +++++++++---------- .../src/generators/ApiModelGenerator.ts | 9 +- .../etc/api-documenter-test.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../typeOf/api-extractor-scenarios.api.json | 2 +- .../typeOf2/api-extractor-scenarios.api.json | 2 +- .../typeOf3/api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- common/reviews/api/api-extractor-model.api.md | 5 +- 38 files changed, 77 insertions(+), 89 deletions(-) diff --git a/apps/api-extractor-model/package.json b/apps/api-extractor-model/package.json index afe0c0a61f7..a02f7e82afe 100644 --- a/apps/api-extractor-model/package.json +++ b/apps/api-extractor-model/package.json @@ -15,6 +15,7 @@ }, "dependencies": { "@microsoft/tsdoc": "0.13.0", + "@microsoft/tsdoc-config": "~0.15.0", "@rushstack/node-core-library": "workspace:*" }, "devDependencies": { diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index 9bf50751506..90b3c91dec4 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -8,24 +8,15 @@ import { JsonFile, IJsonFileSaveOptions, PackageJsonLookup, - IPackageJson + IPackageJson, + JsonObject } from '@rushstack/node-core-library'; import { ApiDocumentedItem, IApiDocumentedItemOptions } from '../items/ApiDocumentedItem'; import { ApiEntryPoint } from './ApiEntryPoint'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext'; -import { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind } from '@microsoft/tsdoc'; - -interface ITagConfigJson { - tagName: string; - syntaxKind: 'inline' | 'block' | 'modifier'; - allowMultiple?: boolean; -} - -interface ITSDocConfigJson { - tagDefinitions: ITagConfigJson[]; - supportForTags: { [tagName: string]: boolean }; -} +import { TSDocConfiguration } from '@microsoft/tsdoc'; +import { TSDocConfigFile } from '@microsoft/tsdoc-config'; /** * Constructor options for {@link ApiPackage}. @@ -35,10 +26,7 @@ export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions { - /** - * The TSDoc tag definitions and support for the package - */ - tsDocConfig: ITSDocConfigJson; + tsdocConfiguration: TSDocConfiguration; } export interface IApiPackageMetadataJson { @@ -77,9 +65,15 @@ export interface IApiPackageMetadataJson { oldestForwardsCompatibleVersion?: ApiJsonSchemaVersion; /** - * The TSDoc tags used by the package + * The TSDoc configuration that was used when analyzing the API for this package. + * + * @remarks + * + * The structure of this objet is defined by the `@microsoft/tsdoc-config` library. + * Normally this configuration is loaded from the project's tsdoc.json file. It is stored + * in the .api.json file so that doc comments can be parsed accurately when loading the file. */ - tsDocConfig: ITSDocConfigJson; + tsdocConfig: JsonObject; } export interface IApiPackageJson extends IApiItemJson { @@ -127,15 +121,12 @@ export interface IApiPackageSaveOptions extends IJsonFileSaveOptions { * @public */ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumentedItem)) { - /** - * TSDoc Tags for to the package. - */ - private readonly _tsdocConfig: ITSDocConfigJson; + private readonly _tsdocConfiguration: TSDocConfiguration; public constructor(options: IApiPackageOptions) { super(options); - this._tsdocConfig = options.tsDocConfig; + this._tsdocConfiguration = options.tsdocConfiguration; } public static loadFromJsonFile(apiJsonFilename: string): ApiPackage { @@ -186,28 +177,13 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented } } + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromObject(jsonObject.metadata.tsdocConfig); + if (tsdocConfigFile.hasErrors) { + throw new Error(`Error loading ${apiJsonFilename}:\n` + tsdocConfigFile.getErrorSummary()); + } + const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration(); - tsdocConfiguration.clear(true); - const { tagDefinitions, supportForTags } = jsonObject.metadata.tsDocConfig; - tsdocConfiguration.addTagDefinitions( - tagDefinitions.map((definition) => { - const { syntaxKind } = definition; - const formattedSyntaxKind: TSDocTagSyntaxKind = - syntaxKind === 'block' - ? TSDocTagSyntaxKind.BlockTag - : syntaxKind === 'inline' - ? TSDocTagSyntaxKind.InlineTag - : TSDocTagSyntaxKind.ModifierTag; - return new TSDocTagDefinition({ ...definition, syntaxKind: formattedSyntaxKind }); - }) - ); - - Object.entries(supportForTags).forEach(([name, supported]) => { - const tag: TSDocTagDefinition | undefined = tsdocConfiguration.tryGetTagDefinition(name); - if (tag) { - tsdocConfiguration.setSupportForTag(tag, supported); - } - }); + tsdocConfigFile.configureParser(tsdocConfiguration); const context: DeserializerContext = new DeserializerContext({ apiJsonFilename, @@ -235,6 +211,18 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented return this.members as ReadonlyArray; } + /** + * The TSDoc configuration that was used when analyzing the API for this package. + * + * @remarks + * + * Normally this configuration is loaded from the project's tsdoc.json file. It is stored + * in the .api.json file so that doc comments can be parsed accurately when loading the file. + */ + public get tsdocConfiguration(): TSDocConfiguration { + return this._tsdocConfiguration; + } + /** @override */ public addMember(member: ApiEntryPoint): void { if (member.kind !== ApiItemKind.EntryPoint) { @@ -254,6 +242,9 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented const packageJson: IPackageJson = PackageJsonLookup.loadOwnPackageJson(__dirname); + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromParser(this.tsdocConfiguration); + const tsdocConfig: JsonObject = tsdocConfigFile.saveToObject(); + const jsonObject: IApiPackageJson = { metadata: { toolPackage: options.toolPackage || packageJson.name, @@ -262,7 +253,7 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented toolVersion: options.testMode ? '[test mode]' : options.toolVersion || packageJson.version, schemaVersion: ApiJsonSchemaVersion.LATEST, oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE, - tsDocConfig: this._tsdocConfig + tsdocConfig } } as IApiPackageJson; this.serializeInto(jsonObject); diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts index f7f84c11337..0f60064df7d 100644 --- a/apps/api-extractor/src/generators/ApiModelGenerator.ts +++ b/apps/api-extractor/src/generators/ApiModelGenerator.ts @@ -30,8 +30,7 @@ import { ApiVariable, ApiTypeAlias, ApiCallSignature, - IApiTypeParameterOptions, - IApiPackageOptions + IApiTypeParameterOptions } from '@microsoft/api-extractor-model'; import { Collector } from '../collector/Collector'; @@ -41,7 +40,6 @@ import { AstSymbol } from '../analyzer/AstSymbol'; import { DeclarationReferenceGenerator } from './DeclarationReferenceGenerator'; import { ApiItemMetadata } from '../collector/ApiItemMetadata'; import { DeclarationMetadata } from '../collector/DeclarationMetadata'; -import { TSDocConfigFile } from '@microsoft/tsdoc-config'; export class ApiModelGenerator { private readonly _collector: Collector; @@ -66,14 +64,11 @@ export class ApiModelGenerator { public buildApiPackage(): ApiPackage { const packageDocComment: tsdoc.DocComment | undefined = this._collector.workingPackage.tsdocComment; - const tsDocConfig: IApiPackageOptions['tsDocConfig'] = TSDocConfigFile.loadFromParser( - this._collector.extractorConfig.tsdocConfiguration - ).saveToObject() as IApiPackageOptions['tsDocConfig']; const apiPackage: ApiPackage = new ApiPackage({ name: this._collector.workingPackage.name, docComment: packageDocComment, - tsDocConfig + tsdocConfiguration: this._collector.extractorConfig.tsdocConfiguration }); this._apiModel.addMember(apiPackage); diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index ab731c528a5..7b19a7ac48e 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index 476b7be0c4b..4f82ba15028 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json index 9fab05f4238..89a305e78fb 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json index c4b2cf7061f..3a3394c54e7 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 54dbd12c75f..69b2200069d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json index 86501f231d5..0d6bcc34e40 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index 5f010f59753..6948ac011da 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index 70953d62518..90b405238fd 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index b9c1c5a29b6..f464f14f456 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index f9da0227d09..df32063dcd4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index bf6856a4c09..3342b0b5707 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index 21d2918fc9f..d4b03fb1261 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index 7b25391ecac..a65ba600b2a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index 7cb7fc6efa4..90785c8d012 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 1cb730a9729..63c463e244e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json index 6d8a9424d99..daf1a63960f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index 761ad5e3bf7..97195eef3ad 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index 413677c040e..90a58bef511 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index 5a667c4252d..a9e268e8768 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index 5a667c4252d..a9e268e8768 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json index 77f92826513..d649749a0dc 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index 251e5b070ab..c352402ca56 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index 7510d0b41ed..972ba8a77b7 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index 7510d0b41ed..972ba8a77b7 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json index b9ddf90a9f8..53e3366f8ac 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index a88cbbaa28e..146ce761279 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json index a654163d74e..3c042223ee3 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 1907fb01614..d146c6558eb 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json index baa415c254c..b3aabde9b25 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index 5a667c4252d..a9e268e8768 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index 9b626606122..43c156061d4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json index ea3d283754c..58147e75acb 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json index 87dc41e8657..3da5b124afa 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index 95f33c5b7b5..1a955ae0139 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -4,7 +4,7 @@ "toolVersion": "[test mode]", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001, - "tsDocConfig": { + "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index a6d2784f826..df66a2e872a 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -445,6 +445,7 @@ export class ApiPackage extends ApiPackage_base { static loadFromJsonFile(apiJsonFilename: string): ApiPackage; // (undocumented) saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void; + get tsdocConfiguration(): TSDocConfiguration; } // @public @@ -745,8 +746,8 @@ export interface IApiOptionalMixinOptions extends IApiItemOptions { // @public export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions { - // Warning: (ae-forgotten-export) The symbol "ITSDocConfigJson" needs to be exported by the entry point index.d.ts - tsDocConfig: ITSDocConfigJson; + // (undocumented) + tsdocConfiguration: TSDocConfiguration; } // @public From 156aed99917d6405b3d7b1116321de657e984d83 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 17:47:56 -0700 Subject: [PATCH 20/23] Increment the ApiJsonSchemaVersion and implement backwards compatibility --- .../api-extractor-model/src/model/ApiPackage.ts | 17 +++++++++++------ .../src/model/DeserializerContext.ts | 10 +++++++++- .../etc/api-documenter-test.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../exportStar/api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../importType/api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../typeOf/api-extractor-scenarios.api.json | 2 +- .../typeOf2/api-extractor-scenarios.api.json | 2 +- .../typeOf3/api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- 36 files changed, 54 insertions(+), 41 deletions(-) diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index 90b3c91dec4..961475d2891 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -177,13 +177,18 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented } } - const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromObject(jsonObject.metadata.tsdocConfig); - if (tsdocConfigFile.hasErrors) { - throw new Error(`Error loading ${apiJsonFilename}:\n` + tsdocConfigFile.getErrorSummary()); - } - const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration(); - tsdocConfigFile.configureParser(tsdocConfiguration); + + if (versionToDeserialize >= ApiJsonSchemaVersion.V_1004) { + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromObject( + jsonObject.metadata.tsdocConfig + ); + if (tsdocConfigFile.hasErrors) { + throw new Error(`Error loading ${apiJsonFilename}:\n` + tsdocConfigFile.getErrorSummary()); + } + + tsdocConfigFile.configureParser(tsdocConfiguration); + } const context: DeserializerContext = new DeserializerContext({ apiJsonFilename, diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts index fdfc3bc4f56..ca8360c1795 100644 --- a/apps/api-extractor-model/src/model/DeserializerContext.ts +++ b/apps/api-extractor-model/src/model/DeserializerContext.ts @@ -27,13 +27,21 @@ export enum ApiJsonSchemaVersion { */ V_1003 = 1003, + /** + * Add a "tsdocConfig" field that tracks the TSDoc configuration for parsing doc comments. + * + * This is not a breaking change because an older implementation will still work correctly. The + * custom tags will be skipped over by the parser. + */ + V_1004 = 1004, + /** * The current latest .api.json schema version. * * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE` * should be updated. */ - LATEST = V_1003, + LATEST = V_1004, /** * The oldest .api.json schema version that is still supported for backwards compatibility. diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 7b19a7ac48e..bc89a4c75dd 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index 4f82ba15028..85984abb750 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json index 89a305e78fb..2b2cd7c0925 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json index 3a3394c54e7..317bf77244f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ancillaryDeclarations/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 69b2200069d..67e2b248825 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json index 0d6bcc34e40..d2151d41e7a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index 6948ac011da..ca451804d42 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index 90b405238fd..7cd1378d275 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index f464f14f456..aabe2a3bd9f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index df32063dcd4..bb27f40046b 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index 3342b0b5707..268237657e2 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index d4b03fb1261..7c893440366 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index a65ba600b2a..753e9ae6641 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index 90785c8d012..e2bb254a447 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 63c463e244e..323c2b6a769 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json index daf1a63960f..431a47a6daa 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ecmaScriptPrivateFields/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index 97195eef3ad..b691c5f82b1 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index 90a58bef511..6532da7a9eb 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index a9e268e8768..3eaf8356ad8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index a9e268e8768..3eaf8356ad8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json index d649749a0dc..df6cb864e9a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternalDefault/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index c352402ca56..e1f959dc945 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index 972ba8a77b7..2e2039e5939 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index 972ba8a77b7..2e2039e5939 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json index 53e3366f8ac..fccfd0d6454 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index 146ce761279..db96b622f2d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json index 3c042223ee3..8a770cc752f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importType/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index d146c6558eb..216ed2cb128 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json index b3aabde9b25..92f62543f6b 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index a9e268e8768..3eaf8356ad8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index 43c156061d4..f40f119b3d8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json index 58147e75acb..effbbfc813e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json index 3da5b124afa..baf5d233df0 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index 1a955ae0139..b853def7775 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1003, + "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", From 8a5d5c29ac36b486b0cd030133bf4f7f29faf204 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 17:59:29 -0700 Subject: [PATCH 21/23] Move the AEDoc definitions from ./tsdoc.json --> extends/tsdoc-base.json --- apps/api-extractor/{tsdoc.json => extends/tsdoc-base.json} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename apps/api-extractor/{tsdoc.json => extends/tsdoc-base.json} (100%) diff --git a/apps/api-extractor/tsdoc.json b/apps/api-extractor/extends/tsdoc-base.json similarity index 100% rename from apps/api-extractor/tsdoc.json rename to apps/api-extractor/extends/tsdoc-base.json From f55ebc2f7b97879688143a0b44071f40165ce58e Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Fri, 16 Apr 2021 18:33:18 -0700 Subject: [PATCH 22/23] Add launch.json config for debugging Jest tests --- apps/api-extractor/.vscode/launch.json | 54 ++++++++------------------ 1 file changed, 17 insertions(+), 37 deletions(-) diff --git a/apps/api-extractor/.vscode/launch.json b/apps/api-extractor/.vscode/launch.json index c0d9e2c15ae..f81af6c2ef3 100644 --- a/apps/api-extractor/.vscode/launch.json +++ b/apps/api-extractor/.vscode/launch.json @@ -4,17 +4,23 @@ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ + { + "type": "node", + "request": "launch", + "name": "Debug Jest tests", + "program": "${workspaceFolder}/node_modules/@rushstack/heft/lib/start.js", + "cwd": "${workspaceFolder}", + "args": ["--debug", "test", "--clean"], + "console": "integratedTerminal", + "sourceMaps": true + }, { "type": "node", "request": "launch", "name": "Run in specified folder", "program": "${workspaceFolder}/lib/start.js", "cwd": "(your project path)", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -23,11 +29,7 @@ "name": "test-01", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-test-01", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -36,11 +38,7 @@ "name": "test-02", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-test-02", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -49,11 +47,7 @@ "name": "test-03", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-test-03", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -62,11 +56,7 @@ "name": "test-04", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-test-04", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -75,11 +65,7 @@ "name": "test-05", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-test-05", - "args": [ - "--debug", - "run", - "--local" - ], + "args": ["--debug", "run", "--local"], "sourceMaps": true }, { @@ -88,13 +74,7 @@ "name": "scenario", "program": "${workspaceFolder}/lib/start.js", "cwd": "${workspaceFolder}/../../build-tests/api-extractor-scenarios", - "args": [ - "--debug", - "run", - "--local", - "--config", - "./temp/configs/api-extractor-typeof.json" - ], + "args": ["--debug", "run", "--local", "--config", "./temp/configs/api-extractor-typeof.json"], "sourceMaps": true } ] From 00ed463c44e63d8714d54ef880c8b9929524b0c9 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 17 Apr 2021 09:17:20 -0700 Subject: [PATCH 23/23] Update ExtractorConfig to load tsdoc-base.json, and add an example tsdoc.json to the "api-documenter-test" project --- apps/api-extractor/.npmignore | 4 +++- apps/api-extractor/extends/tsdoc-base.json | 24 +++++++++++++++++++ apps/api-extractor/src/api/ExtractorConfig.ts | 15 ++++++++---- .../test-data/custom-tsdoc-tags/tsdoc.json | 2 +- .../etc/api-documenter-test.api.json | 9 +++++-- .../api-documenter-test/src/DocClass1.ts | 2 ++ build-tests/api-documenter-test/tsdoc.json | 15 ++++++++++++ 7 files changed, 63 insertions(+), 8 deletions(-) create mode 100644 build-tests/api-documenter-test/tsdoc.json diff --git a/apps/api-extractor/.npmignore b/apps/api-extractor/.npmignore index 302dbc5b019..7a29489cbcc 100644 --- a/apps/api-extractor/.npmignore +++ b/apps/api-extractor/.npmignore @@ -27,4 +27,6 @@ # DO NOT MODIFY THE TEMPLATE ABOVE THIS LINE #-------------------------------------------- -# (Add your project-specific overrides here) \ No newline at end of file +# (Add your project-specific overrides here) + +!/extends/*.json diff --git a/apps/api-extractor/extends/tsdoc-base.json b/apps/api-extractor/extends/tsdoc-base.json index 5269cdd09c5..0aad9822873 100644 --- a/apps/api-extractor/extends/tsdoc-base.json +++ b/apps/api-extractor/extends/tsdoc-base.json @@ -1,5 +1,25 @@ +/** + * This file defines the TSDoc custom tags for use with API Extractor. + * + * If your project has a custom tsdoc.json file, then it should use the "extends" field to + * inherit the definitions from this file. For example: + * + * ``` + * { + * "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + * "extends": [ "@microsoft/api-extractor/extends/tsdoc-config.json" ], + * . . . + * } + * ``` + * + * For details about this config file, please see: https://tsdoc.org/pages/packages/tsdoc-config/ + */ { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + + /** + * The "AEDoc" custom tags: + */ "tagDefinitions": [ { "tagName": "@betaDocumentation", @@ -14,6 +34,10 @@ "syntaxKind": "modifier" } ], + + /** + * TSDoc tags implemented by API Extractor: + */ "supportForTags": { "@alpha": true, "@beta": true, diff --git a/apps/api-extractor/src/api/ExtractorConfig.ts b/apps/api-extractor/src/api/ExtractorConfig.ts index 39e6709b07f..9703642bea7 100644 --- a/apps/api-extractor/src/api/ExtractorConfig.ts +++ b/apps/api-extractor/src/api/ExtractorConfig.ts @@ -910,10 +910,17 @@ export class ExtractorConfig { break; } - const packageTSDocConfigPath: string = TSDocConfigFile.findConfigPathForFolder(projectFolder); - const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadForFolder( - FileSystem.exists(packageTSDocConfigPath) ? packageTSDocConfigPath : __filename - ); + // Example: "my-project/tsdoc.json" + let packageTSDocConfigPath: string = TSDocConfigFile.findConfigPathForFolder(projectFolder); + + if (!packageTSDocConfigPath || !FileSystem.exists(packageTSDocConfigPath)) { + // If the project does not have a tsdoc.json config file, then use API Extractor's base file. + packageTSDocConfigPath = path.resolve(__dirname, '../../extends/tsdoc-base.json'); + if (!FileSystem.exists(packageTSDocConfigPath)) { + throw new InternalError('Unable to load the built-in TSDoc config file: ' + packageTSDocConfigPath); + } + } + const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFile(packageTSDocConfigPath); if (tsdocConfigFile.hasErrors) { throw new Error(tsdocConfigFile.getErrorSummary()); diff --git a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json index 767ec8d0b01..e744a0311bd 100644 --- a/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json +++ b/apps/api-extractor/src/api/test/test-data/custom-tsdoc-tags/tsdoc.json @@ -1,6 +1,6 @@ { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "extends": ["../../../../../tsdoc.json"], + "extends": ["../../../../../extends/tsdoc-base.json"], "tagDefinitions": [ { "tagName": "@block", diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index bc89a4c75dd..fe6c4989570 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -125,6 +125,10 @@ { "tagName": "@preapproved", "syntaxKind": "modifier" + }, + { + "tagName": "@myCustomTag", + "syntaxKind": "modifier" } ], "supportForTags": { @@ -155,7 +159,8 @@ "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, - "@preapproved": true + "@preapproved": true, + "@myCustomTag": true } } }, @@ -2204,7 +2209,7 @@ { "kind": "Class", "canonicalReference": "api-documenter-test!SystemEvent:class", - "docComment": "/**\n * A class used to exposed events.\n *\n * {@docCategory SystemEvent}\n *\n * @public\n */\n", + "docComment": "/**\n * A class used to exposed events.\n *\n * {@docCategory SystemEvent}\n *\n * @public @myCustomTag\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/build-tests/api-documenter-test/src/DocClass1.ts b/build-tests/api-documenter-test/src/DocClass1.ts index de4574ad4cb..98bce799509 100644 --- a/build-tests/api-documenter-test/src/DocClass1.ts +++ b/build-tests/api-documenter-test/src/DocClass1.ts @@ -2,6 +2,8 @@ * A class used to exposed events. * @public * {@docCategory SystemEvent} + * + * @myCustomTag */ export class SystemEvent { /** diff --git a/build-tests/api-documenter-test/tsdoc.json b/build-tests/api-documenter-test/tsdoc.json new file mode 100644 index 00000000000..b73bb8ac8af --- /dev/null +++ b/build-tests/api-documenter-test/tsdoc.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + + "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"], + + "tagDefinitions": [ + { + "tagName": "@myCustomTag", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@myCustomTag": true + } +}