From 8ffc4d227ff36e8e869fe26eb7ec654df4500703 Mon Sep 17 00:00:00 2001 From: Kirill Dubovitskiy Date: Wed, 23 Feb 2022 18:15:59 -0800 Subject: [PATCH] Fixed ignored plugin option cleanOutputDir --- packages/docusaurus-plugin-typedoc/package.json | 2 +- packages/docusaurus-plugin-typedoc/src/options.ts | 1 + packages/docusaurus-plugin-typedoc/src/plugin.ts | 4 +++- packages/docusaurus-plugin-typedoc/src/types.ts | 1 + .../test/specs/__snapshots__/options.spec.ts.snap | 1 + 5 files changed, 7 insertions(+), 2 deletions(-) diff --git a/packages/docusaurus-plugin-typedoc/package.json b/packages/docusaurus-plugin-typedoc/package.json index 104848028..b96090b63 100644 --- a/packages/docusaurus-plugin-typedoc/package.json +++ b/packages/docusaurus-plugin-typedoc/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-plugin-typedoc", - "version": "0.17.0", + "version": "0.17.1", "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.", "main": "dist/index.js", "files": [ diff --git a/packages/docusaurus-plugin-typedoc/src/options.ts b/packages/docusaurus-plugin-typedoc/src/options.ts index 079448297..8335dba65 100644 --- a/packages/docusaurus-plugin-typedoc/src/options.ts +++ b/packages/docusaurus-plugin-typedoc/src/options.ts @@ -4,6 +4,7 @@ const DEFAULT_PLUGIN_OPTIONS: PluginOptions = { id: 'default', docsRoot: 'docs', out: 'api', + cleanOutputDir: true, sidebar: { fullNames: false, categoryLabel: 'API', diff --git a/packages/docusaurus-plugin-typedoc/src/plugin.ts b/packages/docusaurus-plugin-typedoc/src/plugin.ts index f38f6518b..c42bfa4a0 100644 --- a/packages/docusaurus-plugin-typedoc/src/plugin.ts +++ b/packages/docusaurus-plugin-typedoc/src/plugin.ts @@ -27,7 +27,9 @@ export default function pluginDocusaurus( const outputDir = path.resolve(siteDir, options.docsRoot, options.out); - removeDir(outputDir); + if (opts.cleanOutputDir) { + removeDir(outputDir); + } const app = new Application(); diff --git a/packages/docusaurus-plugin-typedoc/src/types.ts b/packages/docusaurus-plugin-typedoc/src/types.ts index 282b01a99..646d2306e 100644 --- a/packages/docusaurus-plugin-typedoc/src/types.ts +++ b/packages/docusaurus-plugin-typedoc/src/types.ts @@ -8,6 +8,7 @@ export interface PluginOptions { plugin: string[]; readme?: string; disableOutputCheck?: boolean; + cleanOutputDir?: boolean; entryPoints?: string[]; watch: boolean; hideInPageTOC: boolean; diff --git a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap index 701bbacf8..ebe1d27f1 100644 --- a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap +++ b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap @@ -18,6 +18,7 @@ Array [ exports[`Options: should return default options 1`] = ` Object { + "cleanOutputDir": true, "docsRoot": "docs", "entryDocument": "index.md", "entryPoints": Array [