fix #10, add cleanOutput option

Author: lsmith77

README.md

@@ -152,6 +152,7 @@ plugin documentation {
 | Option | Type | Default | Description |
 |---|---|---|---|
 | `output` | `string` | ZenStack default output path | Directory to write generated docs |
+| `cleanOutput` | `boolean` | `false` | When `true`, the output directory is removed before generation to ensure a clean build (use with caution) |
 | `title` | `string` | `"Schema Documentation"` | Heading on the index page |
 | `fieldOrder` | `"declaration"` or `"alphabetical"` | `"declaration"` | How fields are ordered in tables |
 | `includeInternalModels` | `boolean` | `false` | Include models marked `@@ignore` in output |

src/generator.ts

@@ -44,6 +44,23 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
   options.genCtx = genCtx;
 
   try {
+    if (pluginOptions.cleanOutput) {
+      try {
+        const root = path.parse(outputDir).root;
+        if (outputDir === root) {
+          throw new Error('Refusing to remove root directory');
+        }
+
+        if (fs.existsSync(outputDir)) {
+          fs.rmSync(outputDir, { force: true, recursive: true });
+        }
+      } catch (error) {
+        throw new Error(
+          `Failed to clean output directory "${outputDir}": ${error instanceof Error ? error.message : String(error)}`,
+        );
+      }
+    }
+
     fs.mkdirSync(outputDir, { recursive: true });
   } catch (error) {
     throw new Error(
@@ -302,6 +319,7 @@ function resolveOutputDir(options: PluginOptions, defaultPath: string): string {
  */
 function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
   return {
+    cleanOutput: raw['cleanOutput'] === true,
     diagramEmbed: (['file', 'inline'] as const).includes(
       raw['diagramEmbed'] as 'file' | 'inline',
     )

src/types.ts

@@ -74,6 +74,10 @@ export type PluginOptions = {
    * inline in the markdown (`'inline'`). Only applies when `diagramFormat` is
    * `'svg'` or `'both'`.
    */
+  /**
+   * If true, delete the output directory before generating files.
+   */
+  cleanOutput?: boolean;
   diagramEmbed?: 'file' | 'inline';
   diagramFormat?: 'both' | 'mermaid' | 'svg';
   erdFormat?: 'both' | 'mmd' | 'svg';