From e79b23d38bbf9a051873f137bca9d9e3e7b3c8fc Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 11 Sep 2021 19:10:16 +0200 Subject: [PATCH] api-extractor: drop special handling of @component Signed-off-by: Patrik Oldsberg --- scripts/api-extractor.ts | 16 +--------------- tsdoc.json | 10 ---------- 2 files changed, 1 insertion(+), 25 deletions(-) delete mode 100644 tsdoc.json diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 413d8e888e..93e68a460a 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -32,7 +32,6 @@ import { ExtractorLogLevel, } from '@microsoft/api-extractor'; import { DocNode, IDocNodeContainerParameters } from '@microsoft/tsdoc'; -import { TSDocConfigFile } from '@microsoft/tsdoc-config'; import { ApiPackage, ApiModel } from '@microsoft/api-extractor-model'; import { MarkdownDocumenter } from '@microsoft/api-documenter/lib/documenters/MarkdownDocumenter'; import { CustomMarkdownEmitter } from '@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter'; @@ -154,11 +153,6 @@ async function runApiExtraction({ const projectFolder = resolvePath(__dirname, '..', packageDir); const packageFolder = resolvePath(__dirname, '../dist-types', packageDir); - const tsdocConf = TSDocConfigFile.loadFile( - resolvePath(__dirname, '../tsdoc.json'), - ); - tsdocConf.setSupportForTag('@component', true); - const extractorConfig = ExtractorConfig.prepare({ configObject: { mainEntryPointFilePath: resolvePath(packageFolder, 'src/index.d.ts'), @@ -220,7 +214,6 @@ async function runApiExtraction({ }, configObjectFullPath: projectFolder, packageJsonFullPath: resolvePath(projectFolder, 'package.json'), - tsdocConfigFile: tsdocConf, }); // The `packageFolder` needs to point to the location within `dist-types` in order for relative @@ -308,11 +301,6 @@ async function runApiExtraction({ } } -function isComponentMember(member: any) { - // React components are annotated with @component, and we want to skip those - return Boolean(member.docComment.match(/\n\s*\**\s*@component/m)); -} - async function buildDocs({ inputDir, outputDir, @@ -334,9 +322,7 @@ async function buildDocs({ const newModel = new ApiModel(); for (const serialized of serializedPackages) { - serialized.members[0].members = serialized.members[0].members.filter( - member => !isComponentMember(member), - ); + // Add any docs filtering logic here const pkg = ApiPackage.deserialize( serialized, diff --git a/tsdoc.json b/tsdoc.json deleted file mode 100644 index c19ba9f22b..0000000000 --- a/tsdoc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"], - "tagDefinitions": [ - { - "tagName": "@component", - "syntaxKind": "modifier" - } - ] -}