vite-plugin-cloudflare-redirect

Vite plugin to handle Cloudflare's _redirects file following https://developers.cloudflare.com/pages/platform/redirects/.

Usage

parse mode

Parse a _redirects file at /public (or following the publicDir config) like this:

# /public/_redirects
/foo https://example.com 302

// vite.config.js
import { defineConfig } from 'vite'
import { cloudflareRedirect } from '@ryoppippi/vite-plugin-cloudflare-redirect'

export default defineConfig({
    plugins: [
        cloudflareRedirect({
            mode: "parse",
            redirectsFilePath: './custom/_redirects' // optional. If not specified, this plugin parses the default public or static directory from vite config.
        })
    ]
})

By default if no options are passed, the plugin would try to load from /public/_redirects (from publicDir config). If the file isn't found, no redirects will happen. Pass the redirectsFile option to specify a custom path.

generate mode

Generate a _redirects file to /public (or following the publicDir config) from the entries option.

// vite.config.ts
import { defineConfig } from 'vite'
import { cloudflareRedirect } from '@ryoppippi/vite-plugin-cloudflare-redirect'

export default defineConfig({
    plugins: [
        cloudflareRedirect({
            mode: "generate",
            redirectsFilePath: './public/_redirects', // optional
            entries: [
                { from: '/foo', to: 'https://example.com', status: 302 },
                // ...
            ]
        })
    ],
})

License

MIT