@take-out/scripts 0.0.38 → 0.0.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@take-out/scripts",
-  "version": "0.0.38",
+  "version": "0.0.39",
   "type": "module",
   "main": "./src/index.ts",
   "sideEffects": false,
@@ -24,7 +24,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@take-out/helpers": "0.0.38"
+    "@take-out/helpers": "0.0.39"
   },
   "devDependencies": {
     "vxrn": "*"

package/src/build-initial.ts

@@ -0,0 +1,104 @@
+#!/usr/bin/env bun
+
+/**
+ * @description Bootstrap project workspace and build initial packages. This is
+ * mostly important for Takeout starter kit itself.
+ */
+
+import { existsSync, mkdirSync, readFileSync, symlinkSync } from 'node:fs'
+import { exists } from 'node:fs/promises'
+import { join } from 'node:path'
+
+import { $ } from 'bun'
+
+const hasPackages = await exists(`./packages`)
+
+// only run once:
+if (!(await exists(`./node_modules/.bin/tko`))) {
+  if (hasPackages) {
+    symlinkBins()
+  }
+}
+
+// check if critical packages are built - both helpers and takeout are needed for tko to work
+if (hasPackages) {
+  const needsBuild =
+    !(await exists(`./packages/helpers/dist`)) ||
+    !(await exists(`./packages/takeout/dist/esm`))
+
+  if (needsBuild) {
+    // build helpers first as other packages depend on it
+    await $`cd packages/helpers && bun run build`
+
+    // then build all other packages in parallel
+    await $`bun ./packages/scripts/src/run.ts build --no-root`
+  }
+}
+
+// show welcome message if not onboarded
+checkAndShowWelcome()
+
+function checkAndShowWelcome(cwd: string = process.cwd()): void {
+  try {
+    const packagePath = join(cwd, 'package.json')
+    const pkg = JSON.parse(readFileSync(packagePath, 'utf-8'))
+
+    if (pkg.takeout?.onboarded === false) {
+      console.info()
+      console.info(`
+████████╗ █████╗ ██╗  ██╗███████╗ ██████╗ ██╗   ██╗████████╗
+╚══██╔══╝██╔══██╗██║ ██╔╝██╔════╝██╔═══██╗██║   ██║╚══██╔══╝
+   ██║   ███████║█████╔╝ █████╗  ██║   ██║██║   ██║   ██║
+   ██║   ██╔══██║██╔═██╗ ██╔══╝  ██║   ██║██║   ██║   ██║
+   ██║   ██║  ██║██║  ██╗███████╗╚██████╔╝╚██████╔╝   ██║
+   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝ ╚═════╝  ╚═════╝    ╚═╝
+                        麵 碼 飯
+`)
+      console.info()
+      console.info('  welcome to takeout! 🥡')
+      console.info()
+      console.info('  run \x1b[32mbun onboard\x1b[0m to get things set up')
+      console.info()
+    }
+  } catch {
+    // silently fail if package.json doesn't exist or is malformed
+  }
+}
+
+function symlinkBins() {
+  // workaround for https://github.com/oven-sh/bun/issues/19782
+  // bun doesn't create symlinks for workspace packages properly
+  const packagesWithCLI = [
+    { name: 'takeout', cliFile: 'cli.mjs', alias: 'tko' },
+    { name: 'postgres', cliFile: 'cli.cjs' },
+  ]
+
+  const binDir = join(process.cwd(), 'node_modules', '.bin')
+
+  if (!existsSync(binDir)) {
+    mkdirSync(binDir, { recursive: true })
+  }
+
+  for (const pkg of packagesWithCLI) {
+    const binPath = join(binDir, pkg.name)
+    const sourcePath = join(process.cwd(), 'packages', pkg.name, pkg.cliFile)
+    symlinkTo(sourcePath, binPath)
+
+    if (pkg.alias) {
+      const aliasPath = join(binDir, pkg.alias)
+      // create alias symlink pointing to the source
+      symlinkTo(sourcePath, aliasPath)
+    }
+  }
+
+  // helper function to create symlink with existence check
+  function symlinkTo(source: string, target: string): void {
+    if (existsSync(target)) {
+      console.info(`✓ Symlink already exists: ${target}`)
+      return
+    }
+
+    symlinkSync(source, target)
+    console.info(`→ Created symlink: ${source} ⇢ ${target}`)
+  }
+}

package/src/update-local-env.ts

@@ -0,0 +1,183 @@
+#!/usr/bin/env bun
+
+/**
+ * @description Bootstrap project dependencies and workspace packages
+ *
+ * This script runs automatically during `bun install` via the prepare lifecycle.
+ * It manages the .env file configuration with the following responsibilities:
+ *
+ * 1. Creates .env from .env.template if it doesn't exist
+ * 2. Maintains an auto-generated section in .env with package metadata
+ * 3. Currently syncs ZERO_VERSION from package.json dependencies
+ * 4. Preserves all user-defined environment variables
+ * 5. Creates backups before modifications for safety
+ *
+ * The auto-generated section is clearly marked and should not be edited manually.
+ * All operations are defensive and will not fail the install process.
+ */
+
+import {
+  existsSync,
+  readFileSync,
+  writeFileSync,
+  copyFileSync,
+  renameSync,
+  unlinkSync,
+} from 'node:fs'
+import { join } from 'node:path'
+
+import { getZeroVersion } from '@take-out/scripts/helpers/zero-get-version'
+
+const ENV_PATH = join(process.cwd(), '.env')
+const ENV_TEMPLATE_PATH = join(process.cwd(), '.env.template')
+const ENV_BACKUP_PATH = join(process.cwd(), '.env.backup')
+const ENV_TEMP_PATH = join(process.cwd(), '.env.tmp')
+
+// auto-generated section markers
+const BEGIN_MARKER = '# ---- BEGIN AUTO-GENERATED (DO NOT EDIT) ----'
+const END_MARKER = '# ---- END AUTO-GENERATED ----'
+
+function createEnvFromTemplate(): boolean {
+  if (!existsSync(ENV_TEMPLATE_PATH)) {
+    console.info('No .env.template found, skipping .env creation')
+    return false
+  }
+
+  try {
+    copyFileSync(ENV_TEMPLATE_PATH, ENV_PATH)
+    console.info('Created .env from .env.template')
+    return true
+  } catch (error) {
+    console.error('Failed to create .env from .env.template:', error)
+    return false
+  }
+}
+
+function getAutoGeneratedContent(): string {
+  const zeroVersion = getZeroVersion()
+  if (!zeroVersion) {
+    console.warn('Could not determine Zero version')
+    return ''
+  }
+
+  // build the auto-generated content
+  const lines = [
+    BEGIN_MARKER,
+    `# Generated at: ${new Date().toISOString()}`,
+    `ZERO_VERSION=${zeroVersion}`,
+    END_MARKER,
+  ]
+
+  return lines.join('\n')
+}
+
+function updateEnvFile(): void {
+  // ensure .env exists
+  if (!existsSync(ENV_PATH)) {
+    const created = createEnvFromTemplate()
+    if (!created && !existsSync(ENV_PATH)) {
+      // create empty .env if no template exists
+      writeFileSync(ENV_PATH, '')
+      console.info('Created empty .env file')
+    }
+  }
+
+  try {
+    // create backup
+    if (existsSync(ENV_PATH)) {
+      copyFileSync(ENV_PATH, ENV_BACKUP_PATH)
+    }
+
+    // read current content
+    const currentContent = readFileSync(ENV_PATH, 'utf-8')
+
+    // find existing auto-generated section
+    const beginIndex = currentContent.indexOf(BEGIN_MARKER)
+    const endIndex = currentContent.indexOf(END_MARKER)
+
+    let newContent: string
+
+    if (beginIndex !== -1 && endIndex !== -1 && endIndex > beginIndex) {
+      // replace existing auto-generated section
+      const beforeSection = currentContent.substring(0, beginIndex).trimEnd()
+      const afterSection = currentContent
+        .substring(endIndex + END_MARKER.length)
+        .trimStart()
+
+      newContent = [beforeSection, getAutoGeneratedContent(), afterSection]
+        .filter(Boolean)
+        .join('\n\n')
+    } else if (beginIndex !== -1 || endIndex !== -1) {
+      // malformed markers - preserve content and append new section
+      console.warn('Found malformed auto-generated section, appending new section')
+      newContent = currentContent.trimEnd() + '\n\n' + getAutoGeneratedContent()
+    } else {
+      // no existing section - append to end
+      const trimmedContent = currentContent.trimEnd()
+      newContent = trimmedContent
+        ? trimmedContent + '\n\n' + getAutoGeneratedContent()
+        : getAutoGeneratedContent()
+    }
+
+    // write to temp file first (atomic operation)
+    writeFileSync(ENV_TEMP_PATH, newContent)
+
+    // validate temp file
+    const tempContent = readFileSync(ENV_TEMP_PATH, 'utf-8')
+    if (!tempContent.includes(BEGIN_MARKER) || !tempContent.includes(END_MARKER)) {
+      throw new Error('Generated content validation failed')
+    }
+
+    // atomic replace
+    renameSync(ENV_TEMP_PATH, ENV_PATH)
+
+    if (existsSync(ENV_BACKUP_PATH)) {
+      try {
+        unlinkSync(ENV_BACKUP_PATH)
+      } catch {
+        // ignore cleanup errors
+      }
+    }
+
+    console.info('Updated .env auto-generated section')
+  } catch (error) {
+    console.error('Failed to update .env file:', error)
+
+    // attempt to restore backup
+    if (existsSync(ENV_BACKUP_PATH)) {
+      try {
+        copyFileSync(ENV_BACKUP_PATH, ENV_PATH)
+        console.info('Restored .env from backup')
+      } catch (restoreError) {
+        console.error('Failed to restore backup:', restoreError)
+      }
+    }
+
+    // clean up temp file
+    if (existsSync(ENV_TEMP_PATH)) {
+      try {
+        unlinkSync(ENV_TEMP_PATH)
+      } catch {
+        // ignore cleanup errors
+      }
+    }
+
+    // don't fail the install process
+    process.exit(0)
+  }
+}
+
+// main execution
+// skip bootstrap in CI environments
+if (process.env.CI === 'true') {
+  console.info('Skipping bootstrap in CI environment')
+  process.exit(0)
+}
+
+try {
+  updateEnvFile()
+} catch (error) {
+  // catch any unexpected errors and exit gracefully
+  console.error('Bootstrap script error:', error)
+  process.exit(0)
+}