Merge pull request #296 from bra1nDump/master

Fixed ignored plugin option cleanOutputDir
typedoc2md · Feb 24, 2022 · c214012 · c214012
2 parents 33a289e + 8ffc4d2
commit c214012
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -18,6 +18,7 @@ Array [
 
 exports[`Options: should return default options 1`] = `
 Object {
+  "cleanOutputDir": true,
   "docsRoot": "docs",
   "entryDocument": "index.md",
   "entryPoints": Array [