rollup-plugin-conditional-compilation 0.0.3 → 1.0.1

package/README.md

@@ -3,9 +3,15 @@
 [![npm version](https://img.shields.io/npm/v/rollup-plugin-conditional-compilation.svg)](https://www.npmjs.com/package/rollup-plugin-conditional-compilation) [![npm downloads](http://img.shields.io/npm/dm/rollup-plugin-conditional-compilation.svg)](https://npmcharts.com/compare/rollup-plugin-conditional-compilation,token-types?start=1200&interval=30)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/59dd6795e61949fb97066ca52e6097ef)](https://www.codacy.com/app/Borewit/rollup-plugin-conditional-compilation?utm_source=github.com&utm_medium=referral&utm_content=Borewit/rollup-plugin-conditional-compilation&utm_campaign=Badge_Grade)
 
-A simple plugin that allows you to include or exclude code blocks based on compile-time conditions. Works like `#if`, `#endif` in C/C++.
+A simple plugin that allows you to include or exclude code blocks based on compile-time conditions. Same as `#if`, `#else`, `#elif` , `#endif` in C/C++, it looks like this:
 
-> **Note**: This plugin is a simplified version that only supports `#if` and `#endif` for now. Supports for `#else`, `#elif` will be added in future releases.
+```typescript
+// #if DEBUG
+console.log('user', userData); // when DEBUG is false, this line will be removed
+// #endif
+```
+
+> **Note**: You should modify the plugin options to ensure **NOT to strip comments so quickly**, since we work with them. For example, with `@rollup/plugin-typescript`, set `removeComments: false`.
 
 **More Rollup plugins** you might be interested in:
 
@@ -25,31 +31,42 @@ pnpm add -D rollup-plugin-conditional-compilation
 
 ```js
 import conditional from 'rollup-plugin-conditional-compilation';
-
 export default {
-  input: 'src/index.js',
-  output: { file: 'dist/bundle.js', format: 'esm' },
   ...other configs,
-  plugins: [conditional({ variables: { DEBUG: false, FEATURE_X: true } })],
+  plugins: [
+    typescript({
+      ...,
+      removeComments: false, // !!IMPORTANT!! Don't strip comments so quickly!
+    }),
+    conditional({ variables: { DEBUG: false, FEATURE_X: true } })
+  ],
 };
 ```
 
 ### Syntax
 
-- Single-line directives only: `// #if <expression>` and `// #endif`.
+- Single-line directives only: `// #if <expression>`, `// #else`, `// #elif <expression>` and `// #endif`.
 - The `<expression>` is evaluated at build time with the keys from `variables` available as identifiers.
-  - You can write literally **ANY** js expression in it, because it is evaluated as an IIFE(Immediately Invoked Function Expression).
-- Only `#if` and `#endif` are supported(for now). `#else` / `#elif` will be supported in future releases.
+  - You can write **literally ANY JavaScript expressions** in it, because it is evaluated as an IIFE (Immediately Invoked Function Expression).
+  - Supported directives: `#if`, `#else`, `#elif`, `#endif` (similar to C/C++ style conditional compilation).
+- Since it is `if/else` , it follows the syntax of `if/else` statements
 
 ### Example
 
-Source:
+Remove testing methods in your class when compiling for production:
 
-```js
-// #if DEBUG
-console.log('debug');
-// #endif
-console.log('always');
+```typescript
+class User {
+  private name: string;
+  private identifier: string;
+
+  // #if DEBUG
+  // This method will be removed in production build
+  _getTestData() {
+    return SomeImportantDataForTesting;
+  }
+  // #endif
+}
 ```
 
 If `variables.DEBUG === false`, compiled output becomes: