English | 简体中文
[!IMPORTANT] If you like this project, please consider giving it a star ⭐️. Your support will help this project become a part of the unplugin organization!
npm i unplugin-preprocessor-directives
You use the following two preprocessor directives to define or undefine symbols for conditional compilation:
#define
: Define a symbol.#undef
: Undefine a symbol.You use #define
to define a symbol. When you use the symbol as the expression that's passed to the #if
directive, the expression will evaluate to true
, as the following example shows:
// #define VERBOSE
// #if VERBOSE
console.log('Verbose output version')
// #endif
#if
: Opens a conditional compilation, where code is compiled only if the specified symbol is defined and evaluated to true.#elif
: Closes the preceding conditional compilation and opens a new conditional compilation based on if the specified symbol is defined and evaluated to true.#else
: Closes the preceding conditional compilation and opens a new conditional compilation if the previous specified symbol isn't defined or evaluated to false.#endif
: Closes the preceding conditional compilation.[!NOTE] By default, use vite's
loadEnv
function to load environment variables based onprocess.env.NODE_ENV
and compile symbols as conditions.
// src/index.ts
// #if DEV
console.log('Debug version')
// #endif
// #if !MYTEST
console.log('MYTEST is not defined or false')
// #endif
You can use the operators ==
(equality) and !=
(inequality) to test for the bool values true
or false
. true
means the symbol is defined. The statement #if DEBUG
has the same meaning as #if (DEBUG == true)
. You can use the &&
(and), ||
(or), and !
(not) operators to evaluate whether multiple symbols have been defined. You can also group symbols and operators with parentheses.
class MyClass {
constructor() {
// #if (DEBUG && MYTEST)
console.log('DEBUG and MYTEST are defined')
// #elif (DEBUG==false && !MYTEST)
console.log('DEBUG and MYTEST are not defined')
// #endif
}
}
You instruct the compiler to generate user-defined compiler errors and warnings and informational messages.
#error
: Generates an error.#warning
: Generates a warning.#info
: Generates an informational message.// #error this is an error message
// #warning this is a warning message
// #info this is an info message
You can used defineDirective
to define your own directive.
Taking the built-in directive as an example:
export const MessageDirective = defineDirective<MessageToken, MessageStatement>(context => ({
lex(comment) {
return simpleMatchToken(comment, /#(error|warning|info)\s*(.*)/)
},
parse(token) {
if (token.type === 'error' || token.type === 'warning' || token.type === 'info') {
this.current++
return {
type: 'MessageStatement',
kind: token.type,
value: token.value,
}
}
},
transform(node) {
if (node.type === 'MessageStatement') {
switch (node.kind) {
case 'error':
context.logger.error(node.value, { timestamp: true })
break
case 'warning':
context.logger.warn(node.value, { timestamp: true })
break
case 'info':
context.logger.info(node.value, { timestamp: true })
break
}
return createProgramNode()
}
},
generate(node, comment) {
if (node.type === 'MessageStatement' && comment)
return `${comment.start} #${node.kind} ${node.value} ${comment.end}`
},
}))
enforce: 'pre' | 'post'
Execution priority of directives
pre
: Execute as early as possiblepost
: Execute as late as possible