Registry / devops / esbuild-plugin-conditional-build

esbuild-plugin-conditional-build

library1.0.2jsnpmunverified

An esbuild plugin for conditional compilation using `//#if`, `//#else`, and `//#endif` directives in JavaScript/TypeScript files. Version 1.0.2, released as first stable. Requires esbuild and ESM setup (`type: module` in package.json and `.mjs` extensions). Differentiates from other conditional build tools by being lightweight and esbuild-native, using simple comment-based directives.

devops

npm install esbuild-plugin-conditional-build

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-CON

esbuild-plugin-conditional-build

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 conditionalBuild from 'esbuild-plugin-conditional-build'

✗ const conditionalBuild = require('esbuild-plugin-conditional-build')

Package is ESM-only (type: module required). CommonJS require will fail.

conditionalBuild

✓ import conditionalBuild from 'esbuild-plugin-conditional-build'

✗ import { conditionalBuild } from 'esbuild-plugin-conditional-build'

Exported as default, not named.

types

✓ import type { ConditionalBuildOptions } from 'esbuild-plugin-conditional-build'

Type exports may not exist; always check documentation.

Sets up esbuild with conditional build plugin, defining 'DEVELOPMENT' constant and building entry point.

// build.mjs import conditionalBuild from 'esbuild-plugin-conditional-build'; import { build } from 'esbuild'; build({ entryPoints: ['src/foo.js'], outdir: 'dist', plugins: [ conditionalBuild(['DEVELOPMENT']) ] }).catch(() => process.exit(1));

Debug

Known issues

breakingRequires ESM: 'type': 'module' in package.json and .mjs file extensions.

fix

Add "type": "module" to package.json and rename files to .mjs.

affects: >=1.0.0

gotchaFiles must start with '//#conditional' comment for directives to work.

fix

Add //#conditional as the first line of your source files.

affects: >=1.0.0

gotchaDirectives only work in files that are processed by esbuild with this plugin. Not a general preprocessor.

fix

Ensure all files with conditional comments are included in esbuild build.

affects: >=1.0.0

Errors

Common errors & fixes

SyntaxError: Cannot use import statement outside a module

Package is ESM-only but project is not configured for ESM.

fix

Add "type": "module" to package.json and use .mjs extension for your build script.

Error: [esbuild] error: No matching files found: /path/to/file.js

File does not start with //#conditional comment.

fix

Add //#conditional as first line of the file.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

esbuildrequiredPeer dependency; plugin is used as an esbuild plugin.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/AndrewPerson/Conditional-Build ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-conditional-build ↗