README.md

Cleanup Plugin

By deleting the out folder before each new build, the plugin ensures a clean output directory for the build process.

Add a ⭐ to this repository — it motivates me a lot!

⚡️ Getting started

Simply install this package with your package manager.

npm install -D esbuild-plugin-cleanup

📦 other package manager

Here are examples for installing the package with other package manager.

💾 yarn

yarn add -D esbuild-plugin-cleanup

💾 pnpm

pnpm install -D esbuild-plugin-cleanup

Looks good so far 🔥 — now you have installed the latest version!

💡 Introduction

This esbuild plugin automatically deletes the previous build before generating a new one, keeping your output directory clean.

It runs a pre-build cleanup step to prevent outdated files from cluttering your project. With minimal configuration, it simplifies workflows and ensures only the latest assets remain.

🔧 Usage

cleanupPlugin(options);

This function needs to be called inside the esbuild configuration in order to use this plugin. It will provide the plugin inside the build process of esbuild.

Show an example of the integration

esbuild.build({
  // some configuration...
  plugins: [
    cleanupPlugin();
    // more plugins here...
  ]
})

Show an example of the configuration

cleanupPlugin({
  // configure here
});

Properties

overrideOut

Default: undefined (esbuild's output directory)

A string, that specifies the output directory, that'll be cleaned up.

Show an example

cleanupPlugin({
  overrideOut: "dist" // any directory allowed
});

Returns

Type: Plugin

An instance of this plugin, that will be used by esbuild automatically.

License

The MIT License (MIT) - Please have a look at the License file for more details.

Contributing

Want to contribute to an open-source project on GitHub but unsure where to start? Check out this comprehensive step-by-step guide on how to contribute effectively!

From forking the repository to creating pull requests, this guide walks you through every stage of the process, helping you make a successful contribution to this GitHub project. Start collaborating, learn new skills, and make an impact on this project!

See here for the contribute guide at GitHub.

---

GitHub @simonkovtyk