@testspectra/cli 1.0.10 → 1.0.12

package/dist/commands/init.d.ts

@@ -1,3 +1,5 @@
-export declare function initCommand(options: {
+export interface InitCommandOptions {
     force?: boolean;
-}): Promise<void>;
+    template?: "default" | "nx";
+}
+export declare function initCommand(options?: InitCommandOptions): Promise<void>;

package/dist/commands/init.js

@@ -3,23 +3,51 @@ import path from "path";
 import { fileURLToPath } from "url";
 import { ConfigLoader } from "../config/loader.js";
 import { TypeGenerator } from "../types/generator.js";
-export async function initCommand(options) {
+import inquirer from "inquirer";
+export async function initCommand(options = {}) {
     const cwd = process.cwd();
     const existingConfig = ConfigLoader.findConfigFile(cwd);
     if (existingConfig && !options.force) {
         console.log(`\x1b[33m[TestSpectra]\x1b[0m Config already exists at ${path.basename(existingConfig)}. Use --force to overwrite.`);
         return;
     }
+    // Interactive Prompt if template is not specified
+    let selectedTemplate = options.template;
+    if (!selectedTemplate) {
+        // Detect if we are inside an Nx workspace
+        let isNx = false;
+        let checkNx = cwd;
+        while (checkNx !== path.dirname(checkNx)) {
+            if (fs.existsSync(path.join(checkNx, "nx.json"))) {
+                isNx = true;
+                break;
+            }
+            checkNx = path.dirname(checkNx);
+        }
+        const answers = await inquirer.prompt([
+            {
+                type: "list",
+                name: "template",
+                message: "Select TestSpectra project template:",
+                choices: [
+                    { name: "Standard (Standalone or standard monorepo)", value: "default" },
+                    { name: "Nx Monorepo (Includes project.json with Nx targets & affected support)", value: "nx" },
+                ],
+                default: isNx ? "nx" : "default",
+            },
+        ]);
+        selectedTemplate = answers.template;
+    }
+    const templateName = selectedTemplate || "default";
     // 1. Resolve template directory
     const __filename = fileURLToPath(import.meta.url);
     const __dirname = path.dirname(__filename);
-    // Look for templates in ../templates/default (from src) or ../../templates/default (from dist)
-    let templateDir = path.resolve(__dirname, "../templates/default");
+    let templateDir = path.resolve(__dirname, `../templates/${templateName}`);
     if (!fs.existsSync(templateDir)) {
-        templateDir = path.resolve(__dirname, "../../templates/default");
+        templateDir = path.resolve(__dirname, `../../templates/${templateName}`);
     }
     if (!fs.existsSync(templateDir)) {
-        templateDir = path.resolve(__dirname, "../../../templates/default");
+        templateDir = path.resolve(__dirname, `../../../templates/${templateName}`);
     }
     if (!fs.existsSync(templateDir)) {
         throw new Error(`[TestSpectra] Scaffold template directory not found at: ${templateDir}`);
@@ -86,6 +114,11 @@ export async function initCommand(options) {
                 }
                 catch { }
             }
+            else if (src.endsWith("project.json")) {
+                content = content
+                    .replace(/\{\{PROJECT_NAME\}\}/g, projectName)
+                    .replace(/\{\{PROJECT_DIR\}\}/g, path.relative(cur, cwd) || ".");
+            }
             fs.writeFileSync(dest, content, "utf-8");
         }
     }

package/dist/commands/run.js

@@ -31,7 +31,30 @@ export async function runCommand(specPath, options = {}) {
         });
     }
     else {
-        // Scan suites/ directory (suites/Auth/TC-001/web.test.ts)
+        // 1. Scan specs/ directory (Option A: specs/<Suite>/<CaseId>/web.test.ts)
+        const specsDir = path.join(cwd, "specs");
+        if (fs.existsSync(specsDir)) {
+            const suiteEntries = fs.readdirSync(specsDir, { withFileTypes: true });
+            for (const sEntry of suiteEntries) {
+                if (sEntry.name.startsWith(".") || !sEntry.isDirectory())
+                    continue;
+                const currentSuite = sEntry.name;
+                const suitePath = path.join(specsDir, currentSuite);
+                const caseEntries = fs.readdirSync(suitePath, { withFileTypes: true });
+                for (const cEntry of caseEntries) {
+                    if (cEntry.name.startsWith(".") || cEntry.name === "hooks")
+                        continue;
+                    if (cEntry.isDirectory()) {
+                        testCases.push({ id: cEntry.name, title: `${currentSuite} / ${cEntry.name}` });
+                    }
+                    else if (cEntry.isFile() && (cEntry.name.endsWith(".test.ts") || cEntry.name.endsWith(".spec.ts"))) {
+                        const id = cEntry.name.replace(/\.(web|android|ios|common|all|mobile|test|spec)\.ts$/g, "");
+                        testCases.push({ id, title: `${currentSuite} / ${id}` });
+                    }
+                }
+            }
+        }
+        // 2. Fallback: Scan suites/ directory
         const suitesDir = path.join(cwd, "suites");
         if (fs.existsSync(suitesDir)) {
             const suiteEntries = fs.readdirSync(suitesDir, { withFileTypes: true });
@@ -48,22 +71,6 @@ export async function runCommand(specPath, options = {}) {
                 }
             }
         }
-        // Fallback: Scan legacy specs/ directory
-        const specsDir = path.join(cwd, "specs");
-        if (fs.existsSync(specsDir)) {
-            const entries = fs.readdirSync(specsDir, { withFileTypes: true });
-            for (const entry of entries) {
-                if (entry.name.startsWith("."))
-                    continue;
-                if (entry.isDirectory()) {
-                    testCases.push({ id: entry.name, title: entry.name });
-                }
-                else if (entry.isFile() && (entry.name.endsWith(".test.ts") || entry.name.endsWith(".spec.ts"))) {
-                    const id = entry.name.replace(/\.(web|android|ios|common|all|mobile|test|spec)\.ts$/g, "").replace(/\.test\.ts$/, "");
-                    testCases.push({ id, title: id });
-                }
-            }
-        }
     }
     if (testCases.length === 0) {
         testCases.push({

package/dist/index.js

@@ -17,6 +17,7 @@ export function createCliProgram() {
     program
         .command("init")
         .description("Initialize testspectra.config.json and project directories")
+        .option("-t, --template <template>", "Project template: default, nx")
         .option("-f, --force", "Overwrite existing configuration if present")
         .action(initCommand);
     program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testspectra/cli",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "TestSpectra Zero-Config Cross-Platform Test Runner CLI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,7 +20,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@testspectra/matchers": "workspace:*",
+    "@testspectra/matchers": "^1.0.0",
     "chalk": "^5.3.0",
     "chokidar": "^3.6.0",
     "commander": "^12.1.0",

package/templates/default/tsconfig.android.json

@@ -16,8 +16,8 @@
     "steps/**/*.ts",
     "actions/**/*.ts",
     "global-hooks/**/*.ts",
-    "suites/**/hooks/**/*.ts",
-    "suites/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
     "spectra.config.ts"
   ],
   "exclude": [
@@ -31,9 +31,9 @@
     "actions/**/ios.action.ts",
     "global-hooks/**/web.hook.ts",
     "global-hooks/**/ios.hook.ts",
-    "suites/**/hooks/**/web.hook.ts",
-    "suites/**/hooks/**/ios.hook.ts",
-    "suites/**/web.test.ts",
-    "suites/**/ios.test.ts"
+    "specs/**/hooks/**/web.hook.ts",
+    "specs/**/hooks/**/ios.hook.ts",
+    "specs/**/web.test.ts",
+    "specs/**/ios.test.ts"
   ]
 }

package/templates/default/tsconfig.ios.json

@@ -16,8 +16,8 @@
     "steps/**/*.ts",
     "actions/**/*.ts",
     "global-hooks/**/*.ts",
-    "suites/**/hooks/**/*.ts",
-    "suites/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
     "spectra.config.ts"
   ],
   "exclude": [
@@ -31,9 +31,9 @@
     "actions/**/android.action.ts",
     "global-hooks/**/web.hook.ts",
     "global-hooks/**/android.hook.ts",
-    "suites/**/hooks/**/web.hook.ts",
-    "suites/**/hooks/**/android.hook.ts",
-    "suites/**/web.test.ts",
-    "suites/**/android.test.ts"
+    "specs/**/hooks/**/web.hook.ts",
+    "specs/**/hooks/**/android.hook.ts",
+    "specs/**/web.test.ts",
+    "specs/**/android.test.ts"
   ]
 }

package/templates/default/tsconfig.web.json

@@ -16,8 +16,8 @@
     "steps/**/*.ts",
     "actions/**/*.ts",
     "global-hooks/**/*.ts",
-    "suites/**/hooks/**/*.ts",
-    "suites/**/*.ts",
+    "specs/**/hooks/**/*.ts",
+    "specs/**/*.ts",
     "spectra.config.ts"
   ],
   "exclude": [
@@ -35,11 +35,11 @@
     "global-hooks/**/android.hook.ts",
     "global-hooks/**/ios.hook.ts",
     "global-hooks/**/mobile.hook.ts",
-    "suites/**/hooks/**/android.hook.ts",
-    "suites/**/hooks/**/ios.hook.ts",
-    "suites/**/hooks/**/mobile.hook.ts",
-    "suites/**/android.test.ts",
-    "suites/**/ios.test.ts",
-    "suites/**/mobile.test.ts"
+    "specs/**/hooks/**/android.hook.ts",
+    "specs/**/hooks/**/ios.hook.ts",
+    "specs/**/hooks/**/mobile.hook.ts",
+    "specs/**/android.test.ts",
+    "specs/**/ios.test.ts",
+    "specs/**/mobile.test.ts"
   ]
 }

package/templates/nx/actions/applyDiscount/mobile.action.ts

@@ -0,0 +1,6 @@
+export default async function applyDiscount(couponCode: string): Promise<void> {
+  const couponInput = await $('~coupon_input');
+  await couponInput.setValue(couponCode);
+  const applyBtn = await $('~btn_apply');
+  await applyBtn.click();
+}

package/templates/nx/actions/applyDiscount/web.action.ts

@@ -0,0 +1,6 @@
+export default async function applyDiscount(couponCode: string): Promise<void> {
+  const couponInput = await $('#coupon-code');
+  await couponInput.setValue(couponCode);
+  const applyBtn = await $('#apply-coupon-btn');
+  await applyBtn.click();
+}

package/templates/nx/actions/verifyOtp/mobile.action.ts

@@ -0,0 +1,6 @@
+export default async function verifyOtp(otp: string): Promise<void> {
+  const otpInput = await $('~otp_input');
+  await otpInput.setValue(otp);
+  const verifyBtn = await $('~verify_btn');
+  await verifyBtn.click();
+}

package/templates/nx/actions/verifyOtp/web.action.ts

@@ -0,0 +1,6 @@
+export default async function verifyOtp(otp: string): Promise<void> {
+  const otpInput = await $('#otp');
+  await otpInput.setValue(otp);
+  const verifyBtn = await $('#verify-btn');
+  await verifyBtn.click();
+}

package/templates/nx/default/actions/applyDiscount/mobile.action.ts

@@ -0,0 +1,6 @@
+export default async function applyDiscount(couponCode: string): Promise<void> {
+  const couponInput = await $('~coupon_input');
+  await couponInput.setValue(couponCode);
+  const applyBtn = await $('~btn_apply');
+  await applyBtn.click();
+}

package/templates/nx/default/actions/applyDiscount/web.action.ts

@@ -0,0 +1,6 @@
+export default async function applyDiscount(couponCode: string): Promise<void> {
+  const couponInput = await $('#coupon-code');
+  await couponInput.setValue(couponCode);
+  const applyBtn = await $('#apply-coupon-btn');
+  await applyBtn.click();
+}

