Skip to content

Commit

Permalink
docs: fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
sapphi-red committed May 1, 2023
1 parent a046ddc commit 112c7c5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![npm version](https://badge.fury.io/js/vite-plugin-static-copy.svg)](https://badge.fury.io/js/vite-plugin-static-copy) ![CI](https://github.com/sapphi-red/vite-plugin-static-copy/workflows/CI/badge.svg) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

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

> **Note**
> Before you use this plugin, consider using [public directory](https://vitejs.dev/guide/assets.html#the-public-directory) or [`import` in JavaScript](https://vitejs.dev/guide/features.html#static-assets).
Expand Down Expand Up @@ -42,16 +42,16 @@ 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 `/`.
> `\` is a escape charactor in `fast-glob` and you should use `/`.
>
> ```js
> import { normalizePath } from 'vite'
> import path from 'node:path'
>
> normalizePath(path.resolve(__dirname, './foo'))
> normalizePath(path.resolve(__dirname, './foo')) // C:/project/foo
>
> // instead of
> path.resolve(__dirname, './foo')
> path.resolve(__dirname, './foo') // C:\project\foo
> ```
>
> See [`fast-glob` documentation about this](https://github.com/mrmlnc/fast-glob#how-to-write-patterns-on-windows) for more details.
Expand All @@ -62,11 +62,11 @@ See [options.ts](https://github.com/sapphi-red/vite-plugin-static-copy/blob/main

## 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 server during dev to reduce start up time.
- 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`](https://vitejs.dev/config/build-options.html#build-outdir).
- If you are going to copy files outside `build.outDir`, you could use `rollup-plugin-copy` instead. Because that will not require dev server support.
- 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`](https://www.npmjs.com/package/fast-glob) is used instead of [`globby`](https://www.npmjs.com/package/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](https://webpack.js.org/plugins/copy-webpack-plugin/#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 a `encoding` property (`BufferEncoding | 'buffer'`) that will be used to read the file content so that `handler`'s content argument will reflect the correct encoding (could be Buffer);
- `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);

0 comments on commit 112c7c5

Please sign in to comment.