create-appraisejs 0.3.1-alpha.0 → 0.3.1-alpha.1

package/templates/starter/packages/locator-picker-companion/src/launcher.ts

@@ -18,9 +18,7 @@ async function getLatestModifiedTime(targetPath: string): Promise<number> {
   }
 
   const entries = await readdir(targetPath, { withFileTypes: true })
-  const times = await Promise.all(
-    entries.map(entry => getLatestModifiedTime(path.join(targetPath, entry.name))),
-  )
+  const times = await Promise.all(entries.map(entry => getLatestModifiedTime(path.join(targetPath, entry.name))))
 
   return Math.max(stats.mtimeMs, ...times)
 }

package/templates/starter/packages/locator-picker-companion/src/session-file.ts

@@ -76,20 +76,14 @@ export function getLocatorPickerCrashLogPath(sessionId: string, repoRoot = proce
   return path.join(getLocatorPickerLogsDir(repoRoot), `${sessionId}.log`)
 }
 
-export async function removeLocatorPickerProfileDir(
-  sessionId: string,
-  repoRoot = process.cwd(),
-): Promise<void> {
+export async function removeLocatorPickerProfileDir(sessionId: string, repoRoot = process.cwd()): Promise<void> {
   await rm(getLocatorPickerProfileDir(sessionId, repoRoot), {
     force: true,
     recursive: true,
   }).catch(() => undefined)
 }
 
-export async function removeLocatorPickerSessionFile(
-  sessionId: string,
-  repoRoot = process.cwd(),
-): Promise<void> {
+export async function removeLocatorPickerSessionFile(sessionId: string, repoRoot = process.cwd()): Promise<void> {
   await unlink(getLocatorPickerSessionFilePath(sessionId, repoRoot)).catch(() => undefined)
 }
 
@@ -137,9 +131,7 @@ export async function ensureLocatorPickerDirectories(repoRoot = process.cwd()):
   await mkdir(localAppDataDir, { recursive: true })
 }
 
-export async function readLocatorPickerSessionFile(
-  sessionFilePath: string,
-): Promise<CompanionSessionFile | null> {
+export async function readLocatorPickerSessionFile(sessionFilePath: string): Promise<CompanionSessionFile | null> {
   try {
     const raw = await readFile(sessionFilePath, 'utf8')
     return JSON.parse(raw) as CompanionSessionFile
@@ -148,10 +140,7 @@ export async function readLocatorPickerSessionFile(
   }
 }
 
-async function enqueueSessionFileOperation<T>(
-  sessionFilePath: string,
-  operation: () => Promise<T>,
-): Promise<T> {
+async function enqueueSessionFileOperation<T>(sessionFilePath: string, operation: () => Promise<T>): Promise<T> {
   const previousOperation = sessionFileOperationQueue.get(sessionFilePath) ?? Promise.resolve()
   const nextOperation = previousOperation.catch(() => undefined).then(operation)
 

package/templates/starter/packages/locator-picker-companion/src/types.ts

@@ -1,13 +1,6 @@
 export type CompanionSessionStatus = 'starting' | 'ready' | 'picked' | 'saving' | 'closed' | 'error'
 
-export type CompanionPickedLocatorStrategy =
-  | 'test-id'
-  | 'role'
-  | 'label'
-  | 'placeholder'
-  | 'id'
-  | 'css'
-  | 'xpath'
+export type CompanionPickedLocatorStrategy = 'test-id' | 'role' | 'label' | 'placeholder' | 'id' | 'css' | 'xpath'
 
 export interface CompanionLaunchSource {
   environmentId?: string

package/templates/starter/playwright.config.ts

@@ -0,0 +1,46 @@
+import { defineConfig, devices } from '@playwright/test'
+
+const port = Number(process.env.E2E_PORT ?? 3200)
+const baseURL = process.env.PLAYWRIGHT_BASE_URL ?? `http://127.0.0.1:${port}`
+const databaseUrl = process.env.DATABASE_URL ?? `file:./e2e-${Date.now()}.db`
+
+process.env.DATABASE_URL = databaseUrl
+
+export default defineConfig({
+  testDir: './e2e',
+  // Each spec resets and seeds the same SQLite database in beforeEach hooks.
+  // Parallel workers or files would race on that shared DB (local and CI).
+  fullyParallel: false,
+  workers: 1,
+  forbidOnly: !!process.env.CI,
+  timeout: 60_000,
+  grep: process.env.E2E_GREP ? new RegExp(process.env.E2E_GREP) : undefined,
+  expect: {
+    timeout: 10_000,
+  },
+  reporter: process.env.CI ? [['github'], ['list']] : 'list',
+  use: {
+    baseURL,
+    trace: 'on-first-retry',
+    screenshot: 'only-on-failure',
+    video: 'retain-on-failure',
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+  webServer: {
+    command: `node e2e/start-server.mjs ${port}`,
+    url: baseURL,
+    reuseExistingServer: !process.env.CI,
+    timeout: 120_000,
+    env: {
+      ...process.env,
+      DATABASE_URL: databaseUrl,
+      ENVIRONMENT: 'local',
+      NEXT_TELEMETRY_DISABLED: '1',
+    },
+  },
+})

package/templates/starter/postcss.config.mjs

@@ -1,8 +1,8 @@
-/** @type {import('postcss-load-config').Config} */
-const config = {
-  plugins: {
-    tailwindcss: {},
-  },
-};
-
-export default config;
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+  },
+}
+
+export default config

package/templates/starter/scripts/configure-git-line-endings.mjs

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+/**
+ * Applies repo line-ending policy to the local clone so `git diff` matches
+ * .gitattributes / EditorConfig / Prettier (LF everywhere).
+ *
+ * Usage:
+ *   node scripts/configure-git-line-endings.mjs
+ *   node scripts/configure-git-line-endings.mjs --renormalize
+ */
+
+import { execSync } from 'node:child_process'
+import { existsSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const scriptDir = dirname(fileURLToPath(import.meta.url))
+const repoRoot = join(scriptDir, '..')
+const gitConfigInclude = '../.gitconfig.appraise'
+const quiet = process.argv.includes('--quiet')
+
+function log(message) {
+  if (!quiet) {
+    console.log(message)
+  }
+}
+
+function runGit(args, options = {}) {
+  const stdio = options.stdio ?? ['pipe', 'pipe', 'pipe']
+  const result = execSync(['git', ...args].join(' '), {
+    cwd: repoRoot,
+    encoding: 'utf8',
+    stdio,
+    ...options,
+  })
+
+  if (stdio !== 'inherit' && result != null) {
+    return String(result).trim()
+  }
+
+  return ''
+}
+
+function isGitRepository() {
+  return existsSync(join(repoRoot, '.git'))
+}
+
+function getLocalConfig(key) {
+  try {
+    return runGit(['config', '--local', '--get', key])
+  } catch {
+    return null
+  }
+}
+
+function setLocalConfig(key, value) {
+  runGit(['config', '--local', key, value], { stdio: 'inherit' })
+}
+
+function ensureGitInclude() {
+  const current = getLocalConfig('include.path')
+  if (current === gitConfigInclude) {
+    return false
+  }
+
+  setLocalConfig('include.path', gitConfigInclude)
+  log(`Linked local git config: include.path = ${gitConfigInclude}`)
+  return true
+}
+
+function main() {
+  if (!isGitRepository()) {
+    log('Not a git repository; skipping git line-ending configuration.')
+    return
+  }
+
+  const updatedInclude = ensureGitInclude()
+
+  if (!updatedInclude && !quiet) {
+    log('Git line-ending settings already use .gitconfig.appraise (LF, autocrlf=false).')
+  }
+
+  if (process.argv.includes('--renormalize')) {
+    log('Staging removals so renormalize does not fail on deleted tracked paths...')
+    runGit(['add', '-u'], { stdio: 'inherit' })
+    log('Renormalizing line endings in the index (may update staged content)...')
+    runGit(['add', '--renormalize', '.'], { stdio: 'inherit' })
+    log('Renormalize complete. Review with: git status')
+  }
+}
+
+main()

package/templates/starter/scripts/install-template-step.ts

@@ -65,7 +65,11 @@ function getRunArgs(packageManager: 'npm' | 'pnpm' | 'yarn' | 'bun', scriptName:
   return ['run', scriptName]
 }
 
-async function runScript(projectRoot: string, packageManager: 'npm' | 'pnpm' | 'yarn' | 'bun', scriptName: string): Promise<void> {
+async function runScript(
+  projectRoot: string,
+  packageManager: 'npm' | 'pnpm' | 'yarn' | 'bun',
+  scriptName: string,
+): Promise<void> {
   await new Promise<void>((resolve, reject) => {
     const child = spawn(packageManager, getRunArgs(packageManager, scriptName), {
       cwd: projectRoot,

package/templates/starter/scripts/lib/step-matcher.test.ts

@@ -79,8 +79,8 @@ describe('sameResolvedParameters', () => {
   })
 
   it('returns false for different values', () => {
-    expect(
-      sameResolvedParameters(sample, [{ name: 'x', value: '2', order: 0, type: StepParameterType.NUMBER }]),
-    ).toBe(false)
+    expect(sameResolvedParameters(sample, [{ name: 'x', value: '2', order: 0, type: StepParameterType.NUMBER }])).toBe(
+      false,
+    )
   })
 })

package/templates/starter/scripts/lib/step-matcher.ts

@@ -75,7 +75,11 @@ export function findMatchingTemplateStep(
   templateSteps: TemplateStepCandidate[],
 ): TemplateStepMatch | null {
   for (const templateStep of templateSteps) {
-    const parameters = extractParametersFromGherkinStep(gherkinStep.text, templateStep.signature, templateStep.parameters)
+    const parameters = extractParametersFromGherkinStep(
+      gherkinStep.text,
+      templateStep.signature,
+      templateStep.parameters,
+    )
     if (parameters) {
       return {
         templateStepId: templateStep.id,

package/templates/starter/scripts/lib/template-step-installer.test.ts

@@ -116,7 +116,7 @@ When('click {string}', async function () {})`),
     expect(result.status).toBe('installed')
     const content = await fs.readFile(path.join(workspace, 'automation/steps/actions/click.step.ts'), 'utf8')
     expect(content).toContain("import { helper } from './helper'")
-    expect(content).toContain("// Existing note")
+    expect(content).toContain('// Existing note')
     expect(content).toContain("When('existing click'")
     expect(content).toContain("When('click {string}'")
     expect(content).toContain('Then')
@@ -185,7 +185,9 @@ When('click {string}', async function () {
   await Promise.resolve('new')
 })`)
 
-    await expect(installTemplateStepPayload(payload, { projectRoot: workspace })).rejects.toThrow('Re-run with --overwrite')
+    await expect(installTemplateStepPayload(payload, { projectRoot: workspace })).rejects.toThrow(
+      'Re-run with --overwrite',
+    )
 
     const overwriteResult = await installTemplateStepPayload(payload, {
       projectRoot: workspace,

package/templates/starter/scripts/lib/template-step-installer.ts

@@ -33,7 +33,10 @@ type ExistingStepMatch = {
   source: string
 }
 
-const STEP_FILE_PATTERNS = ['automation/steps/actions/**/*.step.ts', 'automation/steps/validations/**/*.step.ts'] as const
+const STEP_FILE_PATTERNS = [
+  'automation/steps/actions/**/*.step.ts',
+  'automation/steps/validations/**/*.step.ts',
+] as const
 const RUNTIME_IMPORT_PATH = '../../../packages/cucumber-runtime/src/index.js'
 const REQUIRED_RUNTIME_IMPORTS = [
   'When',
@@ -46,7 +49,8 @@ const REQUIRED_RUNTIME_IMPORTS = [
   'generateRandomData',
   'RandomDataType',
 ] as const
-const PLACEHOLDER_COMMENT = '// This file is generated automatically. Add template steps to this group to generate content.'
+const PLACEHOLDER_COMMENT =
+  '// This file is generated automatically. Add template steps to this group to generate content.'
 
 function parseTypeScriptModule(content: string) {
   return parse(content, {
@@ -68,7 +72,13 @@ function getGroupDirectoryName(type: TemplateStepGroupType): 'actions' | 'valida
 }
 
 function getGroupFilePath(projectRoot: string, groupName: string, type: TemplateStepGroupType): string {
-  return path.join(projectRoot, 'automation', 'steps', getGroupDirectoryName(type), `${getGroupFileName(groupName)}.step.ts`)
+  return path.join(
+    projectRoot,
+    'automation',
+    'steps',
+    getGroupDirectoryName(type),
+    `${getGroupFileName(groupName)}.step.ts`,
+  )
 }
 
 function generateGroupJSDoc(name: string, description: string | null, type: TemplateStepGroupType): string {
@@ -289,7 +299,9 @@ async function buildUpdatedGroupFileContent(
     })
   }
 
-  const sections = [generateGroupJSDoc(payload.step.group.name, payload.step.group.description, payload.step.group.type)]
+  const sections = [
+    generateGroupJSDoc(payload.step.group.name, payload.step.group.description, payload.step.group.type),
+  ]
   const mergedImports = mergeImports(existingContent)
   if (mergedImports.trim()) {
     sections.push(mergedImports)

package/templates/starter/scripts/lib/template-step-registry.test.ts

@@ -73,7 +73,7 @@ When('click {string}', async function (this: CustomWorld, elementName: SelectorN
     expect(registry.fragments).toEqual([
       {
         path: 'fragments/click/click-element.ts',
-        content: expect.stringContaining("@name click element"),
+        content: expect.stringContaining('@name click element'),
       },
     ])
     expect(registry.fragments[0]?.content).toContain("When('click {string}'")

package/templates/starter/scripts/lib/template-step-registry.ts

@@ -37,7 +37,10 @@ export type BuiltStepRegistry = {
   fragments: StepRegistryFragment[]
 }
 
-const STEP_FILE_PATTERNS = ['automation/steps/actions/**/*.step.ts', 'automation/steps/validations/**/*.step.ts'] as const
+const STEP_FILE_PATTERNS = [
+  'automation/steps/actions/**/*.step.ts',
+  'automation/steps/validations/**/*.step.ts',
+] as const
 
 export function slugifyRegistryName(value: string): string {
   return value

package/templates/starter/scripts/run-fallow-commit.mjs

@@ -4,16 +4,14 @@ import path from 'node:path'
 
 const scriptDir = path.dirname(fileURLToPath(import.meta.url))
 const repoRoot = path.resolve(scriptDir, '..')
-const fallowBin = path.join(repoRoot, 'node_modules', '.bin', 'fallow')
+// Invoke the package CLI via node — Windows cannot spawn extensionless .bin shims directly.
+const fallowCli = path.join(repoRoot, 'node_modules', 'fallow', 'bin', 'fallow')
+const fallowArgs = ['audit', '--base', 'HEAD', '--format', 'json', '--quiet', '--explain', '--fail-on-issues']
 
 const env = { ...process.env }
 delete env.GIT_INDEX_FILE
 
-const result = spawnSync(
-  fallowBin,
-  ['audit', '--base', 'HEAD', '--format', 'json', '--quiet', '--explain', '--fail-on-issues'],
-  { cwd: repoRoot, env, stdio: 'inherit' },
-)
+const result = spawnSync(process.execPath, [fallowCli, ...fallowArgs], { cwd: repoRoot, env, stdio: 'inherit' })
 
 if (result.error) {
   console.error(result.error)

package/templates/starter/scripts/sync-all.ts

@@ -200,7 +200,7 @@ function displaySummary(summary: SyncSummary): void {
     const status = result.success ? '✅' : '❌'
     const duration = `${(result.duration / 1000).toFixed(2)}s`
     console.log(`   ${index + 1}. ${status} ${result.name} (${result.description}) - ${duration}`)
-    
+
     if (!result.success) {
       if (result.exitCode !== null) {
         console.log(`      Exit code: ${result.exitCode}`)
@@ -252,7 +252,7 @@ async function main(): Promise<number> {
   for (const scriptId of SYNC_SCRIPT_IDS) {
     const result = await executeSyncScript(scriptId)
     results.push(result)
-    
+
     // Continue execution even if script failed (as per user requirement)
     // The script will log the failure but continue with remaining scripts
   }
@@ -278,10 +278,11 @@ async function main(): Promise<number> {
 }
 
 // Run the main function
-main().catch(error => {
-  console.error('\n❌ Fatal error during sync orchestration:', error)
-  return 1
-})
+main()
+  .catch(error => {
+    console.error('\n❌ Fatal error during sync orchestration:', error)
+    return 1
+  })
   .then(exitCode => {
     process.exit(exitCode)
   })

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

@@ -145,89 +145,96 @@ function main(): void {
   console.log('Copying src/...')
   copyDirWithFilter(join(repoRoot, 'src'), join(target, 'src'))
 
-console.log('Copying automation/...')
-copyDirWithFilter(join(repoRoot, 'automation'), join(target, 'automation'))
-syncLegacyEnvironmentConfig()
-resetAutomationReports(target)
-resetAutomationLocatorMap(target)
-
-for (const internalPackage of INTERNAL_PACKAGES) {
-  console.log(`Copying internal package ${internalPackage.name}...`)
-  syncInternalPackage(internalPackage)
-}
-
-console.log('Copying prisma/...')
-copyDirWithFilter(join(repoRoot, 'prisma'), join(target, 'prisma'))
-console.log('Copying public/...')
-copyDirWithFilter(join(repoRoot, 'public'), join(target, 'public'))
-console.log('Copying scripts/...')
-copyDirWithFilter(join(repoRoot, 'scripts'), join(target, 'scripts'))
+  console.log('Copying automation/...')
+  copyDirWithFilter(join(repoRoot, 'automation'), join(target, 'automation'))
+  syncLegacyEnvironmentConfig()
+  resetAutomationReports(target)
+  resetAutomationLocatorMap(target)
+
+  for (const internalPackage of INTERNAL_PACKAGES) {
+    console.log(`Copying internal package ${internalPackage.name}...`)
+    syncInternalPackage(internalPackage)
+  }
 
-const legacyTestsRoot = join(target, 'src', 'tests')
-if (existsSync(legacyTestsRoot)) {
-  rmSync(legacyTestsRoot, { recursive: true, force: true })
-}
+  console.log('Copying prisma/...')
+  copyDirWithFilter(join(repoRoot, 'prisma'), join(target, 'prisma'))
+  console.log('Copying public/...')
+  copyDirWithFilter(join(repoRoot, 'public'), join(target, 'public'))
+  console.log('Copying scripts/...')
+  copyDirWithFilter(join(repoRoot, 'scripts'), join(target, 'scripts'))
+  console.log('Copying e2e/...')
+  copyDirWithFilter(join(repoRoot, 'e2e'), join(target, 'e2e'))
+
+  const legacyTestsRoot = join(target, 'src', 'tests')
+  if (existsSync(legacyTestsRoot)) {
+    rmSync(legacyTestsRoot, { recursive: true, force: true })
+  }
 
-const configFiles = [
-  '.gitignore',
-  'eslint.config.mjs',
-  'tailwind.config.ts',
-  'tsconfig.json',
-  'postcss.config.mjs',
-  'components.json',
-  'next.config.ts',
-  'next-env.d.ts',
-  '.env.example',
-  'package-lock.json',
-  'yarn.lock',
-  'pnpm-lock.yaml',
-  'bun.lockb',
-]
-for (const name of configFiles) {
-  const src = join(repoRoot, name)
-  if (existsSync(src)) {
-    copyFile(src, join(target, name))
+  const configFiles = [
+    '.gitattributes',
+    '.gitconfig.appraise',
+    '.editorconfig',
+    '.prettierrc',
+    '.gitignore',
+    'eslint.config.mjs',
+    'tailwind.config.ts',
+    'tsconfig.json',
+    'postcss.config.mjs',
+    'components.json',
+    'next.config.ts',
+    'next-env.d.ts',
+    'playwright.config.ts',
+    '.env.example',
+    'package-lock.json',
+    'yarn.lock',
+    'pnpm-lock.yaml',
+    'bun.lockb',
+  ]
+  for (const name of configFiles) {
+    const src = join(repoRoot, name)
+    if (existsSync(src)) {
+      copyFile(src, join(target, name))
+    }
   }
-}
 
-const cucumberSource = join(repoRoot, 'cucumber.mjs')
-if (existsSync(cucumberSource)) {
-  copyFile(cucumberSource, join(target, 'cucumber.mjs'))
-  console.log('Synced cucumber.mjs to template')
-}
+  const cucumberSource = join(repoRoot, 'cucumber.mjs')
+  if (existsSync(cucumberSource)) {
+    copyFile(cucumberSource, join(target, 'cucumber.mjs'))
+    console.log('Synced cucumber.mjs to template')
+  }
 
-const vscodeSource = join(repoRoot, '.vscode')
-if (existsSync(vscodeSource)) {
-  cpSync(vscodeSource, join(target, '.vscode'), { recursive: true, force: true })
-  console.log('Synced .vscode to template')
-}
+  const vscodeSource = join(repoRoot, '.vscode')
+  if (existsSync(vscodeSource)) {
+    cpSync(vscodeSource, join(target, '.vscode'), { recursive: true, force: true })
+    console.log('Synced .vscode to template')
+  }
 
-const rootPkg = JSON.parse(readFileSync(join(repoRoot, 'package.json'), 'utf8')) as {
-  scripts: Record<string, string>
-  [key: string]: unknown
-}
-rootPkg.scripts = {
-  ...rootPkg.scripts,
-  build: 'npm run build:local',
-  'build:local':
-    'npm run generate-db-client && npm run build:cucumber-runtime && npm run build:locator-picker-companion && next build',
-  start: 'next start',
-  'generate-db-client': 'npx prisma generate --schema prisma/schema.prisma',
-  'migrate-db': 'npx prisma migrate deploy',
-  'install-playwright': 'npx playwright install',
-  setup: 'npm run install-dependencies && npm run setup:db && npm run build:local && npm run protect-seeded-files',
-  'setup:db': 'npm run setup-env && npm run generate-db-client && npm run migrate-db && npm run sync-all',
-  'setup:full':
-    'npm run install-dependencies && npm run setup:db && npm run build:local && npm run protect-seeded-files',
-  '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.')
+  const rootPkg = JSON.parse(readFileSync(join(repoRoot, 'package.json'), 'utf8')) as {
+    scripts: Record<string, string>
+    [key: string]: unknown
+  }
+  rootPkg.scripts = {
+    ...rootPkg.scripts,
+    build: 'npm run build:local',
+    'build:local':
+      'npm run generate-db-client && npm run build:cucumber-runtime && npm run build:locator-picker-companion && next build',
+    start: 'next start',
+    'generate-db-client': 'npx prisma generate --schema prisma/schema.prisma',
+    'migrate-db': 'npx prisma migrate deploy',
+    'install-playwright': 'npx playwright install',
+    setup: 'npm run install-dependencies && npm run setup:db && npm run build:local && npm run protect-seeded-files',
+    'setup:db': 'npm run setup-env && npm run generate-db-client && npm run migrate-db && npm run sync-all',
+    'setup:full':
+      'npm run install-dependencies && npm run setup:db && npm run build:local && npm run protect-seeded-files',
+    '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)