Registry / devops / vite-plugin-utils

vite-plugin-utils

library0.4.5jsnpmunverified

vite-plugin-utils is a collection of opinionated utility functions for Vite plugin development. It provides constants, helper functions, and plugin sorting utilities to streamline plugin creation. Currently at version 0.4.5 with monthly releases, it focuses on reducing boilerplate for Vite plugin authors. Unlike general Vite utilities like unplugin or vite-plugin-inspect, this package offers specific sorted plugin handling and module-related constants. The package is ESM-only, designed for Vite 4+, and includes TypeScript declarations. Its lightweight API covers common patterns like virtual module IDs and plugin ordering.

devops

npm install vite-plugin-utils

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-UTILS

vite-plugin-utils

devopsjavascriptv0.4.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

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

resolveVitePluginUtils

✓ import { resolveVitePluginUtils } from 'vite-plugin-utils'

✗ const resolveVitePluginUtils = require('vite-plugin-utils')

Package is ESM-only. CommonJS require will fail.

constant

✓ import { VIRTUAL_MODULE_PREFIX } from 'vite-plugin-utils/constant'

✗ import { VIRTUAL_MODULE_PREFIX } from 'vite-plugin-utils'

Subpath export 'constant' is accessed via '/constant' suffix, not root.

sortPlugin

✓ import { sortPlugin } from 'vite-plugin-utils/sort-plugin'

✗ import { sortPlugin } from 'vite-plugin-utils'

This utility is available under the '/sort-plugin' subpath.

Shows use of sortPlugin to order a custom plugin before vite:vue and VIRTUAL_MODULE_PREFIX constant for virtual module IDs in a Vite config.

import { defineConfig } from 'vite'; import { sortPlugin } from 'vite-plugin-utils/sort-plugin'; import { VIRTUAL_MODULE_PREFIX } from 'vite-plugin-utils/constant'; export default defineConfig({ plugins: [ sortPlugin({ before: ['vite:vue'], plugin: myPlugin() }) ], resolve: { alias: { [`${VIRTUAL_MODULE_PREFIX}my-module`]: '/path/to/my-module' } } }); function myPlugin() { return { name: 'my-plugin', resolveId(id) { if (id.startsWith(VIRTUAL_MODULE_PREFIX)) return id; } }; }

Debug

Known issues

breakingPackage is ESM-only. require() will throw ERR_REQUIRE_ESM.

fix

Use import syntax (ESM) or dynamic import() instead of require().

affects: >=0.0.1

gotchaSubpath exports (e.g., 'constant', 'sort-plugin') must be accessed via full path 'vite-plugin-utils/constant', not from root.

fix

Use correct subpath import: import { VIRTUAL_MODULE_PREFIX } from 'vite-plugin-utils/constant'.

affects: >=0.0.1

deprecatedSome APIs in version <0.4.0 used different naming; check changelog for renames.

fix

Upgrade to 0.4.0+ and update imports to current subpath exports.

affects: <=0.3.x

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /node_modules/vite-plugin-utils/index.js from /project/index.js not supported.

Package is ESM-only. Using CommonJS require() to load it.

fix

Change to import statement: import { sortPlugin } from 'vite-plugin-utils/sort-plugin';

Module not found: Can't resolve 'vite-plugin-utils' in '/project'

Trying to import from package root without specifying subpath export.

fix

Import from a subpath: import { VIRTUAL_MODULE_PREFIX } from 'vite-plugin-utils/constant';

Uncaught TypeError: vitePluginUtils is undefined

Using default import from package root which exports nothing directly.

fix

Use named imports from subpath exports: import { sortPlugin } from 'vite-plugin-utils/sort-plugin';

Upgrade

Version history

0.4.5latest on npm

Audit

Dependencies

viteoptionalPeer dependency; plugins require Vite's plugin API types and runtime.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/vite-plugin/vite-plugin-utils ↗

packagehttps://www.npmjs.com/package/vite-plugin-utils ↗