npm - create-appraisejs - Versions diffs - 0.3.0-alpha.0 → 0.3.0-alpha.1 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1087) hide show

package/templates/blank/src/app/layout.tsx ADDED Viewed

@@ -0,0 +1,207 @@
+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 { Toaster } from '@/components/ui/toaster'
+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,
+  Bot,
+  BrickWall,
+  Code,
+  Component,
+  FileCheck,
+  FileSliders,
+  Group,
+  LayoutDashboard,
+  LayoutTemplate,
+  ListChecks,
+  Puzzle,
+  Server,
+  Settings2,
+  Tag,
+  TestTubeDiagonal,
+  TestTubes,
+} from 'lucide-react'
+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: 'dark',
+  themeColor: '#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: 'black-translucent',
+  },
+  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,
+}: Readonly<{
+  children: React.ReactNode
+}>) {
+  return (
+    <html lang="en" className="dark" suppressHydrationWarning>
+      <body className={`${inter.variable} ${interTight.variable} min-h-screen antialiased`}>
+        <ThemeProvider>
+          <div className="mx-auto lg:max-w-screen-xl 2xl:max-w-screen-2xl">
+            <nav className="mb-6 py-2">
+              <div className="flex items-center gap-1">
+                <div className="-ml-2">
+                  <Link href="/">
+                    <Logo />
+                  </Link>
+                </div>
+                <NavLink href="/" icon={<LayoutDashboard className="h-5 w-5 text-primary" />}>
+                  Dashboard
+                </NavLink>
+                <NavMenuCardDeck
+                  containerButtonText="Automate"
+                  containerButtonIcon={<Bot className="h-5 w-5 text-primary" />}
+                  dropdownItems={[
+                    {
+                      text: 'Test Suites',
+                      icon: <TestTubes className="h-6 w-6 text-primary" />,
+                      href: '/test-suites',
+                      description: 'Group tests into logical units',
+                    },
+                    {
+                      text: 'Test Cases',
+                      icon: <TestTubeDiagonal className="h-6 w-6 text-primary" />,
+                      href: '/test-cases',
+                      description: 'Define test scenarios',
+                    },
+                    {
+                      text: 'Test Runs',
+                      icon: <ListChecks className="h-6 w-6 text-primary" />,
+                      href: '/test-runs',
+                      description: 'Execute test scenarios',
+                    },
+                    {
+                      text: 'Reports',
+                      icon: <FileCheck className="h-6 w-6 text-primary" />,
+                      href: '/reports',
+                      description: 'Analyze test results',
+                    },
+                  ]}
+                />
+                <NavMenuCardDeck
+                  containerButtonText="Template"
+                  containerButtonIcon={<BrickWall className="h-5 w-5 text-primary" />}
+                  dropdownItems={[
+                    {
+                      text: 'Template Steps',
+                      icon: <LayoutTemplate className="h-6 w-6 text-primary" />,
+                      href: '/template-steps',
+                      description: 'Define reusable test steps',
+                    },
+                    {
+                      text: 'Template Step Groups',
+                      icon: <Component className="h-6 w-6 text-primary" />,
+                      href: '/template-step-groups',
+                      description: 'Organize template steps into logical groups',
+                    },
+                    {
+                      text: 'Template Test Cases',
+                      icon: <Blocks className="h-6 w-6 text-primary" />,
+                      href: '/template-test-cases',
+                      description: 'Define reusable test scenario templates',
+                    },
+                  ]}
+                />
+                <NavMenuCardDeck
+                  containerButtonText="Configuration"
+                  containerButtonIcon={<FileSliders className="h-5 w-5 text-primary" />}
+                  dropdownItems={[
+                    {
+                      text: 'Locators',
+                      icon: <Code className="h-6 w-6 text-primary" />,
+                      href: '/locators',
+                      description: 'Define reusable locators',
+                    },
+                    {
+                      text: 'Locator Groups',
+                      icon: <Group className="h-6 w-6 text-primary" />,
+                      href: '/locator-groups',
+                      description: 'Organize locators into logical groups',
+                    },
+                    {
+                      text: 'Modules',
+                      icon: <Puzzle className="h-6 w-6 text-primary" />,
+                      href: '/modules',
+                      description: 'Organize tests into logical units',
+                    },
+                    {
+                      text: 'Environments',
+                      icon: <Server className="h-6 w-6 text-primary" />,
+                      href: '/environments',
+                      description: 'Define test environment configurations',
+                    },
+                    {
+                      text: 'Tags',
+                      icon: <Tag className="h-6 w-6 text-primary" />,
+                      href: '/tags',
+                      description: 'Define tags for test scenarios and suites',
+                    },
+                  ]}
+                />
+                <NavLink href="/settings" icon={<Settings2 className="h-5 w-5 text-primary" />}>
+                  Settings
+                </NavLink>
+                <NavCommand className="ml-auto" />
+              </div>
+            </nav>
+            {children}
+            <Toaster />
+          </div>
+        </ThemeProvider>
+      </body>
+    </html>
+  )
+}

