About vite-plugin
@editframe/vite-plugin adds local development support for Vite projects building Editframe compositions, including on-demand video processing and visual regression testing without cloud API dependencies.
Key features
- 01On-demand video transcoding
- 02Local image and caption serving
- 03Vitest visual regression comparisons
- 04Transcoded asset caching and clearing
Use cases
- 01Developing Editframe compositions locally
- 02Checking visual changes with Vitest
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ editframe/ skills --skill vite-pluginAfter installing, type/vite-pluginin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/file-api.mdgetting-started.mdjit-transcoding.mdlocal-assets.mdvisual-testing.mdDetails
From the project READMEVite Plugin
The @editframe/vite-plugin adds local development capabilities to your Vite project. It handles on-demand video transcoding, local asset serving, and visual regression testing so you can develop Editframe compositions without cloud API dependencies.
Features
- JIT Video Transcoding — Videos are transcoded to streamable format on first request and cached for subsequent loads
- Local Asset Serving — Images and captions are served locally with caching
- Visual Testing — Image comparison tools for visual regression tests with Vitest
- Cache Management — Automatic caching of transcoded assets with cache-clearing support
Installation
npm install @editframe/vite-plugin
Configuration
// vite.config.ts
import { defineConfig } from "vite";
import { vitePluginEditframe } from "@editframe/vite-plugin";
export default defineConfig({
plugins: [
vitePluginEditframe({
root: "./src", // Base directory for resolving file paths
cacheRoot: "./cache", // Directory for cached transcoded assets
}),
],
});
Comments
Markdown supported