README

A plugin for espack to copy files

espack: A build tool running on esbuild
espack

@es-pack/copy-plugin

Installation

pnpm

pnpm add -D esbuild @es-pack/espack @es-pack/copy-plugin

yarn

yarn add -D esbuild @es-pack/espack @es-pack/copy-plugin

npm

npm install -D esbuild @es-pack/espack @es-pack/copy-plugin

How to use it?

This plugin can be used under the plugins section of espack builds, like the following:

export default {
    builds: [
        {
            plugins: [
                espackCopyPluginFactory({
                    basedir: './webassets',
                    assets: [
                        'favicon.ico',
                        'manifest.json',
                        'robots.txt'
                    ]
                }),
                espackCopyPluginFactory({
                    basedir: './public',
                    assets: [
                        '404.html'
                    ]
                }),
            ],
            scripts: [
                './src/index.ts'
            ]
        }
    ]
};

The plugin can be reused any number of times.

Options

basedir: The root dir to copy assets from. Defaults to the current working directory of espack.
assets: Array of assets (string paths) to copy, relative to the basedir. This entry is required.
outdir: Directory to output the copied assets into relative to espack's baseDir and the outdir of the current build. Defaults to "assets". So when the current basedir is "dist", and the outdir is "public" the plugin will default to "dist/public/assets".

Watch mode

Watch mode is implemented for the modification of asset content.
When renaming any of the assets this plugin will force stop espack, notifying you to update the assets in the plugin options, to avoid future errors related to stale configuration state.

Usage no npm install needed!