create-appraisejs 0.2.0 → 0.3.0-alpha.0

package/templates/default/scripts/sync-appraise-base-template.ts

@@ -16,10 +16,16 @@ const __dirname = dirname(fileURLToPath(import.meta.url))
 const repoRoot = join(__dirname, '..')
 const target = join(repoRoot, 'templates', 'default')
 
+/**
+ * Delegates template path exclusion decisions to shared sync rules.
+ */
 function shouldExclude(relativePath: string): boolean {
   return shouldExcludeTemplatePath(relativePath)
 }
 
+/**
+ * Recursively copies a directory while applying path-level exclusion rules.
+ */
 function copyDirWithFilter(
   src: string,
   dest: string,
@@ -44,11 +50,17 @@ function copyDirWithFilter(
   }
 }
 
+/**
+ * Copies a file and ensures destination directory exists.
+ */
 function copyFile(src: string, dest: string): void {
   mkdirSync(dirname(dest), { recursive: true })
   cpSync(src, dest, { force: true })
 }
 
+/**
+ * Resets reports directory in template to an empty starter shape.
+ */
 function resetAutomationReports(templateRoot: string): void {
   const reportsRoot = join(templateRoot, 'automation', 'reports')
   rmSync(reportsRoot, { recursive: true, force: true })
@@ -56,12 +68,18 @@ function resetAutomationReports(templateRoot: string): void {
   mkdirSync(join(reportsRoot, 'traces'), { recursive: true })
 }
 
+/**
+ * Resets template locator map to a clean empty array.
+ */
 function resetAutomationLocatorMap(templateRoot: string): void {
   const locatorMapPath = join(templateRoot, 'automation', 'mapping', 'locator-map.json')
   mkdirSync(dirname(locatorMapPath), { recursive: true })
   writeFileSync(locatorMapPath, '[]\n')
 }
 
+/**
+ * Backfills legacy environment config when new location is missing.
+ */
 function syncLegacyEnvironmentConfig(): void {
   const legacyEnvironmentsDir = join(repoRoot, 'src', 'tests', 'config', 'environments')
   const targetEnvironmentsDir = join(target, 'automation', 'config', 'environments')
@@ -86,6 +104,9 @@ const INTERNAL_PACKAGES: InternalPackageSyncConfig[] = [
   { name: 'locator-picker-companion', directories: ['src', 'dist'] },
 ]
 
+/**
+ * Syncs one internal package into template/packages.
+ */
 function syncInternalPackage({ name, directories }: InternalPackageSyncConfig): void {
   const packageRoot = join(repoRoot, 'packages', name)
   const packageTarget = join(target, 'packages', name)
@@ -112,16 +133,17 @@ function syncInternalPackage({ name, directories }: InternalPackageSyncConfig):
   }
 }
 
-const readmePath = join(target, 'README.md')
-const appraisejsConfigPath = join(target, 'appraisejs.config.json')
-const savedReadme = existsSync(readmePath) ? readFileSync(readmePath, 'utf8') : null
-const savedAppraisejsConfig = existsSync(appraisejsConfigPath) ? readFileSync(appraisejsConfigPath, 'utf8') : null
+function main(): void {
+  const readmePath = join(target, 'README.md')
+  const appraisejsConfigPath = join(target, 'appraisejs.config.json')
+  const savedReadme = existsSync(readmePath) ? readFileSync(readmePath, 'utf8') : null
+  const savedAppraisejsConfig = existsSync(appraisejsConfigPath) ? readFileSync(appraisejsConfigPath, 'utf8') : null
 
-rmSync(target, { recursive: true, force: true })
-mkdirSync(target, { recursive: true })
+  rmSync(target, { recursive: true, force: true })
+  mkdirSync(target, { recursive: true })
 
-console.log('Copying src/...')
-copyDirWithFilter(join(repoRoot, 'src'), join(target, 'src'))
+  console.log('Copying src/...')
+  copyDirWithFilter(join(repoRoot, 'src'), join(target, 'src'))
 
 console.log('Copying automation/...')
 copyDirWithFilter(join(repoRoot, 'automation'), join(target, 'automation'))
@@ -200,17 +222,23 @@ rootPkg.scripts = {
   'protect-seeded-files': 'npx tsx scripts/protect-seeded-files.ts',
   'appraisejs:setup': 'npm run setup',
   'appraisejs:sync': 'npm run sync-all',
+  'appraisejs:install-step': 'npx tsx scripts/install-template-step.ts',
 }
+delete rootPkg.scripts['build:appraisejs']
+delete rootPkg.scripts['build-step-registry']
 writeFileSync(join(target, 'package.json'), JSON.stringify(rootPkg, null, 2) + '\n')
 console.log('Wrote template package.json with production-first scaffold scripts.')
 
-if (savedReadme) {
-  writeFileSync(readmePath, savedReadme)
-  console.log('Restored README.md')
-}
-if (savedAppraisejsConfig) {
-  writeFileSync(appraisejsConfigPath, savedAppraisejsConfig)
-  console.log('Restored appraisejs.config.json')
+  if (savedReadme) {
+    writeFileSync(readmePath, savedReadme)
+    console.log('Restored README.md')
+  }
+  if (savedAppraisejsConfig) {
+    writeFileSync(appraisejsConfigPath, savedAppraisejsConfig)
+    console.log('Restored appraisejs.config.json')
+  }
+
+  console.log('Synced base app to templates/default with starter automation assets.')
 }
 
-console.log('Synced base app to templates/default with starter automation assets.')
+main()

package/templates/default/scripts/sync-environments.ts

@@ -12,6 +12,8 @@ import { promises as fs } from 'fs'
 import path from 'path'
 import prisma from '../src/config/db-config'
 import { ensureAutomationWorkspaceReady, getAutomationEnvironmentsDir } from '../src/lib/automation/paths'
+import { printSyncSummary } from './lib/sync-summary'
+import { runSyncScript } from './lib/sync-script-runner'
 
 interface EnvironmentConfig {
   baseUrl: string
@@ -257,56 +259,7 @@ async function syncEnvironmentsToDatabase(environments: EnvironmentData[]): Prom
 /**
  * Generates and displays sync summary
  */
-function generateSummary(result: SyncResult): void {
-  console.log('\n📊 Sync Summary:')
-  console.log(`   📁 Environments scanned: ${result.environmentsScanned}`)
-  console.log(`   ✅ Environments existing: ${result.environmentsExisting}`)
-  console.log(`   ➕ Environments created: ${result.environmentsCreated}`)
-  console.log(`   🗑️  Environments deleted: ${result.environmentsDeleted}`)
-  console.log(`   ⚠️  Environments skipped: ${result.environmentsSkipped}`)
-  console.log(`   ❌ Errors: ${result.errors.length}`)
-
-  if (result.createdEnvironments.length > 0) {
-    console.log('\n   Created environments:')
-    result.createdEnvironments.forEach((name, index) => {
-      console.log(`      ${index + 1}. ${name}`)
-    })
-  }
-
-  if (result.existingEnvironments.length > 0) {
-    console.log('\n   Existing environments:')
-    result.existingEnvironments.forEach((name, index) => {
-      console.log(`      ${index + 1}. ${name}`)
-    })
-  }
-
-  if (result.deletedEnvironments.length > 0) {
-    console.log('\n   Deleted environments:')
-    result.deletedEnvironments.forEach((name, index) => {
-      console.log(`      ${index + 1}. ${name}`)
-    })
-  }
-
-  if (result.skippedEnvironments.length > 0) {
-    console.log('\n   Skipped environments (have test runs):')
-    result.skippedEnvironments.forEach((name, index) => {
-      console.log(`      ${index + 1}. ${name}`)
-    })
-  }
-
-  if (result.errors.length > 0) {
-    console.log('\n   Errors:')
-    result.errors.forEach((error, index) => {
-      console.log(`      ${index + 1}. ${error}`)
-    })
-  }
-}
-
-/**
- * Main function
- */
-async function main() {
-  try {
+async function main(): Promise<SyncResult> {
     console.log('🔄 Starting environments sync...')
     console.log('This will scan environments.json and sync environments to database.\n')
 
@@ -327,23 +280,26 @@ async function main() {
     console.log('\n✅ Syncing environments to database...')
     const result = await syncEnvironmentsToDatabase(environments)
 
-    // Generate summary
-    generateSummary(result)
-
-    if (result.errors.length === 0) {
-      console.log('\n✅ Sync completed successfully!')
-    } else {
-      console.log('\n⚠️  Sync completed with errors. Please review the errors above.')
-      process.exit(1)
-    }
-  } catch (error) {
-    console.error('\n❌ Error during sync:', error)
-    process.exit(1)
-  } finally {
-    await prisma.$disconnect()
-  }
+    printSyncSummary(
+      [
+        { label: '📁 Environments scanned', value: result.environmentsScanned },
+        { label: '✅ Environments existing', value: result.environmentsExisting },
+        { label: '➕ Environments created', value: result.environmentsCreated },
+        { label: '🗑️  Environments deleted', value: result.environmentsDeleted },
+        { label: '⚠️  Environments skipped', value: result.environmentsSkipped },
+        { label: '❌ Errors', value: result.errors.length },
+      ],
+      [
+        { title: 'Created environments', items: result.createdEnvironments },
+        { title: 'Existing environments', items: result.existingEnvironments },
+        { title: 'Deleted environments', items: result.deletedEnvironments },
+        { title: 'Skipped environments (have test runs)', items: result.skippedEnvironments },
+        { title: 'Errors', items: result.errors },
+      ],
+    )
+    return result
 }
 
-main()
+runSyncScript(main)