vite-plugin-strip-block

1.1.1 verified Mon Apr 27 auth: no javascript

A Vite plugin that strips code blocks delimited by custom comments from JS/TS/JSX/TSX files during build. Version 1.1.1 is stable with no major releases since initial; inspired by webpack-strip-block. Differentiators: simple comment-based stripping, works out of the box with default markers 'develblock:start'/'develblock:end', supports custom markers, and requires Node >=18.13.0.

Common errors

error Cannot find module 'vite-plugin-strip-block' ↓

cause Missing installation or wrong import path.

fix

Run 'npm i -D vite-plugin-strip-block' and ensure import is correct.

error TypeError: stripBlockPlugin is not a function ↓

cause Using default import incorrectly in CommonJS context.

fix

Use ESM import: import stripBlockPlugin from 'vite-plugin-strip-block'

Warnings

gotcha Plugin requires Node >=18.13.0 due to package.json engines field. ↓

fix Use Node 18.13.0 or later, or consider using a different version of the plugin if available.

gotcha The plugin only strips blocks during build; it does not affect dev server output. ↓

fix Use conditional code or environment variables if you need to strip in dev as well.

gotcha Default comment markers are 'develblock:start' and 'develblock:end'; ensure your source files use exactly these strings inside block comments. ↓

fix Verify comment format: /* develblock:start */ ... /* develblock:end */

Install

npm install vite-plugin-strip-block

yarn add vite-plugin-strip-block

pnpm add vite-plugin-strip-block

Imports

default

wrong

const stripBlockPlugin = require('vite-plugin-strip-block')

correct

import stripBlockPlugin from 'vite-plugin-strip-block'

Package exports only a default export; ESM-only (Node >=18.13.0 required).

StripBlockOptions
```
import type { StripBlockOptions } from 'vite-plugin-strip-block'
```
Type export for TypeScript users; no corresponding runtime value.

Quickstart

Basic setup of vite-plugin-strip-block in Vite config with default options.

// Install: npm i -D vite-plugin-strip-block
// vite.config.js
import stripBlockPlugin from 'vite-plugin-strip-block';
export default {
  plugins: [
    stripBlockPlugin() // defaults: { start: 'develblock:start', end: 'develblock:end' }
  ]
};