package/templates/nx/default/actions/verifyOtp/mobile.action.ts

@@ -0,0 +1,6 @@
+export default async function verifyOtp(otp: string): Promise<void> {
+  const otpInput = await $('~otp_input');
+  await otpInput.setValue(otp);
+  const verifyBtn = await $('~verify_btn');
+  await verifyBtn.click();
+}

package/templates/nx/default/actions/verifyOtp/web.action.ts

@@ -0,0 +1,6 @@
+export default async function verifyOtp(otp: string): Promise<void> {
+  const otpInput = await $('#otp');
+  await otpInput.setValue(otp);
+  const verifyBtn = await $('#verify-btn');
+  await verifyBtn.click();
+}

package/templates/nx/default/fixtures/couponCode.json

@@ -0,0 +1 @@
+"DISCOUNT50"

package/templates/nx/default/fixtures/searchQuery.json

@@ -0,0 +1 @@
+"Laptop Gaming"

package/templates/nx/default/fixtures/userData.json

@@ -0,0 +1 @@
+{"username": "tomsmith", "role": "admin"}

package/templates/nx/default/global-hooks/before.web.hook.ts

@@ -0,0 +1,4 @@
+export default async function (): Promise<void> {
+  // Global before setup (executed once before all suites)
+  await browser.maximizeWindow();
+}

package/templates/nx/default/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@testspectra/template-default",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "spectra run",
+    "type-check": "tsc -b"
+  },
+  "devDependencies": {
+    "@testspectra/cli": "workspace:*",
+    "@types/node": "^20.14.0",
+    "@wdio/globals": "^9.2.8",
+    "@wdio/mocha-framework": "^9.2.8",
+    "webdriverio": "^9.2.8",
+    "typescript": "^5.4.5"
+  }
+}

package/templates/nx/default/page-objects/LoginPage/mobile.ts

@@ -0,0 +1,32 @@
+export default class LoginPage {
+  static get usernameInput(): ChainablePromiseElement {
+    return $('~username_input');
+  }
+
+  static get passwordInput(): ChainablePromiseElement {
+    return $('~password_input');
+  }
+
+  static get rememberMeCheckbox(): ChainablePromiseElement {
+    return $('~remember_me_checkbox');
+  }
+
+  static get submitButton(): ChainablePromiseElement {
+    return $('~login_button');
+  }
+
+  static get welcomeText(): ChainablePromiseElement {
+    return $('~welcome_text');
+  }
+
+  static async open() {
+    // Mobile app launch handled by Appium capabilities
+  }
+
+  static async login(username: string, pass: string) {
+    await Spectra.waitForElement(this.usernameInput);
+    await Spectra.type(this.usernameInput, username, { clearFirst: true });
+    await Spectra.type(this.passwordInput, pass, { clearFirst: true });
+    await Spectra.click(this.submitButton);
+  }
+}

package/templates/nx/default/page-objects/LoginPage/web.ts

@@ -0,0 +1,32 @@
+export default class LoginPage {
+  static get usernameInput(): ChainablePromiseElement {
+    return $('#username');
+  }
+
+  static get passwordInput(): ChainablePromiseElement {
+    return $('#password');
+  }
+
+  static get rememberMeCheckbox(): ChainablePromiseElement {
+    return $('#remember-me');
+  }
+
+  static get submitButton(): ChainablePromiseElement {
+    return $('button[type="submit"]');
+  }
+
+  static get flashAlert(): ChainablePromiseElement {
+    return $('#flash');
+  }
+
+  static async open() {
+    await Spectra.navigate('/login');
+  }
+
+  static async login(username: string, pass: string) {
+    await Spectra.waitForElement(this.usernameInput);
+    await Spectra.type(this.usernameInput, username, { clearFirst: true });
+    await Spectra.type(this.passwordInput, pass, { clearFirst: true });
+    await Spectra.click(this.submitButton);
+  }
+}

