Installation

Package Managers

npm

npm install @meng-xi/vite-plugin -D

yarn

yarn add @meng-xi/vite-plugin -D

pnpm

pnpm add @meng-xi/vite-plugin -D

uni-app Plugin Marketplace

If you are using a uni-app project, you can install it directly from the plugin marketplace:

Plugin Marketplace

Import Methods

Main Entry Import

Import all plugins and framework components from the main entry:

import { compressAssets, autoImport, buildProgress } from '@meng-xi/vite-plugin'

Import by Group (Recommended)

Import by functional group for better semantics and Tree-shaking:

// Compression
import { compressAssets, imageOptimizer } from '@meng-xi/vite-plugin/plugins/compress'

// Generation
import { autoImport, generateUni, generatePages, generateRouter, generateVersion } from '@meng-xi/vite-plugin/plugins/generate'

// Injection
import { htmlInject, loadingManager, faviconManager, versionUpdateChecker } from '@meng-xi/vite-plugin/plugins/inject'

// Analysis
import { bundleAnalyzer, buildProgress } from '@meng-xi/vite-plugin/plugins/analyze'

// Copy
import { copyFile, assetManifest } from '@meng-xi/vite-plugin/plugins/copy'

// Guard
import { envGuard } from '@meng-xi/vite-plugin/plugins/guard'

// Proxy
import { proxyManager } from '@meng-xi/vite-plugin/plugins/proxy'

Single Plugin Import

The most granular import method, only importing the plugins you use:

import { compressAssets } from '@meng-xi/vite-plugin/plugins/compress/compress-assets'
import { autoImport } from '@meng-xi/vite-plugin/plugins/generate/auto-import'
import type { CompressAssetsOptions } from '@meng-xi/vite-plugin/plugins/compress/compress-assets'

TIP

For a detailed comparison of import strategies, see On-demand Import.

Requirements

• Node.js >= 16
• Vite >= 5 (up to Vite 8)
• TypeScript >= 5 (recommended)

Next Steps

• Quick Start — Get started in 5 minutes
• Core Concepts — Understand the plugin system
• Plugins Overview — Browse all plugins