README.md

vite-plugin-conditional-compile

This is a Vite plugin that enables conditional compilation, similar to conditional compilation directives in C/C++.

English | 简体中文 | 1.3.x旧版本

Features

1. Supports selectively including or excluding code blocks based on custom condition configurations.
2. Allows using different code logic in development and production environments.
3. Flexible condition expressions with support for logical operations and environment variables.
4. Can dynamically generate different output files during the Vite build process.

Installation

yarn add vite-plugin-conditional-compile -D

Usage

Be sure to place this plugin's loading order at the forefront to prevent other plugins from compiling code like jsx, which would cause this plugin to fail to parse.

Configuration Options

This plugin supports the following configuration options:

1. include: string | RegExp | readonly (string | RegExp)[] | null Specifies the file paths or file matching patterns that should undergo conditional compilation.

   Default value: ['**/*']

   Example:

      {
        include: [/^.+\/packages\/.+\/.+.(ts|tsx)$/],
      }

2. exclude: string | RegExp | readonly (string | RegExp)[] | null Specifies the file paths or file matching patterns to exclude from conditional compilation.

   Default value: [/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/]

   Example:

      {
         exclude: ['/\.eslintrc.js/']
      }

3. env: Record<string, any> Custom environment variable options used in conditional compilation statements with custom environment variables.

   Example:

   {
     'MY_VARIABLE': 'my value',
     // more env options...
   }

   Additionally, this plugin calls vite's loadEnv to retrieve the project's environment variables.

Examples

// vite.config.ts
import { defineConfig } from "vite";
import vitePluginConditionalCompile from "vite-plugin-conditional-compile";

export default defineConfig({
    plugins: [vitePluginConditionalCompile({
      env:{
        // Custom environment variables provided for conditional statements
        feature: 'code',
        prod_version: 'vite'
      }
    }),
  ],
});


// main.jsx
// #if [DEV]
import { featureA } from './featureA.js';

// This import statement will be loaded when the current environment is production, taking the value of PROD from the project's environment variables
// #elif [PROD]
import { featureB } from './featureB.js';

// The values of feature and prod_version are taken from the user's env configuration. It checks whether the value of feature is the same as "code" and the value of prod_version is not equal to "vite". When one of these conditions is met, this condition is true.
// #elif [feature=code || !(prod_version=vite)]
import { featureC } from './featureC.js';

// #else
import { featureD } from './featureD.js';

// #endif

// #if [DEV]
console.log('Development environment');
// #endif

// #if [PROD]
console.log('Production environment');
// #endif

// #if [!!API_URL]
fetch(import.meta.env.API_URL)
  .then(response => response.json())
  .then(data => console.log(data));
// #endif


// react jsx
const Com = () => {
return (
    <div>
      {/* #if [PROD] */}
      <span>prod mode</span>
      {/* #elif [DEV] */}
      <span>dev mode</span>
      {/*#else */}
      <span>unknown mode</span>
      {/* #endif */}
    </div>
  );
}

<script setup lang="ts">
// #if [DEV]
import { featureA } from './featureA.js';
// #endif

</script>

<template>

  <!-- #if [DEV] -->
  <router-link to="/debug">
    <span class="m-2 text-green-500">demo</span>
  </router-link>

  <!-- #elif [PROD] -->
 <router-link to="/prod">
    <span class="m-2 text-green-500">demo</span>
  </router-link>

  <!-- #else -->
  <router-link to="/helloWorld">
    <span class="text-green-500">helloWorld</span>
  </router-link>
  <!-- #endif -->

  <router-view />
</template>

Supported Conditional Statements

Note: Conditions should be wrapped in square brackets []

1. Equality: feature=code、prod_version=4.5.0 Supports characters and numeric values on the right side of the equation.
2. Inequality: prod_version != vite
3. Logical statements: feature=code || !(prod_version=vite). Supports nested logical statements.
4. Variables: DEV. checks if the value of env['DEV'] is true.
5. Negation: !PROD. checks if the value of env['PROD'] is false. Double negation can be used to simulate #ifdef.

VS Code Extension

In the future, there will be support for a VS Code extension that provides features such as syntax highlighting for conditions and syntax validation.