package/templates/blank/src/components/theme/theme-provider.tsx ADDED Viewed

@@ -0,0 +1,16 @@
+'use client'
+import * as React from 'react'
+import { ThemeProvider as NextThemesProvider } from 'next-themes'
+type ThemeProviderProps = {
+  children: React.ReactNode
+}
+export function ThemeProvider({ children }: ThemeProviderProps) {
+  return (
+    <NextThemesProvider attribute="class" defaultTheme="dark" forcedTheme="dark" enableSystem={false} disableTransitionOnChange>
+      {children}
+    </NextThemesProvider>
+  )
+}

package/templates/blank/src/lib/template-sync-utils.js ADDED Viewed

@@ -0,0 +1,50 @@
+import { join, relative } from 'path';
+const EXCLUDED_DIRS = new Set(['node_modules', '.next', '.git', 'dist']);
+const EXCLUDED_EXTENSIONS = new Set(['.db', '.sqlite', '.sqlite3', '.tsbuildinfo']);
+const EXCLUDED_PATH_PREFIXES = ['automation/reports/'];
+const EXCLUDED_FILENAMES = new Set(['.DS_Store']);
+function toPosixPath(value) {
+    return value.replace(/\\/g, '/');
+}
+export function shouldExcludeTemplatePath(relativePath) {
+    const normalizedPath = toPosixPath(relativePath);
+    const parts = normalizedPath.split('/');
+    if (parts.some(part => EXCLUDED_DIRS.has(part)))
+        return true;
+    if (parts.some(part => EXCLUDED_FILENAMES.has(part)))
+        return true;
+    if (EXCLUDED_PATH_PREFIXES.some(prefix => normalizedPath.startsWith(prefix)))
+        return true;
+    const ext = normalizedPath.endsWith('.sqlite3')
+        ? '.sqlite3'
+        : normalizedPath.endsWith('.sqlite')
+            ? '.sqlite'
+            : normalizedPath.endsWith('.tsbuildinfo')
+                ? '.tsbuildinfo'
+                : normalizedPath.slice(normalizedPath.lastIndexOf('.'));
+    return EXCLUDED_EXTENSIONS.has(ext);
+}
+export function shouldBackfillLegacyEnvironmentConfig(targetHasEnvironmentsFile, legacyEnvironmentsDirExists) {
+    return !targetHasEnvironmentsFile && legacyEnvironmentsDirExists;
+}
+export function getAutomationFeaturesDir(baseDir) {
+    return join(baseDir, 'automation', 'features');
+}
+export function getAutomationLocatorsDir(baseDir) {
+    return join(baseDir, 'automation', 'locators');
+}
+export function getAutomationLocatorMapPath(baseDir) {
+    return join(baseDir, 'automation', 'mapping', 'locator-map.json');
+}
+export function extractModulePathFromAutomationFile(filePath, baseDir, automationSubdir) {
+    const automationBaseDir = automationSubdir === 'features' ? getAutomationFeaturesDir(baseDir) : getAutomationLocatorsDir(baseDir);
+    const normalizedBaseDir = toPosixPath(automationBaseDir).replace(/\/$/, '');
+    const normalizedFilePath = toPosixPath(filePath);
+    const relativePath = normalizedFilePath.startsWith(`${normalizedBaseDir}/`)
+        ? normalizedFilePath.slice(normalizedBaseDir.length + 1)
+        : toPosixPath(relative(automationBaseDir, filePath));
+    const pathParts = relativePath.split('/').filter(part => part && part !== '');
+    const moduleParts = pathParts.slice(0, -1);
+    return moduleParts.length > 0 ? `/${moduleParts.join('/')}` : '/';
+}
+//# sourceMappingURL=template-sync-utils.js.map

package/templates/blank/src/lib/template-sync-utils.ts ADDED Viewed

