Registry / devops / vite-plugin-ignore-dynamic-imports

vite-plugin-ignore-dynamic-imports

library1.0.2jsnpmunverified

A Vite plugin that automatically adds `/* @vite-ignore */` comments to dynamic import statements, suppressing warnings from Vite's import analysis. Version 1.0.2 supports Vite 6 and 7. Unlike manual commenting, it automates the process across specified files, useful for external packages or generated code. Ships TypeScript types and uses `unplugin-ast` for AST transformation. Released under MIT, with a focus on developer convenience.

devops

npm install vite-plugin-ignore-dynamic-imports

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-IGNORE

vite-plugin-ignore-dynamic-imports

devopsjavascriptv1.0.2

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.

default

✓ import ignoreDynamicImports from 'vite-plugin-ignore-dynamic-imports'

✗ const ignoreDynamicImports = require('vite-plugin-ignore-dynamic-imports')

The package uses ESM default export; CommonJS require is not supported for ESM-only packages.

default (TypeScript)

✓ import ignoreDynamicImports from 'vite-plugin-ignore-dynamic-imports'

✗ import { ignoreDynamicImports } from 'vite-plugin-ignore-dynamic-imports'

It is a default export, not a named export. Named import will result in undefined.

PluginOptions

✓ import type { PluginOptions } from 'vite-plugin-ignore-dynamic-imports'

✗ import { PluginOptions } from 'vite-plugin-ignore-dynamic-imports'

PluginOptions is a TypeScript type, import it using 'import type' to avoid runtime issues.

Shows how to configure the plugin in vite.config.ts, including the include option, and the effect on a dynamic import statement.

// vite.config.ts import { defineConfig } from 'vite' import ignoreDynamicImports from 'vite-plugin-ignore-dynamic-imports' export default defineConfig({ plugins: [ ignoreDynamicImports({ // Only files matching these globs will have dynamic imports processed include: ['**/external-module.js', 'src/**/*.dynamic.js'] }) ] }) // Example: src/dynamic-import.js const module = await import('./some-module.js') // After transformation: const module = await import(/* @vite-ignore */'./some-module.js')

Debug

Known issues

gotchaIf `include` is omitted, no files are processed, and dynamic imports remain unchanged.

fix

Provide a glob array in the include option to specify files to transform.

affects: >=1.0

breakingPlugin relies on Vite 6 or 7; not compatible with Vite 5 or earlier.

fix

Upgrade to Vite 6+ or use an alternative if pinned to an older version.

affects: >=1.0

gotchaThe plugin transforms only dynamic imports in files matching the include patterns. Imports from node_modules are not processed unless explicitly included.

fix

Add appropriate globs (e.g., 'node_modules/**/*.js') if you need to process external packages.

affects: >=1.0

gotchaThe plugin uses unplugin-ast and may conflict with other AST-manipulating Vite plugins.

fix

Test plugin order; place this plugin after other AST plugins that may affect dynamic imports.

affects: >=1.0

Errors

Common errors & fixes

Cannot find module 'vite-plugin-ignore-dynamic-imports'

Missing or incomplete npm installation.

fix

Run 'npm install vite-plugin-ignore-dynamic-imports' or the equivalent for your package manager.

ignoreDynamicImports is not a function

Incorrect import style; using named import instead of default import.

fix

Use 'import ignoreDynamicImports from ...' (default import) rather than '{ ignoreDynamicImports }'.

TypeError: Cannot read properties of undefined (reading 'include')

The include option is required but was omitted in the config.

fix

Pass an object with an 'include' array, e.g., 'ignoreDynamicImports({ include: ['**/*.js'] })'.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

viteoptionalThe plugin is designed to work as a Vite plugin; it requires Vite 6 or 7 to function.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/JakeYallop/WasmSharp ↗

packagevite-plugin-ignore-dynamic-imports ↗

homepagehttps://github.com/JakeYallop/WasmSharp/tree/main/packages/vite-plugin-ignore-dynamic-imports ↗