包详细信息

vite-plugin-static-copy

sapphi-red3.6mMIT3.1.4

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

vite, vite-plugin

自述文件

vite-plugin-static-copy

npm version CI MIT License

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 tinyglobby 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

Options

See options.ts.

Debug

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

DEBUG=vite:plugin-static-copy npm run dev

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);
  • 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

3.1.4

Patch Changes

  • #204 d0b5370 Thanks @stianjensen! - Removed fs-extra dependency in favor of node:fs. This should not affect the behavior.

3.1.3

Patch Changes

3.1.2

Patch Changes

3.1.1

Patch Changes

  • #186 fc84156 Thanks @sapphi-red! - fix a bug that the content was not sent when multiple vite-plugin-static-copy instance was used

3.1.0

Minor Changes

3.0.2

Patch Changes

3.0.1

Patch Changes

  • #166 60409c5 Thanks @sapphi-red! - fix absolute destination paths in copy targets incorrectly returning contents in dev

  • #164 337f976 Thanks @sapphi-red! - fixes case-insensitive path conflicts causing copy failures (EEXIST error)

3.0.0

Major Changes

  • #150 71f4f5b Thanks @sapphi-red! - migrate fast-glob to tinyglobby to reduce the package size and to align with Vite. This breaking change should not affect most users. Check Vite's migration guide%20and%20incremental%20braces%20(%7B2..8..2%7D%20%E2%87%92%20%5B%272%27%2C%20%274%27%2C%20%276%27%2C%20%278%27%5D)%20are%20no%20longer%20supported%20in%20globs.>) for more details.

2.3.1

Patch Changes

2.3.0

Minor Changes

  • 281f5b2 Thanks @sapphi-red! - improve performance by coping files concurrently when possible

Patch Changes

2.2.0

Minor Changes

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

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

1.0.4

Patch Changes

1.0.3

Patch Changes

1.0.2

Patch Changes

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

Patch Changes