@@ -0,0 +1,65 @@
+import { join, relative } from 'path'
+const EXCLUDED_DIRS = new Set(['node_modules', '.next', '.git', 'dist'])
+const EXCLUDED_EXTENSIONS = new Set(['.db', '.sqlite', '.sqlite3', '.tsbuildinfo'])
+const EXCLUDED_PATH_PREFIXES = ['automation/reports/']
+const EXCLUDED_FILENAMES = new Set(['.DS_Store'])
+function toPosixPath(value: string): string {
+  return value.replace(/\\/g, '/')
+}
+export function shouldExcludeTemplatePath(relativePath: string): boolean {
+  const normalizedPath = toPosixPath(relativePath)
+  const parts = normalizedPath.split('/')
+  if (parts.some(part => EXCLUDED_DIRS.has(part))) return true
+  if (parts.some(part => EXCLUDED_FILENAMES.has(part))) return true
+  if (EXCLUDED_PATH_PREFIXES.some(prefix => normalizedPath.startsWith(prefix))) return true
+  const ext = normalizedPath.endsWith('.sqlite3')
+    ? '.sqlite3'
+    : normalizedPath.endsWith('.sqlite')
+      ? '.sqlite'
+      : normalizedPath.endsWith('.tsbuildinfo')
+        ? '.tsbuildinfo'
+        : normalizedPath.slice(normalizedPath.lastIndexOf('.'))
+  return EXCLUDED_EXTENSIONS.has(ext)
+}
+export function shouldBackfillLegacyEnvironmentConfig(
+  targetHasEnvironmentsFile: boolean,
+  legacyEnvironmentsDirExists: boolean,
+): boolean {
+  return !targetHasEnvironmentsFile && legacyEnvironmentsDirExists
+}
+export function getAutomationFeaturesDir(baseDir: string): string {
+  return join(baseDir, 'automation', 'features')
+}
+export function getAutomationLocatorsDir(baseDir: string): string {
+  return join(baseDir, 'automation', 'locators')
+}
+export function getAutomationLocatorMapPath(baseDir: string): string {
+  return join(baseDir, 'automation', 'mapping', 'locator-map.json')
+}
+export function extractModulePathFromAutomationFile(
+  filePath: string,
+  baseDir: string,
+  automationSubdir: 'features' | 'locators',
+): string {
+  const automationBaseDir =
+    automationSubdir === 'features' ? getAutomationFeaturesDir(baseDir) : getAutomationLocatorsDir(baseDir)
+  const normalizedBaseDir = toPosixPath(automationBaseDir).replace(/\/$/, '')
+  const normalizedFilePath = toPosixPath(filePath)
+  const relativePath = normalizedFilePath.startsWith(`${normalizedBaseDir}/`)
+    ? normalizedFilePath.slice(normalizedBaseDir.length + 1)
+    : toPosixPath(relative(automationBaseDir, filePath))
+  const pathParts = relativePath.split('/').filter(part => part && part !== '')
+  const moduleParts = pathParts.slice(0, -1)
+  return moduleParts.length > 0 ? `/${moduleParts.join('/')}` : '/'
+}

package/templates/blank/tsconfig.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "forceConsistentCasingInFileNames": true,
+    "plugins": [{ "name": "next" }],
+    "paths": {
+      "@/*": ["./src/*"],
+      "@locator-picker-companion/*": ["./packages/locator-picker-companion/src/*"]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": ["node_modules", "packages/create-appraisejs", "packages/appraisejs", "templates/starter"]
+}

package/templates/starter/.env.example ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ # Database configuration for local development
2	+ DATABASE_URL="file:./dev.db"

package/templates/starter/.vscode/settings.json ADDED Viewed

@@ -0,0 +1,13 @@
+{
+  "cucumber.features": ["automation/features/**/*.feature"],
+  "cucumber.glue": ["automation/steps/**/*.ts"],
+  "prisma.pinToPrisma6": true,
+  "cucumber.parameterTypes": [
+    {
+      "name": "boolean",
+      "regexp": "true|false"
+    }
+  ],
+  "postman.settings.dotenv-detection-notification-visibility": false
+}

package/templates/starter/README.md ADDED Viewed

