Skip to content

Instantly share code, notes, and snippets.

@kentcdodds
Last active January 20, 2026 19:57
Show Gist options
  • Select an option

  • Save kentcdodds/bb452ffe53a5caa3600197e1d8005733 to your computer and use it in GitHub Desktop.

Select an option

Save kentcdodds/bb452ffe53a5caa3600197e1d8005733 to your computer and use it in GitHub Desktop.
setup script for my workshops
{
"name": "workshop-setup",
"version": "1.0.0",
"description": "This is the common setup script for most of my workshops",
"bin": "./setup.js"
}
#!/usr/bin/env node
var spawnSync = require('child_process').spawnSync
var FAILURE = 'failure'
var SUCCESS = 'success'
// disable https://scarf.sh/
// which is used by some projects dependencies
process.env.SCARF_ANALYTICS = false
var styles = {
// got these from playing around with what I found from:
// https://github.com/istanbuljs/istanbuljs/blob/0f328fd0896417ccb2085f4b7888dd8e167ba3fa/packages/istanbul-lib-report/lib/file-writer.js#L84-L96
// they're the best I could find that works well for light or dark terminals
success: { open: '\u001b[32;1m', close: '\u001b[0m' },
danger: { open: '\u001b[31;1m', close: '\u001b[0m' },
info: { open: '\u001b[36;1m', close: '\u001b[0m' },
subtitle: { open: '\u001b[2;1m', close: '\u001b[0m' },
}
function color(modifier, string) {
return styles[modifier].open + string + styles[modifier].close
}
function run(title, subtitle, command, options) {
options = options || {}
console.log(color('info', ' โ–ถ๏ธ Starting: ' + title))
console.log(color('subtitle', ' ' + subtitle))
console.log(
color('subtitle', ' Running the following command: ' + command),
)
var result = spawnSync(command, {
stdio: 'inherit',
shell: true,
env: {
...process.env,
NPM_CONFIG_LOGLEVEL: 'error',
SCARF_ANALYTICS: false,
},
})
if (result.status !== 0 && !options.ignoreFailure) {
console.error(
color(
'danger',
' ๐Ÿšจ Failure: ' +
title +
'. Please review the messages above for information on how to troubleshoot and resolve this issue.',
),
)
process.exit(result.status)
return FAILURE
}
console.log(color('success', ' โœ… Success: ' + title + '\n\n'))
return SUCCESS
}
function main() {
var result
result = run(
'System Validation',
'Ensuring the correct versions of tools are installed on this computer.',
'npx --yes "https://gist.github.com/kentcdodds/abbc32701f78fa70298d444c2303b6d9"',
)
if (result === FAILURE) return
result = run(
'Dependency Installation',
'Installing third party code dependencies so the workshop works properly on this computer.',
'npm install --legacy-peer-deps --no-save',
)
if (result === FAILURE) return
result = run(
'Custom Setup',
'Handling custom setup (if neccessary)',
'npm run setup:custom --if-present',
)
if (result === FAILURE) return
result = run(
'Project Validation',
'Running validation checks to ensure dependencies were installed properly',
'npm run validate --if-present -s',
)
if (result === FAILURE) return
}
main()
@ahmetkca
Copy link
Copy Markdown

wow nice, didn't know you could run remote javascript file with npx. This is neat. Learning more than react. Highly recommend Epic React by Kent C. Dodds

@kentcdodds
Copy link
Copy Markdown
Author

Thank you ๐Ÿ˜Š

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment