create-jst 0.3.0 → 0.3.1

package/README.md

@@ -15,5 +15,3 @@ npm create jst@latest my-app -- --dry-run
 ```
 
 Use `--help` to view non-interactive options. The initializer never overwrites a non-empty directory.
-
-See [Architecture](./ARCHITECTURE.md) for the dependency boundaries and replaceable gateways.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-jst",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Create a web application from the JST template.",
   "type": "module",
   "bin": {
@@ -25,6 +25,7 @@
   "homepage": "https://github.com/jst-stack/jst#readme",
   "license": "MIT",
   "dependencies": {
+    "@clack/prompts": "^1.8.1",
     "degit": "^3.10.0"
   }
 }

package/src/cli.mjs

@@ -17,9 +17,9 @@ export async function run(argv, environment = process, application = createProje
 		if (command.values.version) return environment.stdout.write(`${process.env.npm_package_version ?? '0.3.0'}\n`)
 
 		const request = await resolveProjectRequest(command, environment)
-		if (request.dryRun) return reporter.plan(request.specification)
+		if (request.dryRun) return reporter.plan(request.specification, request)
 
-		reporter.start()
+		reporter.start(request)
 		const unsubscribe = reporter.subscribe(application.events)
 		try {
 			await application.initializer.execute(request.specification)
@@ -29,6 +29,7 @@ export async function run(argv, environment = process, application = createProje
 		}
 	}
 	catch (error) {
+		if (error instanceof Error && error.name === 'PromptCancelledError') return
 		reporter.error(error instanceof Error ? error.message : String(error))
 		environment.exitCode = 1
 	}

package/src/infrastructure/nodeProjectGateway.mjs

@@ -62,21 +62,25 @@ export function createNodeProjectGateway({ nodeExecutable }) {
 	}
 
 	function installDependencies(destination, packageManager) {
-		return run(packageManager, installCommands[packageManager], destination, true)
+		return run(packageManager, installCommands[packageManager], destination)
 	}
 }
 
-function run(command, args, cwd, inheritOutput = false) {
+function run(command, args, cwd) {
 	return new Promise((resolve, reject) => {
-		const child = spawn(command, args, { cwd, stdio: inheritOutput ? 'inherit' : 'pipe' })
+		const child = spawn(command, args, { cwd, stdio: 'pipe' })
+		let stdout = ''
 		let stderr = ''
+		child.stdout?.on('data', chunk => {
+			stdout += chunk
+		})
 		child.stderr?.on('data', chunk => {
 			stderr += chunk
 		})
 		child.once('error', error => reject(new Error(`Could not run ${command}: ${error.message}`)))
 		child.once('close', code => {
 			if (code === 0) resolve()
-			else reject(new Error(`${command} ${args.join(' ')} failed.${stderr ? `\n${stderr.trim()}` : ''}`))
+			else reject(new Error(`${command} ${args.join(' ')} failed.${[stdout, stderr].filter(Boolean).join('\n').trim() ? `\n${[stdout, stderr].filter(Boolean).join('\n').trim()}` : ''}`))
 		})
 	})
 }

package/src/ui/command.mjs

@@ -1,5 +1,6 @@
 import { basename, resolve } from 'node:path'
 import { parseArgs } from 'node:util'
+import * as prompts from '@clack/prompts'
 import { buildProjectSpecification, normalizePackageName, PACKAGE_MANAGERS, toTitle } from '../domain/projectSpecification.mjs'
 
 export function parseCommandLine(args) {
@@ -51,13 +52,15 @@ export async function resolveProjectRequest(command, environment) {
 
 		return {
 			dryRun: values['dry-run'] ?? false,
+			interactive: Boolean(prompt),
+			terminal: Boolean(environment.stdin.isTTY),
 			specification: buildProjectSpecification({
 				colorScheme: values['color-scheme'],
 				demo: values.demo ?? await prompt?.choice('Start from', ['remove', 'keep'], 'remove') ?? 'remove',
 				description: values.description ?? `${title} web application.`,
 				destination: resolve(environment.cwd(), directory),
-				initGit: prompt ? await prompt.choice('Initialize a Git repository', ['yes', 'no'], initGit ? 'yes' : 'no') === 'yes' : initGit,
-				install: prompt ? await prompt.choice('Install dependencies', ['yes', 'no'], install ? 'yes' : 'no') === 'yes' : install,
+				initGit: prompt ? await prompt.confirm('Initialize a Git repository?', initGit) : initGit,
+				install: prompt ? await prompt.confirm('Install dependencies?', install) : install,
 				language: values.lang,
 				name,
 				packageManager,
@@ -110,21 +113,45 @@ Options:
 
 async function createPrompt(environment, values) {
 	if (!environment.stdin.isTTY || values.yes || values['no-interactive']) return undefined
-	const { createInterface } = await import('node:readline/promises')
-	const reader = createInterface({ input: environment.stdin, output: environment.stdout })
+	prompts.intro('create-jst')
 	return {
 		async choice(label, choices, fallback) {
-			const rendered = choices.map((choice, index) => `${index + 1}:${choice}`).join('  ')
-			const answer = (await reader.question(`  ${label} (${rendered}) [${fallback}]: `)).trim()
-			if (!answer) return fallback
-			const index = Number.parseInt(answer, 10)
-			return choices[index - 1] ?? answer
+			return resolvePrompt(await prompts.select({
+				initialValue: fallback,
+				message: label,
+				options: choices.map(value => ({ hint: choiceHint(value), label: choiceLabel(value), value })),
+			}))
 		},
 		close() {
-			reader.close()
+			return undefined
+		},
+		async confirm(label, initialValue) {
+			return resolvePrompt(await prompts.confirm({ initialValue, message: label }))
 		},
 		async text(label, fallback) {
-			return (await reader.question(`  ${label} [${fallback}]: `)).trim() || fallback
+			return resolvePrompt(await prompts.text({ initialValue: fallback, message: label }))
 		},
 	}
 }
+
+function choiceLabel(value) {
+	return {
+		keep: 'Keep the JST demo',
+		remove: 'Start with a clean application',
+	}[value] ?? value
+}
+
+function choiceHint(value) {
+	return {
+		npm: 'default',
+		remove: 'recommended',
+	}[value]
+}
+
+function resolvePrompt(value) {
+	if (!prompts.isCancel(value)) return value
+	prompts.cancel('Setup cancelled.')
+	const error = new Error('Setup cancelled.')
+	error.name = 'PromptCancelledError'
+	throw error
+}

package/src/ui/reporter.mjs

@@ -1,4 +1,5 @@
 import { basename } from 'node:path'
+import * as prompts from '@clack/prompts'
 
 const progressMessages = {
 	'dependencies.installation.started': specification => `Installing dependencies with ${specification.packageManager}`,
@@ -12,12 +13,32 @@ export function createReporter(output, environment = {}) {
 	const color = Boolean(output.isTTY) && !environment.NO_COLOR
 	const paint = (code, value) => color ? `\u001B[${code}m${value}\u001B[0m` : value
 	const dim = value => paint('2', value)
+	let activeSpinner
+	let usesClack = false
 
 	return {
 		error(message) {
+			if (usesClack) {
+				activeSpinner?.stop('Failed')
+				prompts.cancel(message)
+				return
+			}
 			output.write(`\n${paint('31', '✕')} ${message}\n`)
 		},
-		plan(specification) {
+		plan(specification, request) {
+			usesClack = request.terminal
+			if (usesClack) {
+				if (!request.interactive) prompts.intro('create-jst')
+				prompts.note([
+					`Template: ${specification.template}`,
+					`Package manager: ${specification.packageManager}`,
+					`Starter demo: ${specification.demo}`,
+					`Install dependencies: ${specification.install ? 'yes' : 'no'}`,
+					`Initialize Git: ${specification.initGit ? 'yes' : 'no'}`,
+				].join('\n'), specification.destination)
+				prompts.outro('Dry run complete — no files were written.')
+				return
+			}
 			output.write(`\n${paint('38;5;203', 'JST')} ${dim('plan only — no files will be written')}\n\n`)
 			output.write(`  destination     ${specification.destination}\n`)
 			output.write(`  template        ${specification.template}\n`)
@@ -26,17 +47,34 @@ export function createReporter(output, environment = {}) {
 			output.write(`  install         ${specification.install ? 'yes' : 'no'}\n`)
 			output.write(`  git             ${specification.initGit ? 'yes' : 'no'}\n\n`)
 		},
-		start() {
+		start(request) {
+			usesClack = request.terminal
+			if (usesClack) {
+				if (!request.interactive) prompts.intro('create-jst')
+				return
+			}
 			output.write(`\n${paint('38;5;203', 'JST')} ${dim('A foundation for replaceable layers')}\n\n`)
 		},
 		subscribe(events) {
 			return events.subscribe(event => {
 				if (event.type === 'project.initialized') return this.success(event.specification)
 				const message = progressMessages[event.type]
-				if (message) output.write(`${dim('  ◌')} ${message(event.specification)}\n`)
+				if (!message) return
+				if (usesClack) {
+					activeSpinner?.stop()
+					activeSpinner = prompts.spinner()
+					activeSpinner.start(message(event.specification))
+					return
+				}
+				output.write(`${dim('  ◌')} ${message(event.specification)}\n`)
 			})
 		},
 		success(specification) {
+			if (usesClack) {
+				activeSpinner?.stop('Project created')
+				prompts.outro(`Ready. Run \`${specification.packageManager} run dev\` in ${basename(specification.destination)}.`)
+				return
+			}
 			output.write(`\n${paint('38;5;114', 'Ready.')} ${specification.title} is in ${paint('38;5;203', basename(specification.destination))}.\n\n`)
 			output.write(`  ${dim('$')} cd ${basename(specification.destination)}\n`)
 			output.write(`  ${dim('$')} ${specification.packageManager} run dev\n\n`)