create-appraisejs 0.2.0-alpha.4 → 0.2.0-alpha.6

package/README.md

@@ -1,52 +1,102 @@
-# create-appraisejs
-
-Scaffold a new [Appraise](https://github.com/jamil2018/appraisejs-core) app in your directory.
-
-## Usage
-
-```bash
-npx create-appraisejs@latest
-```
-
-The CLI will prompt you for:
-
-1. **Project directory** - Where to create the app (default: `./my-appraisejs-app`). The directory must be empty or not exist.
-2. **Package manager** - `npm`, `pnpm`, `yarn`, or `bun`.
-3. **Run production setup now** - Whether to install dependencies, create `.env`, and build the production app immediately.
-4. **Playwright browsers** - Optional multi-select for `chromium`, `firefox`, and `webkit`.
-
-## Default workflow
-
-1. Uses the **bundled template** shipped with `create-appraisejs`.
-2. Copies the template into the target directory.
-3. Patches `package.json` scripts to use your selected package manager.
-4. If you choose setup now, runs the project's `setup` script and then installs any selected Playwright browsers.
-5. Prints the project path and production-first next steps (`setup`, optional `install-playwright`, then `start`).
-
-By default, the CLI does **not** download the repo again. Remote download is only used when you explicitly override the template source via environment variables.
-
-## Template source and environment variables
-
-| Variable                           | Description                                                                                                                                    | Default                                        |
-| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
-| `CREATE_APPRAISE_REPO_URL`         | Git repository base URL (e.g. `https://github.com/jamil2018/appraisejs-core`). Used for both tarball and clone.                                | `https://github.com/jamil2018/appraisejs-core` |
-| `CREATE_APPRAISE_BRANCH`           | Branch or ref to use.                                                                                                                          | `main`                                         |
-| `CREATE_APPRAISE_TEMPLATE_SUBPATH` | Path inside the repo to the template directory (relative to repo root).                                                                        | `templates/default`                            |
-| `CREATE_APPRAISE_USE_BUNDLED`      | Set to `1`, `true`, or `yes` to force the bundled template even when remote overrides are present.                                             | bundled template                               |
-
-When any remote override is provided, the CLI tries the GitHub tarball URL first (no git required); if that fails, it falls back to `git clone`.
-
-## After scaffolding
-
-From the new project directory:
-
-- Run `npm run setup` (or your package manager's equivalent) to install dependencies, create `.env`, and build the local production app.
-- Optionally install Playwright browsers: `npm run install-playwright -- chromium firefox webkit`.
-- Start the production app: `npm run start`.
-- Use `npm run dev` only when you specifically want the development server.
-
-## Recovery scripts
-
-- `npm run setup:db` recreates the local SQLite database from migrations and reruns `sync-all`.
-- `npm run setup:full` reruns dependency install, DB recovery, and the local production build.
-- `npm run appraisejs:sync` reruns the sync pipeline when you edit automation assets manually.
+# create-appraisejs
+
+Scaffold a new [AppraiseJS](https://github.com/jamil2018/appraisejs-core) project.
+
+## Quick Start
+
+```bash
+npx create-appraisejs@latest
+```
+
+The CLI will ask for:
+
+1. The target directory. It must not exist yet, or it must be empty.
+2. The package manager: `npm`, `pnpm`, `yarn`, or `bun`.
+3. Whether to run the production setup immediately.
+4. Which Playwright browsers you want available: `chromium`, `firefox`, and/or `webkit`.
+
+## What The Scaffolder Does
+
+By default, `create-appraisejs` uses the bundled template shipped inside the package.
+
+During scaffolding it:
+
+1. Copies the packaged AppraiseJS template into your target directory.
+2. Renames the packaged `gitignore` file back to `.gitignore`.
+3. Rewrites `package.json` scripts so they use your chosen package manager.
+4. Preserves the seeded local SQLite database at `prisma/dev.db`.
+5. Starts you with a clean automation workspace: `automation/config/environments/environments.json` is reset to `{}`, `automation/mapping/locator-map.json` is reset to `[]`, reusable step definitions are included, and starter features, locators, and reports are not bundled into the generated app.
+6. Optionally runs the project's `setup` script and then installs any Playwright browsers you selected.
+
+If you skip setup, the CLI still prints the exact next commands to run.
+
+## Default Local Workflow
+
+From the generated project directory:
+
+```bash
+# Install dependencies, create .env, prepare the database, and build the app
+npm run setup
+
+# Optional: install only the browsers you need
+npm run install-playwright -- chromium
+
+# Start the local production server
+npm run start
+```
+
+`npm run dev` is still available, but the scaffold is intentionally production-first.
+
+## Generated Project Highlights
+
+The generated project includes:
+
+- a seeded SQLite database at `prisma/dev.db`
+- the AppraiseJS dashboard and application code
+- automation sync scripts and reusable step definitions
+- package-manager-aware scripts such as `setup`, `setup:db`, `setup:full`, and `appraisejs:sync`
+
+The generated project does not include:
+
+- a ready-made `.env` file
+- starter feature files under `automation/features`
+- starter locator files under `automation/locators`
+- automation reports
+
+## Template Source Overrides
+
+The package defaults to the bundled template. Remote fetching is only used when you provide one of the override environment variables below.
+
+| Variable | Description | Default |
+| --- | --- | --- |
+| `CREATE_APPRAISE_REPO_URL` | Repository URL used for remote template fetching. | `https://github.com/jamil2018/appraisejs-core.git` |
+| `CREATE_APPRAISE_BRANCH` | Branch or ref to fetch from the remote repository. | `main` |
+| `CREATE_APPRAISE_TEMPLATE_SUBPATH` | Path to the template directory inside that repository. | `templates/default` |
+| `CREATE_APPRAISE_USE_BUNDLED` | Set to `1`, `true`, or `yes` to force the bundled template even when remote overrides are present. | bundled template |
+
+When remote mode is active, the CLI tries the repository tarball first and falls back to `git clone` if needed.
+
+Example:
+
+```bash
+CREATE_APPRAISE_BRANCH=main CREATE_APPRAISE_TEMPLATE_SUBPATH=templates/default npx create-appraisejs@latest
+```
+
+## Common Scripts In The Generated App
+
+| Script | What it does |
+| --- | --- |
+| `npm run setup` | Install dependencies, create `.env`, rebuild the local DB, build the app, and protect seeded files |
+| `npm run setup:db` | Recreate the local SQLite database from migrations and rerun the sync pipeline |
+| `npm run setup:full` | Reinstall dependencies, rebuild the DB, rebuild the app, and protect seeded files |
+| `npm run install-playwright -- <browser...>` | Install selected Playwright browsers |
+| `npm run sync-all` | Run the full sync pipeline |
+| `npm run appraisejs:sync` | Alias for `sync-all` |
+| `npm run start` | Start the local production server |
+| `npm run dev` | Start the Next.js development server |
+
+## Notes
+
+- Node.js `18+` is required.
+- The CLI rewrites hardcoded `npm` and `npx` usage inside the generated scripts so `pnpm`, `yarn`, and `bun` work correctly after scaffolding.
+- Selecting Playwright browsers in the prompt does not force installation unless you also choose to run setup immediately. If you skip setup, the CLI shows the browser install command in the next steps.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-appraisejs",
-  "version": "0.2.0-alpha.4",
+  "version": "0.2.0-alpha.6",
   "description": "Scaffold a new AppraiseJS app in your directory",
   "license": "Apache-2.0",
   "author": "Hasnat Jamil",

package/templates/default/.appraise-template-meta.json

@@ -1,5 +1,5 @@
 {
-  "preparedAt": "2026-03-24T10:58:54.969Z",
-  "inputHash": "596a28d2c5dc408d39926068711127354f3752a92c086cd0df27e8cf85eb5990",
+  "preparedAt": "2026-03-25T13:42:37.013Z",
+  "inputHash": "3d8e428a4dcbb25e993b9373c10b2a974387982a734dcfc9281c24bb38f6f36d",
   "databasePath": "prisma/dev.db"
 }

package/templates/default/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "appraise",
-  "version": "0.1.9-alpha",
+  "version": "0.2.0-alpha",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appraise",
-      "version": "0.1.9-alpha",
+      "version": "0.2.0-alpha",
       "dependencies": {
         "@babel/parser": "^7.27.0",
         "@babel/types": "^7.27.0",

package/templates/default/public/favicon.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
+  <circle class="ring" cx="64" cy="64" r="50" fill="none" stroke-width="5.5"/>
+  <polyline class="ck" points="38,66 55,83 92,41" fill="none" stroke-width="9" stroke-linecap="round" stroke-linejoin="round"/>
+  <style>
+    .ring{stroke:#d4d4d4}
+    .ck{stroke:#5cb85c}
+    @media(prefers-color-scheme:light){
+      .ring{stroke:#bbb}
+    }
+  </style>
+</svg>

package/templates/default/public/logo.svg

@@ -0,0 +1,18 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
+  <line class="ln" x1="14" y1="64" x2="62" y2="64" stroke-width="4.5" stroke-linecap="round"/>
+  <circle class="dot" cx="16" cy="64" r="6.5" stroke-width="3.5"/>
+  <circle class="dot" cx="42" cy="64" r="8.5" stroke-width="3.5"/>
+  <circle class="ring" cx="88" cy="64" r="26" fill="none" stroke-width="7"/>
+  <polyline class="ck" points="76,66 85,76 102,54" fill="none" stroke-width="6.5" stroke-linecap="round" stroke-linejoin="round"/>
+  <style>
+    .ln{stroke:#d4d4d4}
+    .dot{fill:#999;stroke:#d4d4d4}
+    .ring{stroke:#eee}
+    .ck{stroke:#5cb85c}
+    @media(prefers-color-scheme:light){
+      .ln{stroke:#555}
+      .dot{fill:#aaa;stroke:#555}
+      .ring{stroke:#333}
+    }
+  </style>
+</svg>

package/templates/default/src/app/layout.tsx

@@ -1,26 +1,13 @@
-import type { Metadata } from 'next'
+import type { Metadata, Viewport } from 'next'
 import { Inter, Inter_Tight } from 'next/font/google'
 import './globals.css'
 import { ThemeProvider } from '@/components/theme/theme-provider'
 import { ModeToggle } from '@/components/theme/mode-toggle'
 import { Toaster } from '@/components/ui/toaster'
-
-const inter = Inter({
-  variable: '--font-inter',
-  subsets: ['latin'],
-})
-
-const interTight = Inter_Tight({
-  variable: '--font-inter-tight',
-  subsets: ['latin'],
-})
-
-export const metadata: Metadata = {
-  title: 'Appraise | Dashboard',
-  description: 'Welcome to the dashboard. Here you can see your test suites and run them.',
-}
-
 import Logo from '@/components/logo'
+import Link from 'next/link'
+import NavMenuCardDeck from '@/components/navigation/nav-menu-card-deck'
+import NavCommand from '@/components/navigation/nav-command'
 import NavLink from '@/components/navigation/nav-link'
 import {
   Blocks,
@@ -41,9 +28,62 @@ import {
   TestTubeDiagonal,
   TestTubes,
 } from 'lucide-react'
-import Link from 'next/link'
-import NavMenuCardDeck from '@/components/navigation/nav-menu-card-deck'
-import NavCommand from '@/components/navigation/nav-command'
+
+const inter = Inter({
+  variable: '--font-inter',
+  subsets: ['latin'],
+})
+
+const interTight = Inter_Tight({
+  variable: '--font-inter-tight',
+  subsets: ['latin'],
+})
+
+const appTitle = 'AppraiseJS'
+const appDescription =
+  'AppraiseJS helps teams organize automated tests, execute suites, and review results from one dashboard.'
+
+export const viewport: Viewport = {
+  colorScheme: 'light dark',
+  themeColor: [
+    { media: '(prefers-color-scheme: light)', color: '#ffffff' },
+    { media: '(prefers-color-scheme: dark)', color: '#09090b' },
+  ],
+}
+
+export const metadata: Metadata = {
+  title: {
+    default: appTitle,
+    template: `%s | ${appTitle}`,
+  },
+  description: appDescription,
+  applicationName: appTitle,
+  keywords: ['AppraiseJS', 'test automation', 'QA', 'dashboard', 'test execution'],
+  openGraph: {
+    title: appTitle,
+    description: appDescription,
+    siteName: appTitle,
+    type: 'website',
+  },
+  twitter: {
+    card: 'summary',
+    title: appTitle,
+    description: appDescription,
+  },
+  appleWebApp: {
+    capable: true,
+    title: appTitle,
+    statusBarStyle: 'default',
+  },
+  icons: {
+    icon: [
+      { url: '/favicon.svg', type: 'image/svg+xml' },
+      { url: '/favicon.ico', sizes: 'any' },
+    ],
+    shortcut: ['/favicon.svg'],
+    other: [{ rel: 'mask-icon', url: '/favicon.svg', color: '#5cb85c' }],
+  },
+}
 
 export default function RootLayout({
   children,

package/templates/default/src/components/logo.tsx

@@ -1,15 +1,15 @@
-import { FlaskConical } from 'lucide-react'
-
-const Logo = () => {
-  return (
-    <div className="m-2 flex items-center">
-      <FlaskConical size={25} className="mr-2 text-primary" />
-      <span className="rounded-l-lg bg-gray-800 bg-primary pb-1 pl-1 text-xl tracking-widest text-white underline dark:text-gray-700">
-        app
-      </span>
-      <span className="text-xl tracking-widest text-primary">raise</span>
-    </div>
-  )
-}
-
-export default Logo
+import Image from 'next/image'
+
+const Logo = () => {
+  return (
+    <div className="m-2 flex items-center gap-1">
+      <Image src="/logo.svg" alt="AppraiseJS" width={32} height={32} priority className="h-8 w-8" />
+      <span className="flex items-baseline gap-1">
+        <span className="text-foreground/90 text-[0.95rem] font-medium uppercase tracking-[0.12em]">Appraise</span>
+        <span className="text-[0.95rem] font-normal uppercase tracking-[0.12em] text-primary">JS</span>
+      </span>
+    </div>
+  )
+}
+
+export default Logo

package/templates/default/src/config/db-config.ts

@@ -65,7 +65,7 @@ const globalForPrisma = global as unknown as {
   prisma: PrismaClientInstance | undefined
 }
 const prisma = globalForPrisma.prisma ?? new PrismaClient()
-
-if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma
-
-export default prisma
+
+if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma
+
+export default prisma

package/templates/default/src/lib/automation/projection-service.ts

@@ -214,14 +214,9 @@ class AutomationProjectionService {
       select: { id: true },
     })
 
-    const templateStepGroups = await prisma.templateStepGroup.findMany({
-      select: { id: true },
-    })
-
     await Promise.all([
       this.syncEnvironments(),
       ...locatorGroups.map(locatorGroup => this.syncLocatorGroup(locatorGroup.id)),
-      ...templateStepGroups.map(group => this.syncTemplateStepGroup(group.id)),
     ])
 
     await this.regenerateAllFeatures()

package/templates/default/src/lib/environment-file-utils.ts

@@ -2,7 +2,7 @@ import { promises as fs } from 'fs'
 import * as path from 'path'
 import prisma from '@/config/db-config'
 import { ensureAutomationWorkspaceReady, getAutomationEnvironmentsDir } from '@/lib/automation/paths'
-
+
 interface EnvironmentConfig {
   baseUrl: string
   apiBaseUrl: string
@@ -11,47 +11,47 @@ interface EnvironmentConfig {
 }
 
 const EMPTY_ENVIRONMENTS_FILE_CONTENT = '{}\n'
-
-export function getEnvironmentsFilePath(): string {
-  return path.join(getAutomationEnvironmentsDir(), 'environments.json')
-}
-
-export async function ensureConfigDirectoryExists(): Promise<void> {
-  await ensureAutomationWorkspaceReady()
-  await fs.mkdir(path.dirname(getEnvironmentsFilePath()), { recursive: true })
-}
-
-export async function generateEnvironmentsContent(): Promise<Record<string, EnvironmentConfig>> {
-  try {
-    const environments = await prisma.environment.findMany({
-      orderBy: { createdAt: 'asc' },
-    })
-
-    const environmentsConfig: Record<string, EnvironmentConfig> = {}
-
-    environments.forEach(env => {
-      const envKey = env.name.toLowerCase().replace(/\s+/g, '_')
-      environmentsConfig[envKey] = {
-        baseUrl: env.baseUrl,
-        apiBaseUrl: env.apiBaseUrl || '',
-        email: env.username || '',
-        password: env.password || '',
-      }
-    })
-
-    return environmentsConfig
-  } catch (error) {
-    console.error('Error generating environments content:', error)
-    return {}
-  }
-}
-
+
+export function getEnvironmentsFilePath(): string {
+  return path.join(getAutomationEnvironmentsDir(), 'environments.json')
+}
+
+export async function ensureConfigDirectoryExists(): Promise<void> {
+  await ensureAutomationWorkspaceReady()
+  await fs.mkdir(path.dirname(getEnvironmentsFilePath()), { recursive: true })
+}
+
+export async function generateEnvironmentsContent(): Promise<Record<string, EnvironmentConfig>> {
+  try {
+    const environments = await prisma.environment.findMany({
+      orderBy: { createdAt: 'asc' },
+    })
+
+    const environmentsConfig: Record<string, EnvironmentConfig> = {}
+
+    environments.forEach(env => {
+      const envKey = env.name.toLowerCase().replace(/\s+/g, '_')
+      environmentsConfig[envKey] = {
+        baseUrl: env.baseUrl,
+        apiBaseUrl: env.apiBaseUrl || '',
+        email: env.username || '',
+        password: env.password || '',
+      }
+    })
+
+    return environmentsConfig
+  } catch (error) {
+    console.error('Error generating environments content:', error)
+    return {}
+  }
+}
+
 export async function createOrUpdateEnvironmentsFile(): Promise<boolean> {
   try {
     await ensureAutomationWorkspaceReady()
     const filePath = getEnvironmentsFilePath()
     await ensureConfigDirectoryExists()
-
+
     const content = await generateEnvironmentsContent()
 
     if (Object.keys(content).length === 0) {
@@ -61,12 +61,12 @@ export async function createOrUpdateEnvironmentsFile(): Promise<boolean> {
 
     await fs.writeFile(filePath, JSON.stringify(content, null, 2))
     return true
-  } catch (error) {
-    console.error('Error creating/updating environments file:', error)
-    return false
-  }
-}
-
+  } catch (error) {
+    console.error('Error creating/updating environments file:', error)
+    return false
+  }
+}
+
 export async function deleteEnvironmentsFile(): Promise<boolean> {
   try {
     await ensureAutomationWorkspaceReady()
@@ -78,103 +78,103 @@ export async function deleteEnvironmentsFile(): Promise<boolean> {
     console.error('Error deleting environments file:', error)
     return false
   }
-}
-
-export async function readEnvironmentsFile(): Promise<{
-  filePath: string
-  content: Record<string, EnvironmentConfig>
-} | null> {
-  try {
-    await ensureAutomationWorkspaceReady()
-    const filePath = getEnvironmentsFilePath()
-
-    try {
-      await fs.access(filePath)
-    } catch {
-      return null
-    }
-
-    const fileContent = await fs.readFile(filePath, 'utf-8')
-    const jsonContent = JSON.parse(fileContent)
-
-    return { filePath, content: jsonContent }
-  } catch (error) {
-    console.error('Error reading environments file:', error)
-    return null
-  }
-}
-
-export async function updateEnvironmentEntry(environmentId: string, oldName?: string): Promise<boolean> {
-  try {
-    await ensureAutomationWorkspaceReady()
-    const environment = await prisma.environment.findUnique({
-      where: { id: environmentId },
-    })
-
-    if (!environment) {
-      console.error(`Environment with ID ${environmentId} not found`)
-      return false
-    }
-
-    const filePath = getEnvironmentsFilePath()
-    let environmentsConfig: Record<string, EnvironmentConfig> = {}
-
-    try {
-      await fs.access(filePath)
-      const fileContent = await fs.readFile(filePath, 'utf-8')
-      environmentsConfig = JSON.parse(fileContent)
-    } catch {
-      environmentsConfig = {}
-    }
-
-    if (oldName) {
-      const oldKey = oldName.toLowerCase().replace(/\s+/g, '_')
-      delete environmentsConfig[oldKey]
-    }
-
-    const envKey = environment.name.toLowerCase().replace(/\s+/g, '_')
-    environmentsConfig[envKey] = {
-      baseUrl: environment.baseUrl,
-      apiBaseUrl: environment.apiBaseUrl || '',
-      email: environment.username || '',
-      password: environment.password || '',
-    }
-
-    await ensureConfigDirectoryExists()
-    await fs.writeFile(filePath, JSON.stringify(environmentsConfig, null, 2))
-    return true
-  } catch (error) {
-    console.error('Error updating environment entry:', error)
-    return false
-  }
-}
-
-export async function removeEnvironmentEntry(environmentName: string): Promise<boolean> {
-  try {
-    await ensureAutomationWorkspaceReady()
-    const filePath = getEnvironmentsFilePath()
-
-    try {
-      await fs.access(filePath)
-    } catch {
-      return true
-    }
-
-    const fileContent = await fs.readFile(filePath, 'utf-8')
-    const environmentsConfig: Record<string, EnvironmentConfig> = JSON.parse(fileContent)
-
-    const envKey = environmentName.toLowerCase().replace(/\s+/g, '_')
-    delete environmentsConfig[envKey]
-
-    if (Object.keys(environmentsConfig).length === 0) {
-      await deleteEnvironmentsFile()
-      return true
-    }
-
-    await fs.writeFile(filePath, JSON.stringify(environmentsConfig, null, 2))
-    return true
-  } catch (error) {
-    console.error('Error removing environment entry:', error)
-    return false
-  }
-}
+}
+
+export async function readEnvironmentsFile(): Promise<{
+  filePath: string
+  content: Record<string, EnvironmentConfig>
+} | null> {
+  try {
+    await ensureAutomationWorkspaceReady()
+    const filePath = getEnvironmentsFilePath()
+
+    try {
+      await fs.access(filePath)
+    } catch {
+      return null
+    }
+
+    const fileContent = await fs.readFile(filePath, 'utf-8')
+    const jsonContent = JSON.parse(fileContent)
+
+    return { filePath, content: jsonContent }
+  } catch (error) {
+    console.error('Error reading environments file:', error)
+    return null
+  }
+}
+
+export async function updateEnvironmentEntry(environmentId: string, oldName?: string): Promise<boolean> {
+  try {
+    await ensureAutomationWorkspaceReady()
+    const environment = await prisma.environment.findUnique({
+      where: { id: environmentId },
+    })
+
+    if (!environment) {
+      console.error(`Environment with ID ${environmentId} not found`)
+      return false
+    }
+
+    const filePath = getEnvironmentsFilePath()
+    let environmentsConfig: Record<string, EnvironmentConfig> = {}
+
+    try {
+      await fs.access(filePath)
+      const fileContent = await fs.readFile(filePath, 'utf-8')
+      environmentsConfig = JSON.parse(fileContent)
+    } catch {
+      environmentsConfig = {}
+    }
+
+    if (oldName) {
+      const oldKey = oldName.toLowerCase().replace(/\s+/g, '_')
+      delete environmentsConfig[oldKey]
+    }
+
+    const envKey = environment.name.toLowerCase().replace(/\s+/g, '_')
+    environmentsConfig[envKey] = {
+      baseUrl: environment.baseUrl,
+      apiBaseUrl: environment.apiBaseUrl || '',
+      email: environment.username || '',
+      password: environment.password || '',
+    }
+
+    await ensureConfigDirectoryExists()
+    await fs.writeFile(filePath, JSON.stringify(environmentsConfig, null, 2))
+    return true
+  } catch (error) {
+    console.error('Error updating environment entry:', error)
+    return false
+  }
+}
+
+export async function removeEnvironmentEntry(environmentName: string): Promise<boolean> {
+  try {
+    await ensureAutomationWorkspaceReady()
+    const filePath = getEnvironmentsFilePath()
+
+    try {
+      await fs.access(filePath)
+    } catch {
+      return true
+    }
+
+    const fileContent = await fs.readFile(filePath, 'utf-8')
+    const environmentsConfig: Record<string, EnvironmentConfig> = JSON.parse(fileContent)
+
+    const envKey = environmentName.toLowerCase().replace(/\s+/g, '_')
+    delete environmentsConfig[envKey]
+
+    if (Object.keys(environmentsConfig).length === 0) {
+      await deleteEnvironmentsFile()
+      return true
+    }
+
+    await fs.writeFile(filePath, JSON.stringify(environmentsConfig, null, 2))
+    return true
+  } catch (error) {
+    console.error('Error removing environment entry:', error)
+    return false
+  }
+}

package/templates/default/src/lib/gherkin-parser.test.ts

@@ -1,44 +1,44 @@
-import test from 'node:test'
-import assert from 'node:assert/strict'
-import { promises as fs } from 'fs'
-import { join } from 'path'
-import { tmpdir } from 'os'
-import { parseFeatureFile } from '@/lib/gherkin-parser'
-
-async function withTempFeatureFile(content: string): Promise<string> {
-  const dir = await fs.mkdtemp(join(tmpdir(), 'gherkin-parser-'))
-  const filePath = join(dir, 'sample.feature')
-  await fs.writeFile(filePath, content, 'utf8')
-  return filePath
-}
-
-test('uses Feature line text as feature description', async () => {
-  const filePath = await withTempFeatureFile(`
-@smoke
-Feature: Login workflow
-
-Scenario: logs in
-  Given user opens app
-`)
-
-  const parsed = await parseFeatureFile(filePath)
-
-  assert.ok(parsed)
-  assert.equal(parsed?.featureName, 'Login workflow')
-  assert.equal(parsed?.featureDescription, 'Login workflow')
-})
-
-test('keeps Feature line as description even when free text follows', async () => {
-  const filePath = await withTempFeatureFile(`
-Feature: Checkout flow
-Legacy block text that should not override the description
-
-Scenario: buys item
-  Given user adds item to cart
-`)
-
-  const parsed = await parseFeatureFile(filePath)
-
-  assert.ok(parsed)
-  assert.equal(parsed?.featureDescription, 'Checkout flow')
-})
+import test from 'node:test'
+import assert from 'node:assert/strict'
+import { promises as fs } from 'fs'
+import { join } from 'path'
+import { tmpdir } from 'os'
+import { parseFeatureFile } from '@/lib/gherkin-parser'
+
+async function withTempFeatureFile(content: string): Promise<string> {
+  const dir = await fs.mkdtemp(join(tmpdir(), 'gherkin-parser-'))
+  const filePath = join(dir, 'sample.feature')
+  await fs.writeFile(filePath, content, 'utf8')
+  return filePath
+}
+
+test('uses Feature line text as feature description', async () => {
+  const filePath = await withTempFeatureFile(`
+@smoke
+Feature: Login workflow
+
+Scenario: logs in
+  Given user opens app
+`)
+
+  const parsed = await parseFeatureFile(filePath)
+
+  assert.ok(parsed)
+  assert.equal(parsed?.featureName, 'Login workflow')
+  assert.equal(parsed?.featureDescription, 'Login workflow')
+})
+
+test('keeps Feature line as description even when free text follows', async () => {
+  const filePath = await withTempFeatureFile(`
+Feature: Checkout flow
+Legacy block text that should not override the description
+
+Scenario: buys item
+  Given user adds item to cart
+`)
+
+  const parsed = await parseFeatureFile(filePath)
+
+  assert.ok(parsed)
+  assert.equal(parsed?.featureDescription, 'Checkout flow')
+})

package/templates/default/src/lib/utils/template-step-file-generator.ts

@@ -1,104 +1,128 @@
-import { promises as fs } from 'fs'
-import { join } from 'path'
-import prettier from 'prettier'
-import { TemplateStep, TemplateStepGroupType } from '@prisma/client'
-import {
-  ensureAutomationWorkspaceReady,
-  getAutomationActionStepsDir,
-  getAutomationStepsDir,
-  getAutomationValidationStepsDir,
-} from '@/lib/automation/paths'
-
-const RUNTIME_IMPORT = '../../../packages/cucumber-runtime/src/index.js'
-const REQUIRED_RUNTIME_IMPORT =
-  `import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '${RUNTIME_IMPORT}';\n\n`
-
-export function sanitizeFileName(groupName: string): string {
-  return groupName
-    .toLowerCase()
-    .trim()
-    .replace(/\s+/g, '_')
-    .replace(/[^a-z0-9_]/g, '')
-}
-
-export function generateFileContent(templateSteps: TemplateStep[]): string {
-  if (!templateSteps || templateSteps.length === 0) {
-    return REQUIRED_RUNTIME_IMPORT + '// This file is generated automatically. Add template steps to this group to generate content.'
-  }
-
-  const functionDefinitions = templateSteps
-    .map(step => step.functionDefinition)
-    .filter(Boolean)
-    .join('\n\n')
-
-  return REQUIRED_RUNTIME_IMPORT + functionDefinitions
-}
-
-export async function formatFileContent(content: string): Promise<string> {
-  try {
-    return await prettier.format(content, {
-      parser: 'typescript',
-      semi: true,
-      singleQuote: true,
-      trailingComma: 'es5',
-      printWidth: 80,
-      tabWidth: 2,
-    })
-  } catch (error) {
-    console.error('Prettier formatting failed:', error)
-    return content
-  }
-}
-
-export function getSubdirectoryName(type: TemplateStepGroupType | string): string {
-  const typeStr = String(type)
-  return typeStr === 'ACTION' ? 'actions' : 'validations'
-}
-
-export async function ensureStepsDirectory(): Promise<string> {
-  await ensureAutomationWorkspaceReady()
-  const stepsDir = getAutomationStepsDir()
-  await fs.mkdir(stepsDir, { recursive: true })
-  await fs.mkdir(getAutomationActionStepsDir(), { recursive: true })
-  await fs.mkdir(getAutomationValidationStepsDir(), { recursive: true })
-  return stepsDir
-}
-
-export function getFilePath(groupName: string, type: TemplateStepGroupType | string): string {
-  const sanitizedName = sanitizeFileName(groupName)
-  const subdirectory = getSubdirectoryName(type)
-  return join(process.cwd(), 'automation', 'steps', subdirectory, `${sanitizedName}.step.ts`)
-}
-
-export async function writeTemplateStepFile(
-  groupName: string,
-  content: string,
-  type: TemplateStepGroupType | string,
-): Promise<void> {
-  try {
-    await ensureStepsDirectory()
-    const formattedContent = await formatFileContent(content)
-    const filePath = getFilePath(groupName, type)
-    await fs.writeFile(filePath, formattedContent, 'utf8')
-  } catch (error) {
-    console.error(`Failed to write template step file for group "${groupName}":`, error)
-    throw new Error(`File generation failed: ${error}`)
-  }
-}
-
-export async function deleteTemplateStepFile(groupName: string, type: TemplateStepGroupType | string): Promise<void> {
-  try {
-    const filePath = getFilePath(groupName, type)
-
-    try {
-      await fs.access(filePath)
-    } catch {
-      return
-    }
-
-    await fs.unlink(filePath)
-  } catch (error) {
-    console.error(`Failed to delete template step file for group "${groupName}":`, error)
-    throw new Error(`File deletion failed: ${error}`)
-  }
-}
+import { promises as fs } from 'fs'
+import { join } from 'path'
+import prettier from 'prettier'
+import { TemplateStep, TemplateStepGroupType } from '@prisma/client'
+import {
+  ensureAutomationWorkspaceReady,
+  getAutomationActionStepsDir,
+  getAutomationStepsDir,
+  getAutomationValidationStepsDir,
+} from '@/lib/automation/paths'
+
+const RUNTIME_IMPORT = '../../../packages/cucumber-runtime/src/index.js'
+const REQUIRED_RUNTIME_IMPORT =
+  `import { When, Then, CustomWorld, expect, SelectorName, resolveLocator, getEnvironment, generateRandomData, RandomDataType } from '${RUNTIME_IMPORT}';\n\n`
+
+function generateStepJSDoc(templateStep: Pick<TemplateStep, 'name' | 'description' | 'icon'>): string {
+  const lines = ['/**']
+  lines.push(` * @name ${templateStep.name}`)
+  if (templateStep.description) {
+    lines.push(` * @description ${templateStep.description}`)
+  }
+  lines.push(` * @icon ${templateStep.icon}`)
+  lines.push(' */')
+  return lines.join('\n')
+}
+
+function stripLeadingJSDoc(functionDefinition: string): string {
+  return functionDefinition.replace(/^\s*\/\*\*[\s\S]*?\*\/\s*/u, '').trim()
+}
+
+function generateStepDefinition(templateStep: TemplateStep): string | null {
+  const functionDefinition = templateStep.functionDefinition?.trim()
+  if (!functionDefinition) {
+    return null
+  }
+
+  return `${generateStepJSDoc(templateStep)}\n${stripLeadingJSDoc(functionDefinition)}`
+}
+
+export function sanitizeFileName(groupName: string): string {
+  return groupName
+    .toLowerCase()
+    .trim()
+    .replace(/\s+/g, '_')
+    .replace(/[^a-z0-9_]/g, '')
+}
+
+export function generateFileContent(templateSteps: TemplateStep[]): string {
+  if (!templateSteps || templateSteps.length === 0) {
+    return REQUIRED_RUNTIME_IMPORT + '// This file is generated automatically. Add template steps to this group to generate content.'
+  }
+
+  const functionDefinitions = templateSteps
+    .map(generateStepDefinition)
+    .filter((definition): definition is string => Boolean(definition))
+    .join('\n\n')
+
+  return REQUIRED_RUNTIME_IMPORT + functionDefinitions
+}
+
+export async function formatFileContent(content: string): Promise<string> {
+  try {
+    return await prettier.format(content, {
+      parser: 'typescript',
+      semi: true,
+      singleQuote: true,
+      trailingComma: 'es5',
+      printWidth: 80,
+      tabWidth: 2,
+    })
+  } catch (error) {
+    console.error('Prettier formatting failed:', error)
+    return content
+  }
+}
+
+export function getSubdirectoryName(type: TemplateStepGroupType | string): string {
+  const typeStr = String(type)
+  return typeStr === 'ACTION' ? 'actions' : 'validations'
+}
+
+export async function ensureStepsDirectory(): Promise<string> {
+  await ensureAutomationWorkspaceReady()
+  const stepsDir = getAutomationStepsDir()
+  await fs.mkdir(stepsDir, { recursive: true })
+  await fs.mkdir(getAutomationActionStepsDir(), { recursive: true })
+  await fs.mkdir(getAutomationValidationStepsDir(), { recursive: true })
+  return stepsDir
+}
+
+export function getFilePath(groupName: string, type: TemplateStepGroupType | string): string {
+  const sanitizedName = sanitizeFileName(groupName)
+  const subdirectory = getSubdirectoryName(type)
+  return join(process.cwd(), 'automation', 'steps', subdirectory, `${sanitizedName}.step.ts`)
+}
+
+export async function writeTemplateStepFile(
+  groupName: string,
+  content: string,
+  type: TemplateStepGroupType | string,
+): Promise<void> {
+  try {
+    await ensureStepsDirectory()
+    const formattedContent = await formatFileContent(content)
+    const filePath = getFilePath(groupName, type)
+    await fs.writeFile(filePath, formattedContent, 'utf8')
+  } catch (error) {
+    console.error(`Failed to write template step file for group "${groupName}":`, error)
+    throw new Error(`File generation failed: ${error}`)
+  }
+}
+
+export async function deleteTemplateStepFile(groupName: string, type: TemplateStepGroupType | string): Promise<void> {
+  try {
+    const filePath = getFilePath(groupName, type)
+
+    try {
+      await fs.access(filePath)
+    } catch {
+      return
+    }
+
+    await fs.unlink(filePath)
+  } catch (error) {
+    console.error(`Failed to delete template step file for group "${groupName}":`, error)
+    throw new Error(`File deletion failed: ${error}`)
+  }
+}