package/templates/nx/default/page-objects/ProductPage/mobile.ts

@@ -0,0 +1,39 @@
+export default class ProductPage {
+  static get searchInput(): ChainablePromiseElement {
+    return $('~search_input');
+  }
+
+  static get categorySelect(): ChainablePromiseElement {
+    return $('~category_picker');
+  }
+
+  static get productList(): ChainablePromiseElement {
+    return $('~product_list');
+  }
+
+  static get firstProductCard(): ChainablePromiseElement {
+    return $('~product_item_0');
+  }
+
+  static get addToCartButton(): ChainablePromiseElement {
+    return $('~btn_add_to_cart');
+  }
+
+  static get cartBadge(): ChainablePromiseElement {
+    return $('~cart_badge');
+  }
+
+  static async open() {
+    // Mobile in-app navigation to products tab
+  }
+
+  static async filterByCategory(category: string) {
+    await Spectra.click(this.categorySelect);
+    await Spectra.click(`~option_${category}`);
+  }
+
+  static async addFirstProductToCart() {
+    await Spectra.swipe({ direction: "down", distance: 400 });
+    await Spectra.click(this.addToCartButton);
+  }
+}

package/templates/nx/default/page-objects/ProductPage/web.ts

@@ -0,0 +1,38 @@
+export default class ProductPage {
+  static get searchInput(): ChainablePromiseElement {
+    return $('#search-input');
+  }
+
+  static get categorySelect(): ChainablePromiseElement {
+    return $('#category-select');
+  }
+
+  static get productList(): ChainablePromiseElement {
+    return $('#product-grid');
+  }
+
+  static get firstProductCard(): ChainablePromiseElement {
+    return $('.product-card');
+  }
+
+  static get addToCartButton(): ChainablePromiseElement {
+    return $('#add-to-cart');
+  }
+
+  static get cartBadge(): ChainablePromiseElement {
+    return $('#cart-count');
+  }
+
+  static async open() {
+    await Spectra.navigate('/products');
+  }
+
+  static async filterByCategory(category: string) {
+    await Spectra.select(this.categorySelect, category);
+  }
+
+  static async addFirstProductToCart() {
+    await Spectra.scroll({ selector: this.firstProductCard });
+    await Spectra.click(this.addToCartButton);
+  }
+}

package/templates/nx/default/page-objects/SettingsPage/common.ts

@@ -0,0 +1,26 @@
+export default class SettingsPage {
+  static get darkModeToggle(): ChainablePromiseElement {
+    return $('[data-testid="dark-mode-toggle"]');
+  }
+
+  static get languageDropdown(): ChainablePromiseElement {
+    return $('[data-testid="language-select"]');
+  }
+
+  static get saveButton(): ChainablePromiseElement {
+    return $('[data-testid="save-settings"]');
+  }
+
+  static get statusMessage(): ChainablePromiseElement {
+    return $('[data-testid="status-message"]');
+  }
+
+  static async open() {
+    await Spectra.navigate('/settings');
+  }
+
+  static async toggleDarkMode() {
+    await Spectra.click(this.darkModeToggle);
+    await Spectra.click(this.saveButton);
+  }
+}

package/templates/nx/default/specs/Auth/TC-AUTH-01/android.test.ts

@@ -0,0 +1,6 @@
+it("should authenticate user on Android Appium device", async () => {
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  await LoginPage.welcomeText.shouldBeVisible();
+  await LoginPage.welcomeText.shouldContainText("Welcome");
+});

package/templates/nx/default/specs/Auth/TC-AUTH-01/ios.test.ts

@@ -0,0 +1,6 @@
+it("should authenticate user on iOS Appium device", async () => {
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  await LoginPage.welcomeText.shouldBeVisible();
+  await LoginPage.welcomeText.shouldContainText("Welcome");
+});

package/templates/nx/default/specs/Auth/TC-AUTH-01/web.test.ts

