create-simo-api 1.0.0 → 1.1.0

package/index.js

@@ -1,9 +1,12 @@
 #!/usr/bin/env node
-import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs'
-import { dirname, join, resolve } from 'node:path'
+import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, renameSync, rmSync, statSync, writeFileSync } from 'node:fs'
+import { dirname, join, relative, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
-import { spawnSync } from 'node:child_process'
+import { spawn } from 'node:child_process'
 import { randomBytes } from 'node:crypto'
+import { styleText } from 'node:util'
+import { createInterface } from 'node:readline/promises'
+import { createRequire } from 'node:module'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const TEMPLATE_DIR = join(__dirname, 'template')
@@ -13,12 +16,231 @@ const RENAME = {
   '_env.example': '.env.example',
 }
 
+const SPINNER = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+
+let createdDir = null
+
+function removeProject() {
+  if (!createdDir) return
+  rmSync(createdDir, { recursive: true, force: true })
+  console.error(styleText('gray', `   Project folder removed: ${relative(process.cwd(), createdDir)}\n`))
+  createdDir = null
+}
+
 function fail(msg) {
-  console.error(`\n  ✖ ${msg}\n`)
+  console.error(`\n${styleText(['red', 'bold'], '✖')}  ${styleText('red', msg)}\n`)
+  removeProject()
   process.exit(1)
 }
 
-function main() {
+function cancel() {
+  console.log(`\n\n${styleText('gray', 'Cancelled.')}\n`)
+  removeProject()
+  process.exit(130)
+}
+
+process.on('SIGINT', cancel)
+
+function listFiles(dir) {
+  return readdirSync(dir, { recursive: true })
+    .map((file) => join(dir, file))
+    .filter((file) => statSync(file).isFile())
+    .sort()
+}
+
+function installDependencies(cwd) {
+  return new Promise((resolvePromise) => {
+    let frame = 0
+    const label = 'Installation in progress... ☕'
+    const timer = setInterval(() => {
+      process.stdout.write(`\r${styleText('cyan', SPINNER[frame++ % SPINNER.length])} ${label}`)
+    }, 80)
+
+    let output = ''
+    const child = spawn('npm', ['install'], { cwd })
+    child.stdout.on('data', (data) => { output += data })
+    child.stderr.on('data', (data) => { output += data })
+
+    child.on('close', (code) => {
+      clearInterval(timer)
+      const icon = code === 0 ? styleText('green', '✔') : styleText('red', '✖')
+      process.stdout.write(`\r${icon} ${label}\n`)
+      resolvePromise({ code, output })
+    })
+  })
+}
+
+function runCommand(cwd, args) {
+  console.log(`\n${styleText('gray', '$')} ${styleText('cyan', `npm ${args.join(' ')}`)}`)
+  return new Promise((resolvePromise) => {
+    const child = spawn('npm', args, { cwd, stdio: 'inherit' })
+    child.on('close', (code) => resolvePromise(code))
+  })
+}
+
+async function ask(question) {
+  const rl = createInterface({ input: process.stdin, output: process.stdout })
+  rl.on('SIGINT', cancel)
+  try {
+    const answer = await rl.question(question)
+    return answer.trim()
+  } catch {
+    cancel()
+  } finally {
+    rl.close()
+  }
+}
+
+const validators = {
+  identifier: (value) => /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(value)
+    ? null
+    : 'Only letters, numbers and _ are allowed, and it cannot start with a number.',
+  host: (value) => /^[^\s/:@]+$/.test(value) ? null : 'Enter a valid host, for example localhost.',
+  port: (value) => {
+    const port = Number(value)
+    return Number.isInteger(port) && port > 0 && port <= 65535 ? null : 'Enter a number between 1 and 65535.'
+  },
+}
+
+async function askWithDefault(label, defaultValue, validate) {
+  const hint = defaultValue ? styleText('gray', ` (${defaultValue})`) : ''
+
+  while (true) {
+    const value = (await ask(`${styleText('bold', label)}${hint}: `)) || defaultValue
+    const error = validate?.(value)
+    if (!error) return value
+    console.log(`  ${styleText('red', '✖')} ${styleText('red', error)}`)
+  }
+}
+
+function printRetry(message) {
+  console.log(`\n${styleText('red', '✖')}  ${styleText('red', message)} ${styleText('gray', 'Try again.')}\n`)
+}
+
+async function askConnection(previous) {
+  return {
+    user: await askWithDefault('User', previous.user, validators.identifier),
+    password: await askWithDefault('Password', ''),
+    host: await askWithDefault('Host', previous.host, validators.host),
+    port: Number(await askWithDefault('Port', String(previous.port), validators.port)),
+  }
+}
+
+async function createDatabase(targetDir, db) {
+  const pg = createRequire(join(targetDir, 'package.json'))('pg')
+  const client = new pg.Client({ ...db, database: 'postgres' })
+
+  try {
+    await client.connect()
+    const { rowCount } = await client.query('SELECT 1 FROM pg_database WHERE datname = $1', [db.database])
+    if (rowCount > 0) return 'exists'
+    await client.query(`CREATE DATABASE "${db.database}"`)
+    return 'created'
+  } catch (error) {
+    if (error.code === '42P04') return 'exists'
+    if (error.code === '42501') return 'denied'
+    if (error.code === '28P01' || error.code === '28000') return 'auth'
+    if (['ECONNREFUSED', 'ENOTFOUND', 'ETIMEDOUT', 'EAI_AGAIN'].includes(error.code)) return 'unreachable'
+    fail(`Could not create the database: ${error.message}`)
+  } finally {
+    await client.end().catch(() => {})
+  }
+}
+
+async function createDatabaseAsAdmin(targetDir, db) {
+  console.log(`\n${styleText('gray', 'Enter a PostgreSQL admin account (the one created when PostgreSQL was installed).')}`)
+  const pg = createRequire(join(targetDir, 'package.json'))('pg')
+  let adminUser = 'postgres'
+
+  while (true) {
+    adminUser = await askWithDefault('Admin user', adminUser, validators.identifier)
+    const password = await askWithDefault('Admin password', '')
+    const client = new pg.Client({ host: db.host, port: db.port, database: 'postgres', user: adminUser, password })
+
+    try {
+      await client.connect()
+      await client.query(`CREATE DATABASE "${db.database}" OWNER "${db.user}"`)
+      return
+    } catch (error) {
+      if (error.code === '28P01' || error.code === '28000') printRetry(`Wrong password for PostgreSQL admin "${adminUser}".`)
+      else if (error.code === '42501') printRetry(`"${adminUser}" is not allowed to create databases either.`)
+      else fail(`Could not create the database: ${error.message}`)
+    } finally {
+      await client.end().catch(() => {})
+    }
+  }
+}
+
+function createDatabaseWithSudo(db) {
+  console.log(`\n${styleText('gray', '$')} ${styleText('cyan', `sudo -u postgres psql -c 'CREATE DATABASE "${db.database}" OWNER "${db.user}";'`)}`)
+  return new Promise((resolvePromise) => {
+    const child = spawn('sudo', ['-u', 'postgres', 'psql', '-c', `CREATE DATABASE "${db.database}" OWNER "${db.user}";`], { stdio: 'inherit' })
+    child.on('close', (code) => resolvePromise(code))
+  })
+}
+
+async function setupDatabase(targetDir, projectName) {
+  console.log(`\n${styleText('magenta', '🐘')}  PostgreSQL setup\n`)
+
+  const defaultName = projectName.toLowerCase().replace(/[^a-z0-9_]/g, '_')
+  const database = await askWithDefault('Database name', defaultName, validators.identifier)
+
+  let db = { database, user: 'postgres', host: 'localhost', port: 5432 }
+  let status
+
+  while (true) {
+    db = { database, ...(await askConnection(db)) }
+    status = await createDatabase(targetDir, db)
+
+    if (status === 'auth') printRetry(`Wrong user or password for "${db.user}".`)
+    else if (status === 'unreachable') printRetry(`Cannot reach PostgreSQL on ${db.host}:${db.port}. Is it running?`)
+    else break
+  }
+
+  if (status === 'denied') {
+    console.log(`\n${styleText('yellow', '⚠')}  User "${db.user}" is not allowed to create databases.`)
+
+    const useSudo = process.platform === 'linux'
+      && ['', 'y', 'yes'].includes((await ask(`${styleText('yellow', '?')} Create it with the "postgres" system user (sudo)? ${styleText('gray', '(Y/n)')} `)).toLowerCase())
+
+    const createdWithSudo = useSudo && (await createDatabaseWithSudo(db)) === 0
+
+    if (!createdWithSudo) {
+      await createDatabaseAsAdmin(targetDir, db)
+    }
+    status = 'created'
+  }
+
+  const url = `postgres://${encodeURIComponent(db.user)}:${encodeURIComponent(db.password)}@${db.host}:${db.port}/${db.database}`
+  const envPath = join(targetDir, '.env')
+  writeFileSync(envPath, readFileSync(envPath, 'utf8').replace(/^DATABASE_URL=.*$/m, `DATABASE_URL=${url}`))
+
+  const maskedUrl = url.replace(`:${encodeURIComponent(db.password)}@`, ':****@')
+  console.log(`
+${styleText('green', '✔')}  Database ${styleText('cyan', db.database)} ${status === 'exists' ? 'already exists, using it' : 'created'}
+
+   ${styleText('gray', 'Host     ')} ${db.host}:${db.port}
+   ${styleText('gray', 'Database ')} ${db.database}
+   ${styleText('gray', 'User     ')} ${db.user}
+   ${styleText('gray', 'URL      ')} ${maskedUrl}
+   ${styleText('gray', 'Saved in ')} .env`)
+}
+
+async function runSetup(targetDir, projectName) {
+  await setupDatabase(targetDir, projectName)
+
+  for (const args of [['run', 'migrate:up'], ['run', 'seed']]) {
+    const code = await runCommand(targetDir, args)
+    if (code !== 0) {
+      fail(`"npm ${args.join(' ')}" failed. Fix the error above, then create the project again.`)
+    }
+  }
+
+  createdDir = null
+  await runCommand(targetDir, ['run', 'dev'])
+}
+
+async function main() {
   const projectName = process.argv[2]
 
   if (!projectName) {
@@ -31,9 +253,10 @@ function main() {
     fail(`Directory "${projectName}" already exists and is not empty.`)
   }
 
-  console.log(`\n  Scaffolding project in ${targetDir} ...`)
+  console.log(`\n${styleText('yellow', '⚡')}  We will scaffold your app in a few seconds..\n`)
 
   mkdirSync(targetDir, { recursive: true })
+  createdDir = targetDir
   cpSync(TEMPLATE_DIR, targetDir, { recursive: true })
 
   for (const [from, to] of Object.entries(RENAME)) {
@@ -52,23 +275,44 @@ function main() {
     .replace(/^ADMIN_PASSWORD=$/m, `ADMIN_PASSWORD=${randomBytes(12).toString('base64url')}`)
   writeFileSync(join(targetDir, '.env'), env)
 
-  console.log('  Installing dependencies with npm ...\n')
-  const install = spawnSync('npm', ['install'], { cwd: targetDir, stdio: 'inherit' })
+  for (const file of listFiles(targetDir)) {
+    const path = relative(process.cwd(), file)
+    console.log(`${styleText('green', 'CREATE')} ${path} ${styleText('gray', `(${statSync(file).size} bytes)`)}`)
+  }
 
-  if (install.status !== 0) {
-    fail('Dependency installation failed. You can cd into the folder and run "npm install" manually.')
+  console.log()
+  const install = await installDependencies(targetDir)
+
+  if (install.code !== 0) {
+    console.error(styleText('gray', install.output))
+    fail('Dependency installation failed. Check your internet connection and npm, then try again.')
   }
 
   console.log(`
-  ✔ Done! Project created.
-
-  Next steps:
-    cd ${projectName}
-    # set DATABASE_URL in .env
-    npm run migrate:up
-    npm run seed
-    npm run dev
+${styleText('magenta', '🚀')}  Successfully created project ${styleText('cyan', projectName)}
+${styleText('green', '   Welcome to Simo Express App. Happy coding!')}
+
+👉  Get started with the following commands:
+
+${styleText('gray', '$')} ${styleText('cyan', `cd ${projectName}`)}
+${styleText('gray', '$ # set DATABASE_URL in .env')}
+${styleText('gray', '$')} ${styleText('cyan', 'npm run migrate:up')}
+${styleText('gray', '$')} ${styleText('cyan', 'npm run seed')}
+${styleText('gray', '$')} ${styleText('cyan', 'npm run dev')}
 `)
+
+  if (!process.stdin.isTTY) {
+    createdDir = null
+    return
+  }
+
+  const answer = await ask(`${styleText('yellow', '?')} Do you want me to run these commands for you? ${styleText('gray', '(Y/n)')} `)
+
+  if (answer === '' || answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes') {
+    await runSetup(targetDir, projectName)
+  } else {
+    createdDir = null
+  }
 }
 
 main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-simo-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Scaffold an Express 5 + PostgreSQL API with JWT auth (access + refresh rotation), role permissions, Zod validation, service layer, migrations, seed and tests.",
   "type": "module",
   "bin": {