mirror of
https://github.com/tailwindlabs/tailwindcss.git
synced 2025-12-08 21:36:08 +00:00
This PR exposes when using the the `DEBUG` environment variable. This follows the `DEBUG` conventions where: - `DEBUG=1` - `DEBUG=true` - `DEBUG=*` - `DEBUG=tailwindcss` Will enable the debug information, but when using: - `DEBUG=0` - `DEBUG=false` - `DEBUG=-tailwindcss` It will not. This currently only exposes some timings related to: 1. Scanning for candidates 2. Building the CSS 3. Optimizing the CSS We can implement a more advanced version of this where we also expose more fine grained information such as the files we scanned, the amount of candidates we found and so on. But I believe that this will be enough to start triaging performance related issues.
41 lines
1.0 KiB
TypeScript
41 lines
1.0 KiB
TypeScript
export const DEBUG = resolveDebug(process.env.DEBUG)
|
|
|
|
function resolveDebug(debug: typeof process.env.DEBUG) {
|
|
if (debug === undefined) {
|
|
return false
|
|
}
|
|
|
|
// Environment variables are strings, so convert to boolean
|
|
if (debug === 'true' || debug === '1') {
|
|
return true
|
|
}
|
|
|
|
if (debug === 'false' || debug === '0') {
|
|
return false
|
|
}
|
|
|
|
// Keep the debug convention into account:
|
|
// DEBUG=* -> This enables all debug modes
|
|
// DEBUG=projectA,projectB,projectC -> This enables debug for projectA, projectB and projectC
|
|
// DEBUG=projectA:* -> This enables all debug modes for projectA (if you have sub-types)
|
|
// DEBUG=projectA,-projectB -> This enables debug for projectA and explicitly disables it for projectB
|
|
|
|
if (debug === '*') {
|
|
return true
|
|
}
|
|
|
|
let debuggers = debug.split(',').map((d) => d.split(':')[0])
|
|
|
|
// Ignoring tailwindcss
|
|
if (debuggers.includes('-tailwindcss')) {
|
|
return false
|
|
}
|
|
|
|
// Including tailwindcss
|
|
if (debuggers.includes('tailwindcss')) {
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|