@piplup/vite-plugin-cache-buster
v3.2.2
Published
Vite plugin for integrating @piplup/cache-buster with vite
Downloads
340
Maintainers
Readme
@piplup/vite-plugin-cache-buster
A Vite plugin to automatically run cache busting during the build process using @piplup/cache-buster
.
Installation
You can install the plugin via npm or yarn:
npm install -D @piplup/vite-plugin-cache-buster
# or
yarn add -D @piplup/vite-plugin-cache-buster
#or
pnpm add -D @piplup/vite-plugin-cache-buster
Usage
In your Vite configuration file (usually vite.config.js
or vite.config.ts
), import and use the plugin:
import { vitePluginCacheBuster } from '@piplup/vite-plugin-cache-buster';
export default {
// Other Vite config options...
plugins: [vitePluginCacheBuster()],
};
Options
The plugin accepts the following options:
publicDir
(string, optional): Specifies the directory containing the public files. Default ispublic
.debug
(boolean, optional): Enables debug mode. Default isfalse
.
You can pass options to the plugin when importing it:
import { vitePluginCacheBuster } from '@piplup/vite-plugin-cache-buster';
export default {
// Other Vite config options...
plugins: [vitePluginCacheBuster({ publicDir: 'custom-public' })],
};
How It Works
The plugin hooks into Vite's build process and runs the piplup-cache-buster
command from @piplup/cache-buster
during the build if it's a production build (NODE_ENV=production
) or when debug mode is enabled.
License
This plugin is open-source and available under the MIT License.