Vite-Plugin-Copy

A vite plugin for copying dirs or files after building.

Install

1npm install @col0ring/vite-plugin-copy -D
2# or
3yarn add @col0ring/vite-plugin-copy -D

Usage

1import { defineConfig } from 'vite'
2import path from 'path'
3import viteCopyPlugin from '@col0ring/vite-plugin-copy'
4
5function resolve(relativePath: string) {
6  return path.resolve(__dirname, relativePath)
7}
8
9export default defineConfig({
10  plugins: [
11    // ...
12    viteCopyPlugin([
13      {
14        src: resolve('./dist/index.html'),
15        target: resolve('./dist/index2.html')
16      }
17    ])
18  ]
19})

The src and target options can accept arrays:

1import { defineConfig } from 'vite'
2import path from 'path'
3import viteCopyPlugin from '@col0ring/vite-plugin-copy'
4
5function resolve(relativePath: string) {
6  return path.resolve(__dirname, relativePath)
7}
8
9export default defineConfig({
10  plugins: [
11    // ...
12    viteCopyPlugin([
13      {
14        src: resolve('./dist/index.html'),
15        target: [resolve('./dist/index2.html'), resolve('./dist/index3.html')]
16      }
17    ])
18  ]
19})

1import { defineConfig } from 'vite'
2import path from 'path'
3import viteCopyPlugin from '@col0ring/vite-plugin-copy'
4
5function resolve(relativePath: string) {
6  return path.resolve(__dirname, relativePath)
7}
8
9export default defineConfig({
10  plugins: [
11    // ...
12    viteCopyPlugin([
13      {
14        src: [resolve('./dist/index.html'), resolve('./dist/assets')],
15        target: [resolve('./dist/dist2'), resolve('./dist/dist3')]
16      }
17    ])
18  ]
19})

The disk path supports glob:

1import { defineConfig } from 'vite'
2import path from 'path'
3import viteCopyPlugin from '@col0ring/vite-plugin-copy'
4
5function resolve(relativePath: string) {
6  return path.resolve(__dirname, relativePath)
7}
8
9export default defineConfig({
10  plugins: [
11    // ...
12    viteCopyPlugin([
13      {
14        // move all files in the src directory to the target directory
15        src: resolve('./dist/assets/**/*'),
16        target: resolve('./dist/assets2')
17      }
18    ])
19  ]
20})

Usually, the plugin will automatically recognize whether the copy is a directory or a file, but you can still specify it manually:

1import { defineConfig } from 'vite'
2import path from 'path'
3import viteCopyPlugin from '@col0ring/vite-plugin-copy'
4
5function resolve(relativePath: string) {
6  return path.resolve(__dirname, relativePath)
7}
8
9export default defineConfig({
10  plugins: [
11    // ...
12    viteCopyPlugin([
13      {
14        // this is a file
15        src: resolve('./dist/file'),
16        target: {
17          isDir: false,
18          path: resolve('./dist/file2')
19        }
20      }
21    ])
22  ]
23})

Delare

1function vitePluginCopy(
2  options: CopyOptions[],
3  globOptions?: glob.IOptions
4): Plugin

CopyOptions

src

• Type: string | string[]

Resource file or directory.

target

• Type: string | string[] | TargetObject | TargetObject[]

Target file or directory.

1interface TargetObject {
2  isDir?: boolean
3  path: string
4}

glob.IOptions

Custom glob configuration.