vite-plugin-static-copy weekly downloads statistics

vite-plugin-static-copy

rollup-plugin-copy for Vite with dev server support.

[!NOTE] Before you use this plugin, consider using public directory or import in JavaScript. In most cases, these will work.

Install

Usage

Add viteStaticCopy plugin to vite.config.js / vite.config.ts.

For example, if you use the config above, you will be able to fetch bin/example.wasm with fetch('/wasm-files/example.wasm'). So the file will be copied to dist/wasm-files/example.wasm.

[!WARNING]

If you are using Windows, make sure to use normalizePath after doing path.resolve or else. \ is a escape charactor in tinyglobby and you should use /.

Options

See options.ts.

Debug

You can enable detailed logging by setting the DEBUG environment variable:

When debug logging is enabled, the plugin will output which file is served from each URL.

Differences with rollup-plugin-copy

• Faster dev server start-up than using rollup-plugin-copy on buildStart hook. • Files are not copied and served directly from the server during dev to reduce start-up time. • dest is relative to build.outDir. • If you are going to copy files outside build.outDir, you could use rollup-plugin-copy instead. Because that does not require dev server support. • tinyglobby is used instead of globby. • Because tinyglobby is used inside vite. • transform could return null as a way to tell the plugin not to copy the file, this is similar to the CopyWebpackPlugin#filter option, but it expects transform to return the original content in case you want it to be copied. • transform can optionally be an object, with a handler property (with the same signature of the rollup-plugin-copy transform option) and an encoding property (BufferEncoding | 'buffer') that will be used to read the file content so that the handler's content argument will reflect the correct encoding (could be Buffer); • Directory structure is always preserved in the output (similar to flatten: false in rollup-plugin-copy). Use rename: { stripBase: true } for flat copy.

Description from the npm listing.