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

npm i -D vite-plugin-static-copy # yarn add -D vite-plugin-static-copy

Usage

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

// vite.config.js / vite.config.ts
import { viteStaticCopy } from 'vite-plugin-static-copy'

export default {
  plugins: [
    viteStaticCopy({
      targets: [
        {
          src: 'bin/example.wasm',
          dest: 'wasm-files'
        }
      ]
    })
  ]
}

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 fast-glob and you should use /.

import { normalizePath } from 'vite'
import path from 'node:path'

normalizePath(path.resolve(__dirname, './foo')) // C:/project/foo

// instead of
path.resolve(__dirname, './foo') // C:\project\foo

See fast-glob documentation about this for more details.

Options

See options.ts.

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.
• fast-glob is used instead of globby.
  • Because fast-glob 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);
• structured: true preserves the directory structure. This is similar to flatten: false in rollup-plugin-copy, but it covers more edge cases.

vite-plugin-static-copy

2.2.0

Minor Changes

• #141 88e513d Thanks @sapphi-red! - add Vite 6 to peer dep

2.1.0

Minor Changes

• #133 b9c09bd Thanks @rschristian! - Allows user to optionally configure when the plugin is ran by passing in a Rollup hook name

2.0.0

Major Changes

• #127 21304df Thanks @tassioFront! - feat: throw an error when does not find file

1.0.6

Patch Changes

• #121 d68aec9 Thanks @tobz1000! - The value of Content-Type header was inferred and set from the src file extension. It is now infered from the dest file extension.

1.0.5

Patch Changes

• 311ce4d Thanks @sapphi-red! - generate provenance statements for the package

1.0.4

Patch Changes

• #107 5206534 Thanks @sverben! - send headers set by server.headers in dev

1.0.3

Patch Changes

• #105 32115f0 Thanks @daihuabin! - don't crash when the requested path is mapped to a directory

1.0.2

Patch Changes

• db73fb5 Thanks @sapphi-red! - udpate mrmime to v2. align the used mime values with Vite 5.1. See https://github.com/lukeed/mrmime/releases/tag/v2.0.0 for the difference.

1.0.1

Patch Changes

• #79 19b9fca Thanks @sapphi-red! - using absolute path src with structured: true was not working. The fullPath argument in the rename option will now always be an absolute path, instead of sometimes being a relative path.

1.0.0

Major Changes

• 252f62c Thanks @sapphi-red! - drop support for Vite 3 and 4

• 252f62c Thanks @sapphi-red! - drop CJS build. See https://vitejs.dev/guide/troubleshooting.html#this-package-is-esm-only for how to migrate from CJS to ESM.

• 252f62c Thanks @sapphi-red! - drop node 14.18/16/17/19 support

Patch Changes

• #67 8707d84 Thanks @sapphi-red! - copy only once even if multiple bundles are generated