@@ -0,0 +1,57 @@
+# Appraise Starter Template
+This is a production-first Appraise starter project. Copy this folder into a new directory to start a new project.
+## Prerequisites
+- Node.js 18+
+- npm, pnpm, yarn, or bun
+## Quick start
+```bash
+# 1. Install dependencies, create .env, and build the production app
+npm run setup
+# 2. Optional: install Playwright browsers when you need test execution
+npm run install-playwright -- chromium
+# 3. Optional: install an extra published template step
+npx appraisejs@latest add step <group-slug>/<step-slug>
+# 4. Start the local production server
+npm run start
+```
+## What you get
+- **URL**: Open [http://localhost:3000](http://localhost:3000) in your browser.
+- **Runtime**: A seeded local SQLite database at `prisma/dev.db`.
+- **Automation**: Starter automation assets under `automation/`, including features, locators, environments, and reusable steps.
+- **UI**: The full Appraise dashboard and UI, ready to run from a production build.
+## Scripts
+| Script | Description |
+| --- | --- |
+| `npm run setup` | Install deps, create `.env`, and build the cucumber runtime plus the local production app |
+| `npm run build:local` | Build the cucumber runtime and the local production app |
+| `npm run start` | Start the local production server |
+| `npm run dev` | Start the Next.js development server |
+| `npm run install-playwright -- <browser...>` | Install selected Playwright browsers |
+| `npm run setup:db` | Recreate the local SQLite database from migrations and rerun `sync-all` |
+| `npm run setup:full` | Reinstall dependencies, rebuild the DB, rerun `sync-all`, and rebuild the production app |
+| `npm run sync-all` | Sync all starter entities from the bundled automation workspace into the database |
+| `npm run appraisejs:sync` | Alias for `sync-all` |
+| `npm run appraisejs:install-step -- --payload-file <path>` | Internal script used by `npx appraisejs@latest add step ...` |
+## Configuration
+- Copy `.env.example` to `.env` before running, or let `npm run setup` create it.
+- Default local database URL: `DATABASE_URL="file:./dev.db"`.
+- The database file is created at `prisma/dev.db`.
+## Notes
+- `npm run setup` does not install Playwright browsers automatically. Install them only when you need browser-based test execution.
+- `npm run dev` is still available for development workflows, but `npm run start` is the primary path for day-to-day local usage.

package/templates/starter/automation/config/environments/environments.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {}

package/templates/starter/automation/mapping/locator-map.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ []

package/templates/starter/components.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.ts",
+    "css": "src/app/globals.css",
+    "baseColor": "slate",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "registries": {
+    "@kokonutui": "https://kokonutui.com/r/{name}.json"
+  }
+}

package/templates/starter/cucumber.mjs ADDED Viewed

@@ -0,0 +1,16 @@
+// eslint-disable-next-line import/no-anonymous-default-export
+export default {
+  paths: ['automation/features/**/*.feature'],
+  import: [
+    'packages/cucumber-runtime/src/parameter-types.ts',
+    'automation/steps/**/*.ts',
+    'packages/cucumber-runtime/src/hooks.ts',
+    'packages/cucumber-runtime/src/world.ts',
+  ],
+  loader: ['ts-node/esm'],
+  format: [
+    'pretty',
+    process.env.REPORT_FORMAT ?? `json:${process.env.REPORT_PATH ?? 'automation/reports/cucumber.json'}`,
+  ],
+  publishQuiet: true,
+}

package/templates/starter/eslint.config.mjs ADDED Viewed

@@ -0,0 +1,20 @@
+import nextCoreWebVitals from 'eslint-config-next/core-web-vitals';
+import nextTypescript from 'eslint-config-next/typescript';
+const eslintConfig = [
+  ...nextCoreWebVitals,
+  ...nextTypescript,
+  {
+    ignores: [
+      'automation/steps/**/*.step.ts',
+      'automation/steps/**/*',
+      'packages/cucumber-runtime/dist/**/*',
+      'packages/locator-picker-companion/dist/**/*',
+      'packages/appraisejs/registry/**/*',
+      'templates/**/*',
+      'packages/create-appraisejs/templates/**/*',
+    ],
+  },
+];
+export default eslintConfig;

package/templates/starter/gitignore ADDED Viewed

@@ -0,0 +1,56 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+# testing
+/coverage
+# next.js
+/.next/
+/out/
+# production
+/build
+# misc
+.DS_Store
+*.pem
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+# env files (can opt-in for committing if needed)
+.env*
+!.env.example
+!**/.env.example
+# database files
+*.db
+*.sqlite
+*.sqlite3
+# vercel
+.vercel
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+automation/reports/*
+packages/cucumber-runtime/dist/*
+# temporary files
+.tmp
+!prisma/dev.db
+!automation/config/environments/environments.json

package/templates/starter/next-env.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+import "./.next/dev/types/routes.d.ts";
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

package/templates/starter/next.config.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import type { NextConfig } from 'next'
+const disableDevtools = process.env.DISABLE_DEVTOOLS === '1' || process.env.DISABLE_DEVTOOLS === 'true'
+const nextConfig: NextConfig = {
+  ...(disableDevtools && {
+    devIndicators: false,
+  }),
+  // Suppress Turbopack NFT false positive when tracing cwd-based path helpers (import trace lists next.config).
+  turbopack: {
+    ignoreIssue: [
+      {
+        path: /next\.config\.ts$/,
+        title: /unexpected file in NFT list/i,
+      },
+    ],
+  },
+}
+export default nextConfig