btfly-gulp-conditional-compile

A Gulp plugin to optionally remove js-conditional-compile-loader comments from your code that follow a particular pattern. Useful for JavaScript builds.

Installation

1cnpm i btfly-gulp-conditional-compile --save-dev

Simple Usage

Import like const jsConditionalCompile = require("btfly-gulp-conditional-compile");. Pass a simple config object to jsConditionalCompile() in your Gulp pipe. All the properties of the objects represent js conditional compile tags. Set to false to remove them.

The system will look for sections of code that have this signature:

1// To remove this section use: jsConditionalCompile({ debug: false })
2// /* pragma:DEBUG_START */
3// var a = true;
4// console.warn("a is", a);
5// /* pragma:DEBUG_END */
6
7// To remove this section use: jsConditionalCompile({ amd: false })
8// /* pragma:AMD_START */
9// var a = true;
10// console.warn("a is", a);
11// /* pragma:AMD_END */
12
13// To remove this section use: jsConditionalCompile({ thatComponents: process.env.ENV_CONDITIONAL_COMPILE_thatComponents === false})
14/* IFTRUE_thatComponents */
15var a = true;
16console.warn('a is', a);
17/* FITRUE_thatComponents */

Use in your gulpfile:

1var jsConditionalCompile = require('btfly-gulp-conditional-compile');
2gulp.src(['/**/*.js']).pipe(
3  jsConditionalCompile({
4    // debug: false,
5    thatComponents: false,
6  })
7);

Note: Its recommended you run this on your concatenated stream rather than your split-up file stream for performance reasons.