@flash-ai-team/flash-test-framework 0.0.9 → 0.0.10

package/README.md

@@ -2,22 +2,53 @@
 
 A powerful, keyword-driven automation framework built on top of Playwright and TypeScript, featuring AI-powered capabilities.
 
-## Installation
+## Quick Start
+
+The easiest way to start a new project is using our CLI.
+
+### Global Installation
+
+Alternatively, you can install the CLI globally to run `flash-test` commands directly.
 
 ```bash
-npm install @flash-ai-team/flash-test-framework
+npm install -g @flash-ai-team/flash-test-framework
 ```
 
-## Setup
+Then you can use:
 
-1.  **Initialize Playwright** (if not already done):
+```bash
+flash-test init <project-name>
+flash-test --version
+```
+
+1.  **Initialize a new project**:
+    Make a new folder and run:
     ```bash
-    npx playwright install
+    flash-test init <project-name>
     ```
+    This will create:
+    *   `package.json` with dependencies.
+    *   `playwright.config.ts` configured for the framework.
+    *   `tsconfig.json`.
+    *   `tests/cases/ExampleTests.ts` and `tests/suites/Example.spec.ts`.
+
+2.  **Install dependencies**:
+    ```bash
+    npm install
+    ```
+
+4.  **Run the test**:
+    ```bash
+    npx playwright test
+    ```
+
+## Manual Setup (Optional)
 
-2.  **Configuration**:
-    *   **Email Reporting**: Create `email.config.json` in your project root if you want email reports.
-    *   **AI Features**: Create `ai.config.json` with your OpenAI API key to use `AIWeb`.
+If you prefer to set up manually:
+1.  `npm install @flash-ai-team/flash-test-framework`
+2.  Create `playwright.config.ts` and `tsconfig.json`.
+3.  **Email Reporting**: Create `email.config.json`.
+4.  **AI Features**: Create `ai.config.json`:
     ```json
     {
         "enabled": true,

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/index.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const args = process.argv.slice(2);
+const command = args[0];
+if (command === 'init') {
+    const projectName = args[1];
+    initProject(projectName);
+}
+else if (command === '--version' || command === '-v') {
+    printVersion();
+}
+else {
+    console.log('Usage: flash-test init [project-name]');
+    console.log('       flash-test -v / --version');
+    process.exit(1);
+}
+function printVersion() {
+    try {
+        const packageJsonPath = path_1.default.join(__dirname, '..', '..', 'package.json');
+        const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, 'utf-8'));
+        console.log(`v${packageJson.version}`);
+    }
+    catch (error) {
+        console.error('Error reading version:', error);
+        process.exit(1);
+    }
+}
+function initProject(projectName) {
+    console.log('Initializing Flash Test Project...');
+    let projectDir = process.cwd();
+    let name = "my-flash-test-project";
+    if (projectName) {
+        projectDir = path_1.default.join(process.cwd(), projectName);
+        name = projectName;
+        if (!fs_1.default.existsSync(projectDir)) {
+            fs_1.default.mkdirSync(projectDir);
+            console.log(`Created directory: ${projectName}`);
+        }
+    }
+    // 1. Create Files
+    createFile(path_1.default.join(projectDir, 'package.json'), JSON.stringify({
+        "name": name,
+        "version": "1.0.0",
+        "scripts": {
+            "test": "playwright test"
+        },
+        "devDependencies": {
+            "@flash-ai-team/flash-test-framework": "latest",
+            "@playwright/test": "^1.57.0",
+            "typescript": "^5.9.3"
+        }
+    }, null, 2));
+    createFile(path_1.default.join(projectDir, 'playwright.config.ts'), `
+import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './tests',
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+    reporter: [
+        ['html', { open: 'never' }],
+        ['list'], // Keep 'list' for console output
+        [require.resolve('@flash-ai-team/flash-test-framework/dist/reporting/CustomReporter.js')],
+        [require.resolve('@flash-ai-team/flash-test-framework/dist/reporting/HtmlReporter.js')]
+    ],
+  use: {
+    trace: 'on-first-retry',
+  },
+  projects: [
+    {
+      name: 'chrome',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+});
+`);
+    createFile(path_1.default.join(projectDir, 'tsconfig.json'), JSON.stringify({
+        "compilerOptions": {
+            "target": "es2016",
+            "module": "commonjs",
+            "esModuleInterop": true,
+            "forceConsistentCasingInFileNames": true,
+            "strict": true,
+            "skipLibCheck": true
+        }
+    }, null, 2));
+    createFile(path_1.default.join(projectDir, '.gitignore'), `
+node_modules/
+test-results/
+playwright-report/
+dist/
+`);
+    const testsDir = path_1.default.join(projectDir, 'tests');
+    const casesDir = path_1.default.join(testsDir, 'cases');
+    const suitesDir = path_1.default.join(testsDir, 'suites');
+    if (!fs_1.default.existsSync(testsDir))
+        fs_1.default.mkdirSync(testsDir);
+    if (!fs_1.default.existsSync(casesDir))
+        fs_1.default.mkdirSync(casesDir);
+    if (!fs_1.default.existsSync(suitesDir))
+        fs_1.default.mkdirSync(suitesDir);
+    createFile(path_1.default.join(casesDir, 'ExampleTests.ts'), `
+import { Web, el, TestCase } from '@flash-ai-team/flash-test-framework';
+
+export class ExampleTests {
+
+    @TestCase
+    static async BasicVerify() {
+        await Web.navigateToUrl('https://example.com');
+        await Web.verifyTextPresent('Example Domain');
+        
+        const header = el('h1', 'Header');
+        await Web.verifyElementPresent(header);
+    }
+}
+`);
+    createFile(path_1.default.join(suitesDir, 'Example.spec.ts'), `
+import { test } from '@flash-ai-team/flash-test-framework';
+import { ExampleTests } from '../cases/ExampleTests';
+
+test.describe('Example Suite', () => {
+    test('Basic Verification', async () => {
+        await ExampleTests.BasicVerify();
+    });
+});
+`);
+    console.log('Project initialized successfully!');
+    if (projectName) {
+        console.log(`\nNext steps:\n  cd ${projectName}\n  npm install`);
+    }
+    else {
+        console.log('Run "npm install" to install dependencies.');
+    }
+}
+function createFile(filePath, content) {
+    if (fs_1.default.existsSync(filePath)) {
+        console.log(`Skipping existing file: ${path_1.default.basename(filePath)}`);
+    }
+    else {
+        fs_1.default.writeFileSync(filePath, content.trim());
+        console.log(`Created: ${path_1.default.basename(filePath)}`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flash-ai-team/flash-test-framework",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "A powerful keyword-driven automation framework built on top of Playwright and TypeScript.",
   "keywords": [
     "playwright",
@@ -24,6 +24,9 @@
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "flash-test": "./dist/cli/index.js"
+  },
   "directories": {
     "test": "tests"
   },