const t = require('tap') const { resolve } = require('node:path') // start from clean slate delete process.env.ARBORIST_DEBUG delete process.env.NODE_DEBUG delete process.env.npm_lifecycle_event delete process.env.npm_package_name let isTTY = false Object.defineProperty(process.stderr, 'isTTY', { get: () => isTTY, configurable: true, enumerable: true, }) const LOGS = [] console.error = (...msg) => LOGS.push(msg) t.test('debug does nothing when ARBORIST_DEBUG explicitly 0', t => { process.env.ARBORIST_DEBUG = '0' const debug = t.mock('../lib/debug.js') debug(() => { throw new Error('this should not happen') }) debug.log('hello') t.strictSame(LOGS, []) delete process.env.ARBORIST_DEBUG t.end() }) t.test('debug does nothing outside arborist folder', t => { const dir = resolve(__dirname) const cwd = process.cwd() t.teardown(() => process.chdir(cwd)) process.chdir(dir) const debug = t.mock('../lib/debug.js') debug.log('hello') t.strictSame(LOGS, []) debug(() => { throw new Error('this should not happen') }) t.end() }) t.test('debug runs when cwd is arborist folder, no TTY coloring', t => { const dir = resolve(__dirname, '..') const cwd = process.cwd() t.teardown(() => process.chdir(cwd)) process.chdir(dir) const debug = t.mock('../lib/debug.js') isTTY = false t.plan(2) debug(() => { t.pass('called debug function') }) debug.log('hello') t.strictSame(LOGS, [[process.pid + ' hello']]) LOGS.length = 0 }) t.test('debug runs when cwd is arborist folder, no TTY coloring', t => { const dir = resolve(__dirname, '..') const cwd = process.cwd() t.teardown(() => process.chdir(cwd)) process.chdir(dir) isTTY = true const debug = t.mock('../lib/debug.js') t.plan(2) debug(() => { t.pass('called debug function') }) debug.log('hello') t.strictSame(LOGS, [[process.pid + ' \u001b[31mhello\u001b[39m']]) LOGS.length = 0 }) t.test('debug runs when NODE_DEBUG contains "arborist"', t => { t.teardown(() => { delete process.env.NODE_DEBUG }) process.env.NODE_DEBUG = 'fooo, bar, arborist, etc' const debug = t.mock('../lib/debug.js') t.plan(1) debug(() => { t.pass('called debug function') }) }) t.test('debug runs when ARBORIST_DEBUG=1', t => { t.teardown(() => { delete process.env.ARBORIST_DEBUG }) process.env.ARBORIST_DEBUG = '1' const debug = t.mock('../lib/debug.js') t.plan(1) debug(() => { t.pass('called debug function') }) }) t.test('debug runs when testing arborist', t => { t.teardown(() => { delete process.env.npm_lifecycle_event delete process.env.npm_package_name }) process.env.npm_lifecycle_event = 'test' process.env.npm_package_name = '@npmcli/arborist' const debug = t.mock('../lib/debug.js') t.plan(1) debug(() => { t.pass('called debug function') }) }) t.test('debug runs when generating snapshots', t => { t.teardown(() => { delete process.env.npm_lifecycle_event delete process.env.npm_package_name }) process.env.npm_lifecycle_event = 'snap' process.env.npm_package_name = '@npmcli/arborist' const debug = t.mock('../lib/debug.js') t.plan(1) debug(() => { t.pass('called debug function') }) })