Registry / testing / esbuild-plugin-vitest-cleaner

esbuild-plugin-vitest-cleaner

library0.5.1jsnpmunverified

An esbuild plugin that removes import.meta.vitest references and associated code blocks before compilation, preventing test code from leaking into production builds. Current stable version is 0.5.1, with no fixed release cadence. Key differentiator: lightweight alternative to esbuild's built-in drop feature or conditional compilation, with support for file filtering via regex. Ships TypeScript type definitions. Requires Node >= 18.0.0. Known issue: JSDoc comments around import.meta.vitest are not stripped.

testing devops

npm install esbuild-plugin-vitest-cleaner

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-VIT

esbuild-plugin-vitest-cleaner

testingjavascriptv0.5.1

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.

vitestCleaner

✓ import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner'

✗ const vitestCleaner = require('esbuild-plugin-vitest-cleaner')

Package exports ESM only; CommonJS require() will fail.

vitestCleaner

✓ import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner'

✗ import vitestCleaner from 'esbuild-plugin-vitest-cleaner'

Named export, not default export.

FilterOptions

✓ import type { FilterOptions } from 'esbuild-plugin-vitest-cleaner'

Type import only for TypeScript users; not a runtime export.

Demonstrates basic usage with esbuild build, stripping import.meta.vitest from the output.

import { build } from 'esbuild'; import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner'; await build({ entryPoints: ['src/index.ts'], outfile: 'dist/index.js', bundle: true, plugins: [vitestCleaner()] });

Debug

Known issues

gotchaJSDoc comments that annotate import.meta.vitest evaluations are not removed; leftover comments may contain test references.

fix

Manually review output or await a future version with AST-based parsing.

affects: >=0.1.0 <=0.5.1

gotchaPlugin uses regex-based removal; complex code blocks with nested import.meta.vitest may not be fully stripped.

fix

Ensure test blocks are simple and straightforward; consider using esbuild's drop feature if available.

affects: >=0.1.0 <=0.5.1

breakingOnly supports ESM; Node CJS require() will throw a module import error.

fix

Use import syntax or configure project for ESM.

affects: >=0.1.0

Errors

Common errors & fixes

ERR_REQUIRE_ESM: require() of ES Module

Package is ESM-only, but imported via CommonJS require()

fix

Use import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner' instead of require().

'vitestCleaner' is not a function

Using default import instead of named import

fix

Use import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner'.

Cannot find name 'vitestCleaner'. Did you mean 'vitestCleaner'?

Missing or incorrect import in TypeScript

fix

Ensure the import is correct: import { vitestCleaner } from 'esbuild-plugin-vitest-cleaner'.

Upgrade

Version history

0.5.1latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency; plugin hooks into esbuild's build process

Agent activity

6 hits · last 30 days

node

Bingbot

Resources

githubhttps://github.com/verikono/esbuild-plugin-vitest-cleaner ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-vitest-cleaner ↗