https://github.com/simonkovtyk/esbuild-plugin-cleanup
By deleting the out folder before each new build, the plugin ensures a clean output directory for the build process.
https://github.com/simonkovtyk/esbuild-plugin-cleanup
build-cleaner clean-buildfiles cleanup cleanup-build cleanup-script cleanup-tool esbuild esbuild-plugin esbuild-plugins out-clean out-cleanup output-clean
Last synced: 5 months ago
JSON representation
By deleting the out folder before each new build, the plugin ensures a clean output directory for the build process.
- Host: GitHub
- URL: https://github.com/simonkovtyk/esbuild-plugin-cleanup
- Owner: simonkovtyk
- License: mit
- Created: 2024-09-13T22:54:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T16:04:58.000Z (over 1 year ago)
- Last Synced: 2025-10-10T17:58:15.856Z (8 months ago)
- Topics: build-cleaner, clean-buildfiles, cleanup, cleanup-build, cleanup-script, cleanup-tool, esbuild, esbuild-plugin, esbuild-plugins, out-clean, out-cleanup, output-clean
- Language: TypeScript
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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.
````shell
npm install -D esbuild-plugin-cleanup
````
📦 other package manager
Here are examples for installing the package with other package manager.
> 💾 **yarn**
> ````shell
> yarn add -D esbuild-plugin-cleanup
> ````
> 💾 **pnpm**
> ````shell
> 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
```typescript
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
````typescript
esbuild.build({
// some configuration...
plugins: [
cleanupPlugin();
// more plugins here...
]
})
````
Show an example of the configuration
````typescript
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
````typescript
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](https://github.com/simonkovtyk/esbuild-plugin-cleanup/blob/main/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](https://github.com/simonkovtyk/esbuild-plugin-cleanup/blob/main/docs/guides/HOW_TO_CONTRIBUTE.md) for the contribute guide at GitHub.
GitHub [@simonkovtyk](https://github.com/simonkovtyk)