From 6a88b82e39d5351d1442c3b75336f7f0dd909644 Mon Sep 17 00:00:00 2001 From: Robin Malfait Date: Wed, 29 Dec 2021 23:31:35 +0100 Subject: [PATCH 1/2] improve DEBUG flag --- src/lib/sharedState.js | 41 +++++++++++++++++++++++++++++++++++++- tests/shared-state.test.js | 28 ++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 tests/shared-state.test.js diff --git a/src/lib/sharedState.js b/src/lib/sharedState.js index fc1e278ac9b1..2ef1be25aead 100644 --- a/src/lib/sharedState.js +++ b/src/lib/sharedState.js @@ -1,10 +1,49 @@ export const env = { TAILWIND_MODE: process.env.TAILWIND_MODE, NODE_ENV: process.env.NODE_ENV, - DEBUG: process.env.DEBUG !== undefined && process.env.DEBUG !== '0', + DEBUG: resolveDebug(process.env.DEBUG), TAILWIND_DISABLE_TOUCH: process.env.TAILWIND_DISABLE_TOUCH !== undefined, TAILWIND_TOUCH_DIR: process.env.TAILWIND_TOUCH_DIR, } export const contextMap = new Map() export const configContextMap = new Map() export const contextSourcesMap = new Map() + +export function resolveDebug(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 tailwind / tailwindcss + if (debuggers.includes('-tailwindcss') || debuggers.includes('-tailwind')) { + return false + } + + // Definitely including tailwind / tailwindcss + if (debuggers.includes('tailwindcss') || debuggers.includes('tailwind')) { + return true + } + + return false +} diff --git a/tests/shared-state.test.js b/tests/shared-state.test.js new file mode 100644 index 000000000000..f4072353cf14 --- /dev/null +++ b/tests/shared-state.test.js @@ -0,0 +1,28 @@ +import { resolveDebug } from '../src/lib/sharedState' + +it.each` + value | expected + ${'true'} | ${true} + ${'1'} | ${true} + ${'false'} | ${false} + ${'0'} | ${false} + ${'*'} | ${true} + ${'tailwind'} | ${true} + ${'tailwind:*'} | ${true} + ${'tailwindcss'} | ${true} + ${'tailwindcss:*'} | ${true} + ${'other,tailwind'} | ${true} + ${'other,tailwind:*'} | ${true} + ${'other,tailwindcss'} | ${true} + ${'other,tailwindcss:*'} | ${true} + ${'other,-tailwind'} | ${false} + ${'other,-tailwind:*'} | ${false} + ${'other,-tailwindcss'} | ${false} + ${'other,-tailwindcss:*'} | ${false} + ${'-tailwind'} | ${false} + ${'-tailwind:*'} | ${false} + ${'-tailwindcss'} | ${false} + ${'-tailwindcss:*'} | ${false} +`('should resolve the debug ($value) flag correctly ($expected)', ({ value, expected }) => { + expect(resolveDebug(value)).toBe(expected) +}) From 823d8e7b7e55fe776271d12195f85bea9c36a545 Mon Sep 17 00:00:00 2001 From: Robin Malfait Date: Wed, 29 Dec 2021 23:37:35 +0100 Subject: [PATCH 2/2] update changelog --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ad9fa017bc7..7392f68d59b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -- Nothing yet! +### Fixed + +- Improve `DEBUG` flag ([#6797](https://github.com/tailwindlabs/tailwindcss/pull/6797)) ## [3.0.8] - 2021-12-28