OpenPolicy

Vite

Generate policy files at build time with the OpenPolicy Vite plugin

See the Generation Overview for context.

The @openpolicy/vite plugin generates policy files during the Vite build and watches for config changes in dev.

Install

bun add -D @openpolicy/vite

Setup

// vite.config.ts
import { defineConfig } from "vite";
import { openPolicy } from "@openpolicy/vite";

export default defineConfig({
  plugins: [
    openPolicy(),
  ],
});

By default this reads openpolicy.ts from the project root and writes output to public/policies/ as Markdown.

Options

openPolicy({
  configPath: "openpolicy.ts",   // path to your config file
  formats: ["markdown"],         // "markdown" | "html" | "pdf"
  outDir: "public/policies",     // output directory
})
OptionTypeDefaultDescription
configPathstring"openpolicy.ts"Path to your config file
formatsOutputFormat[]["markdown"]One or more output formats
outDirstring"public/policies"Directory to write files into

On this page