From a50047597b73b6d2c9ed10d6def253df6fe20f37 Mon Sep 17 00:00:00 2001 From: Luke Watts Date: Thu, 26 Jan 2023 21:39:42 +0100 Subject: [PATCH] chore: only print output in failure scenario MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The envcheck was generating output when all tests pass. Whilst reassuring, this is a distraction when kicking off new tasks. We should aim for actionable output and reduce noise where possible. 🕊️ Additional changes: * Refactor to remove unused `severity` property * Reduce logic branches within for loop * Remove indent of documentation URL --- scripts/envCheck.js | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/scripts/envCheck.js b/scripts/envCheck.js index 13a9c55e4a..50e0e0beb6 100644 --- a/scripts/envCheck.js +++ b/scripts/envCheck.js @@ -3,41 +3,32 @@ function envCheck() { const tests = [ { message: 'Use Yarn (not npm)', - severity: 'failure', exec: () => /yarn/.test(process.env.npm_execpath), }, { message: 'Use Node v18', - severity: 'failure', exec: () => process.versions.node.split('.')[0] === '18', }, ] let failures = 0 + let output = '\n' - console.log('\n') for (const test of tests) { - let icon = '✅' - let message = test.message - const passed = test.exec() - if (!passed) { - if (test.severity === 'failure') { - icon = '❌' - failures = failures + 1 - } else { - icon = '⚠️' - message = '(Recommended) ' + message - } + if (!test.exec()) { + failures = failures + 1 + output += `❌ ${test.message}\n` + } else { + output += `✅ ${test.message}\n` } - console.log(icon, '', message) } - console.log('\n') if (failures > 0) { + console.log(output) console.log( - '💻 Please setup your dev environment to meet requirements\n\nFor more info see:\n\n', - 'https://onearmy.github.io/community-platform/\n\n', + '💻 Please setup your dev environment to meet requirements\n\nFor more info see:', ) + console.log('https://onearmy.github.io/community-platform/\n\n') process.exit(1) } }