Installation#

@sigx/vite is an ESM-only package ("type": "module", sideEffects: false). It supports Node ^20.19.0 || >=22.12.0.

Install#

npm install -D @sigx/vite

pnpm add -D @sigx/vite

yarn add -D @sigx/vite

Peer Dependencies#

Both peer dependencies are required and are not bundled — install them yourself:

npm install vite sigx

Configure Vite#

Add the plugin to the plugins array in vite.config.ts. The default export is the plugin factory:

// vite.config.ts
import { defineConfig } from 'vite';
import sigx from '@sigx/vite';

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

The named export sigxPlugin is equivalent if you prefer it:

import { sigxPlugin } from '@sigx/vite';

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

The plugin runs with enforce: 'pre' and only transforms first-party .ts/.tsx/.jsx files — it skips node_modules and /dist/.

Configure TypeScript#

For JSX/TSX, point TypeScript's JSX transform at SignalX:

// tsconfig.json
{
    "compilerOptions": {
        "jsx": "react-jsx",
        "jsxImportSource": "sigx"
    }
}

If you use the type-generation output (see the Commands guide), add its output directory to include so the editor picks it up:

// tsconfig.json
{
    "include": ["src", "node_modules/.sigx/**/*.d.ts"]
}

Package Entry Points#

The package exposes three entry points through its exports map:

Next Steps#

• Getting Started — the minimal end-to-end setup
• HMR for Components — how component hot-reload works
• Library Builds — build packages with defineLibConfig
• API Reference — every export and option