vite-plugin-s3 v1.0.2

Upgrading to 1.0.0

There are breaking changes in the latest release of 1.0.0

You must use the named import now for the plugin instead of the default export.

import { viteS3 } from 'vite-plugin-s3';

This plugin will upload all built assets to s3.

This package was heavily inspired by webpack-s3-plugin and also Laravel vapor's asset deployment.

Install Instructions

$ npm i vite-plugin-s3

$ yarn add vite-plugin-s3

Import vite-plugin-s3 in your vite config file and add it as a vite plugin.

import { viteS3 } from 'vite-plugin-s3';

export default defineConfig({
    plugins: [
        viteS3({
            s3Options: {
                accessKeyId: process.env.AWS_ACCESS_KEY_ID,
                secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
                region: 'us-east-1'
            },
            s3UploadOptions: {
                Bucket: 'dist-cdn',
            },
        }),
    ]
});

Config Example

viteS3({
    exclude: /.*\.img/,
    include: /.*\.js$/,
    uploadEnabled: !!process.env.UPLOAD_ENABLED,
    s3Options: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
        region: 'us-east-1'
    },
    s3UploadOptions: {
        Bucket: 'dist-cdn',
    },
    basePath: 'production',
})

Options

Example Usage

$ UPLOAD_ENABLED=true AWS_ACCESS_KEY_ID=******* AWS_SECRET_ACCESS_KEY=******** yarn prod