@@ -0,0 +1,13 @@
+it("should authenticate user and verify flash message across specific platforms", async () => {
+  await browser.intercept("/api/status", "GET", Fixture.userData);
+
+  // 1. Navigation via Page Object
+  await LoginPage.open();
+
+  // 2. High-level business flow via Shared Step & Page Object
+  await Step.loginUser("tomsmith", "SuperSecretPassword!");
+
+  // 3. Direct callable assertion on Page Object element
+  await LoginPage.flashAlert.shouldBeVisible();
+  await LoginPage.flashAlert.shouldContainText("You logged into a secure area!");
+});

package/templates/nx/default/specs/Auth/TC-AUTH-02/android.test.ts

@@ -0,0 +1,5 @@
+it("should toggle remember me checkbox on Android", async () => {
+  await LoginPage.open();
+  await LoginPage.rememberMeCheckbox.shouldBeVisible();
+  await Spectra.click(LoginPage.rememberMeCheckbox);
+});

package/templates/nx/default/specs/Auth/TC-AUTH-02/web.test.ts

@@ -0,0 +1,5 @@
+it("should toggle remember me checkbox on Web", async () => {
+  await LoginPage.open();
+  await LoginPage.rememberMeCheckbox.shouldBeVisible();
+  await Spectra.click(LoginPage.rememberMeCheckbox);
+});

package/templates/nx/default/specs/Auth/hooks/before.android.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Setup Android Appium capabilities
+}

package/templates/nx/default/specs/Auth/hooks/before.ios.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Setup iOS Appium capabilities
+}

package/templates/nx/default/specs/Auth/hooks/before.web.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Suite-specific setup before test cases in Auth suite run
+}

package/templates/nx/default/specs/Product/TC-PROD-01/mobile.test.ts

@@ -0,0 +1,8 @@
+it("should filter products by category and add to cart on Mobile (Android & iOS)", async () => {
+  await ProductPage.open();
+  await ProductPage.filterByCategory("Electronics");
+  await ProductPage.addFirstProductToCart();
+
+  await ProductPage.cartBadge.shouldBeVisible();
+  await ProductPage.cartBadge.shouldHaveText("1");
+});

package/templates/nx/default/specs/Product/TC-PROD-01/web.test.ts

@@ -0,0 +1,8 @@
+it("should filter products by category and add to cart on Web", async () => {
+  await ProductPage.open();
+  await ProductPage.filterByCategory("Electronics");
+  await ProductPage.addFirstProductToCart();
+
+  await ProductPage.cartBadge.shouldBeVisible();
+  await ProductPage.cartBadge.shouldHaveText("1");
+});

package/templates/nx/default/specs/Product/TC-PROD-02/mobile.test.ts

@@ -0,0 +1,6 @@
+it("should search products and apply promotional discount coupon on Mobile", async () => {
+  await Step.searchProduct(Fixture.searchQuery);
+  await Spectra.applyDiscount(Fixture.couponCode);
+
+  await ProductPage.firstProductCard.shouldBeVisible();
+});

package/templates/nx/default/specs/Product/TC-PROD-02/web.test.ts

@@ -0,0 +1,6 @@
+it("should search products and apply promotional discount coupon on Web", async () => {
+  await Step.searchProduct(Fixture.searchQuery);
+  await Spectra.applyDiscount(Fixture.couponCode);
+
+  await ProductPage.firstProductCard.shouldBeVisible();
+});

package/templates/nx/default/specs/Product/hooks/before.web.hook.ts

@@ -0,0 +1,3 @@
+export default async function (): Promise<void> {
+  // Suite-specific setup for Product catalog suite
+}

package/templates/nx/default/specs/Settings/TC-SET-01/common.test.ts

@@ -0,0 +1,8 @@
+it("should toggle dark mode setting across all platforms (Common)", async () => {
+  await SettingsPage.open();
+  await SettingsPage.darkModeToggle.shouldBeVisible();
+  await SettingsPage.toggleDarkMode();
+
+  await SettingsPage.statusMessage.shouldBeVisible();
+  await SettingsPage.statusMessage.shouldContainText("Settings saved");
+});