vite-plugin-pilet

1.4.0 verified Mon Apr 27 auth: no javascript

Vite plugin for building pilets (micro frontends) in the Piral ecosystem. Current stable version is 1.4.0, released with provenance attestation. This plugin integrates Piral's pilet build process into Vite, enabling fast development and HMR for micro frontend modules. It supports pilet schema v3, standard Vite config files (vite.config.js/ts), and works with both ESM and CJS since v1.2.0. Key differentiators: tight integration with Piral's toolchain, automatic code generation via companion plugin, and support for source maps and CSS handling.

Common errors

error Error: Cannot find module 'vite-plugin-pilet' ↓

cause Package not installed or ESM/CJS mismatch.

fix

Run npm install vite-plugin-pilet and ensure your project uses ESM (type: module in package.json).

error TypeError: vitePluginPilet is not a function ↓

cause Incorrect import style (e.g., destructuring a default export).

fix

Use import vitePluginPilet from 'vite-plugin-pilet' (default import).

error Error: Pilet schema version 'v2' is not supported. Use 'v3'. ↓

cause Using deprecated schema v2.

fix

Set schemaVersion: 'v3' in the plugin options.

error Error: Could not resolve './pilet-api' ↓

cause Missing or incorrect API endpoint configuration.

fix

Provide a valid api option pointing to your Piral instance's pilet API.

error Error: ENOENT: no such file or directory, open 'vite.config.js' ↓

cause Vite config file not found in project root.

fix

Create a vite.config.js or vite.config.ts in the root directory of your pilet project.

Warnings

breaking Since v1.2.0, the plugin switched to ESM-only. CJS require() calls will fail. ↓

fix Convert your project to ESM (use import syntax) or use dynamic import().

deprecated Pilet schema v2 is no longer supported starting from v1.1.0. Use schema v3. ↓

fix Update your pilet configuration to use schemaVersion: 'v3'.

gotcha The plugin expects a `vite.config.js` (or .ts) file in the project root. If missing, it may fail silently. ↓

fix Ensure a valid Vite config file exists in the root directory of your pilet project.

gotcha Source maps require explicit configuration; they are not generated by default since v1.0.1. ↓

fix Add `sourcemap: true` to your Vite config's build options.

gotcha The plugin automatically exposes `process.env.NODE_ENV`; avoid overriding it in your Vite config to prevent conflicts. ↓

fix Let the plugin manage NODE_ENV; remove any custom define for it.

Install

npm install vite-plugin-pilet

yarn add vite-plugin-pilet

pnpm add vite-plugin-pilet

Imports

default

wrong

const vitePluginPilet = require('vite-plugin-pilet')

correct

import vitePluginPilet from 'vite-plugin-pilet'

ESM-only since v1.2.0; CJS require will fail.

vitePluginPilet

wrong

const { vitePluginPilet } = require('vite-plugin-pilet')

correct

import vitePluginPilet from 'vite-plugin-pilet'

Default export, not named. Use the above import.

Plugin
wrong
```
import { Plugin } from 'vite-plugin-pilet'
```
correct
```
import type { Plugin } from 'vite'
```
Plugin type is from Vite, not from this package. This package exports a function.

Quickstart

Shows how to configure Vite with vite-plugin-pilet in a vite.config.ts file, including required options.

import { defineConfig } from 'vite';
import vitePluginPilet from 'vite-plugin-pilet';

export default defineConfig({
  plugins: [
    vitePluginPilet({
      // Options: specify pilet API, schema version, etc.
      api: 'https://your-piral-instance.com/api/v1/pilet',
      schemaVersion: 'v3',
    }),
  ],
});