Registry / devops / semi-theme-vite-plugin

semi-theme-vite-plugin

library1.0.0jsnpmunverified

Vite plugin for Semi Design theme customization, supporting dynamic theme switching, SCSS compilation, and custom CSS variables. Current stable version is 1.0.0, with no regular release cadence yet. Key differentiators: optimized for Vite build, supports all major package managers (npm, yarn, pnpm) via file-system-level resolution, full TypeScript support. Peer dependencies: vite >=4.0.0 and sass ^1.0.0. Node engine requirement >=16.0.0.

devops

npm install semi-theme-vite-plugin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SEMI-THEME-VITE-PL

semi-theme-vite-plugin

devopsjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SemiPlugin

✓ import SemiPlugin from 'semi-theme-vite-plugin'

✗ import { SemiPlugin } from 'semi-theme-vite-plugin'

Default export; named import will cause undefined.

SemiPluginOptions

✓ import type { SemiPluginOptions } from 'semi-theme-vite-plugin'

✗ import { SemiPluginOptions } from 'semi-theme-vite-plugin'

TypeScript only; use type import for runtime safety.

require('semi-theme-vite-plugin')

✓ const SemiPlugin = require('semi-theme-vite-plugin')

✗ const { SemiPlugin } = require('semi-theme-vite-plugin')

CommonJS require returns default export directly, not an object.

Configure Vite to use semi-theme-vite-plugin with a Semi Design theme and custom CSS variable.

// vite.config.ts import { defineConfig } from 'vite'; import SemiPlugin from 'semi-theme-vite-plugin'; export default defineConfig({ plugins: [ SemiPlugin({ theme: '@semi-bot/semi-theme-default', options: { prefixCls: 'semi', variables: { '--semi-color-primary': '#1890ff', }, }, }), ], });

Debug

Known issues

gotchaPlugin only works with Vite >=4.0.0; older versions may fail silently.

fix

Upgrade Vite to v4+ or use compatible plugin version.

affects: <1.0.0

gotchaRequires sass as a peer dependency; missing sass will cause build errors.

fix

Install sass: npm install sass --save-dev

affects: >=1.0.0

gotchaThe 'theme' option must point to a valid npm package; invalid string breaks compilation.

fix

Ensure the theme package is installed and listed in package.json.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'semi-theme-vite-plugin'

Package not installed or incorrect import path.

fix

Run npm install semi-theme-vite-plugin --save-dev

TypeError: SemiPlugin is not a function

Named import used instead of default import.

fix

Use default import: import SemiPlugin from 'semi-theme-vite-plugin'

Error: It seems that you don't have sass installed. Please install sass.

Missing peer dependency sass.

fix

Run npm install sass --save-dev

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

viterequiredpeer dependency: requires Vite >=4.0.0 to function as a plugin

sassrequiredpeer dependency: required to compile SCSS files

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/fx1422/semi-theme-vite-plugin ↗

packagesemi-theme-vite-plugin ↗

homepagehttps://github.com/fx1422/semi-theme-vite-plugin#readme ↗