Clean

The Clean plugin removes files and directories before generating new icons. This ensures your output directory only contains the icons you've configured, without leftover files from previous runs.

Usage

import { clean } from "@monicon/core/plugins";
import { MoniconConfig } from "@monicon/core";

export default {
  icons: ["mdi:home", "lucide:heart"],
  plugins: [clean({ patterns: ["src/components/icons"] })],
} satisfies MoniconConfig;

Options

patterns

An array of glob patterns to match files and directories for removal.

• Type: string[]
• Required: Yes

import { clean } from "@monicon/core/plugins";

clean({
  patterns: [
    "src/components/icons", // Remove entire directory
    "components/icons/**/*.tsx", // Remove specific file types
  ],
});

enabled

Enable or disable the clean plugin.

• Type: boolean
• Default: true

import { clean } from "@monicon/core/plugins";

clean({
  patterns: ["src/components/icons"],
  enabled: process.env.NODE_ENV === "production",
});

Why Use Clean?

Without the Clean plugin, old icon files might remain in your output directory even after removing them from your configuration. This can lead to:

• Stale files - Icons you no longer use still exist in your codebase
• Import errors - Imports may resolve to old files
• Larger builds - Unnecessary files increase bundle size
• Confusion - Hard to know which icons are actually in use

Conditional Cleaning

You can conditionally enable cleaning based on environment:

import { clean } from "@monicon/core/plugins";
import { MoniconConfig } from "@monicon/core";

export default {
  icons: ["mdi:home"],
  plugins: [
    clean({
      patterns: ["src/components/icons"],
      // Only clean in development
      enabled: process.env.NODE_ENV !== "production",
    }),
  ],
} satisfies MoniconConfig;