create-allwright 0.1.15 → 0.1.17

package/README.md

@@ -15,9 +15,25 @@ npm create allwright@latest
 The initializer prompts for:
 
 - `TypeScript` or `JavaScript`
-- one or more surfaces such as `Web` and `Mobile Android`
+- one or more surfaces such as `Web`, `Mobile Android`, and `Mobile iOS`
 - an optional target directory
 
 It scaffolds a Node project with `package.json`, Vitest config, shared allwright config, starter tests, and a short README for the generated app.
 
+Select Mobile iOS interactively, or scaffold it non-interactively:
+
+```bash
+npm init allwright@latest ios-tests -- --yes --ios
+```
+
+Use `--all` to scaffold Web, Mobile Android, and Mobile iOS together. The
+repeatable `--surface` flag supports the ids `web`, `mobile-android`, and
+`mobile-ios` for explicit combinations.
+
+This writes an `iosApp` starter test and configures the public universal
+Simulator IPA at `https://allwright.dev/Flights-simulator.ipa`. On the first
+test run, core installs the `mobile-ios` plugin and its bundled headless XCTest
+agent, then the fixture downloads and installs the sample app. Users do not
+install either component manually.
+
 Dependencies are installed automatically with the package manager that ran the initializer. Existing lockfiles take precedence; use `--package-manager npm|yarn|pnpm|bun` to override detection, or `--no-install` to scaffold without installing.

package/dist/index.js

@@ -12,6 +12,7 @@ const ALLWRIGHT_VERSION = `^${PACKAGE_VERSION}`;
 const SURFACE_OPTIONS = [
     { label: "Web", value: "web" },
     { label: "Mobile Android", value: "mobile-android" },
+    { label: "Mobile iOS", value: "mobile-ios" },
 ];
 async function main() {
     const options = parseArgs(process.argv.slice(2));
@@ -95,9 +96,16 @@ function parseArgs(args) {
             case "--mobile-android":
                 options.surfaces.push("mobile-android");
                 break;
+            case "--mobile-ios":
+            case "--ios":
+                options.surfaces.push("mobile-ios");
+                break;
             case "--both":
                 options.surfaces.push("web", "mobile-android");
                 break;
+            case "--all":
+                options.surfaces.push("web", "mobile-android", "mobile-ios");
+                break;
             case "--surface": {
                 const value = args[index + 1];
                 if (!value) {
@@ -150,7 +158,11 @@ async function selectSurfaces(interactive) {
         message: "Which surfaces would you like to test?",
         options: SURFACE_OPTIONS.map((surface) => ({
             ...surface,
-            hint: surface.value === "web" ? "browser automation" : "Android app automation",
+            hint: surface.value === "web"
+                ? "browser automation"
+                : surface.value === "mobile-android"
+                    ? "Android app automation"
+                    : "iOS Simulator automation",
         })),
         required: true,
     });
@@ -218,7 +230,10 @@ function buildProjectFiles(input) {
         files[`tests/web.spec.${extension}`] = webSpecContents(language);
     }
     if (hasSurface(surfaces, "mobile-android")) {
-        files[`tests/mobile.spec.${extension}`] = mobileSpecContents(language);
+        files[`tests/mobile.spec.${extension}`] = androidSpecContents(language);
+    }
+    if (hasSurface(surfaces, "mobile-ios")) {
+        files[`tests/ios.spec.${extension}`] = iosSpecContents(language);
     }
     return files;
 }
@@ -293,14 +308,22 @@ function allwrightConfigContents(surfaces) {
         lines.push("  browser:");
         lines.push("    name: chromium");
     }
-    if (hasSurface(surfaces, "mobile-android")) {
+    if (hasSurface(surfaces, "mobile-android") || hasSurface(surfaces, "mobile-ios")) {
         lines.push("");
         lines.push("mobile:");
+    }
+    if (hasSurface(surfaces, "mobile-android")) {
         lines.push("  android:");
         lines.push("    app:");
         lines.push("      id: com.example.airticket");
         lines.push('      binary: "https://allwright.dev/Flights-debug.apk"');
     }
+    if (hasSurface(surfaces, "mobile-ios")) {
+        lines.push("  ios:");
+        lines.push("    app:");
+        lines.push("      id: com.sedinqa.Flights");
+        lines.push('      binary: "https://allwright.dev/Flights-simulator.ipa"');
+    }
     lines.push("");
     lines.push("expect:");
     lines.push("  timeoutMs: 7000");
@@ -325,7 +348,7 @@ test("opens the Form Inputs page", { timeout: 30_000 }, async ({ page }) => {
 });
 `;
 }
-function mobileSpecContents(language) {
+function androidSpecContents(language) {
     const importLine = language === "ts"
         ? 'import { test } from "@allwright.dev/vitest";'
         : 'import { test } from "@allwright.dev/vitest";';
@@ -338,16 +361,32 @@ test("opens the Android demo app and navigates to sign up", { timeout: 180_000 }
 });
 `;
 }
+function iosSpecContents(language) {
+    const importLine = language === "ts"
+        ? 'import { expect, test } from "@allwright.dev/vitest";'
+        : 'import { expect, test } from "@allwright.dev/vitest";';
+    return `${importLine}
+
+test("opens the iOS Flights demo app", { timeout: 180_000 }, async ({ iosApp }) => {
+  await iosApp.locator("text=Login").click();
+  await expect(iosApp.locator("text=Welcome back")).toBeVisible();
+});
+`;
+}
 function generatedReadmeContents(surfaces) {
     const nextSteps = [
         "## Next steps",
         "",
         "1. Run `npm install`.",
-        "2. Run `npm test`.",
     ];
+    let step = 2;
     if (hasSurface(surfaces, "mobile-android")) {
-        nextSteps.push("3. Start an Android emulator or connect a device with USB debugging enabled.", "4. Confirm it is visible with `adb devices -l`, then run `npm test`.", "5. The first Android run downloads and installs the Airticket demo app configured in `allwright.config.yaml`.");
+        nextSteps.push(`${step++}. Start an Android emulator or connect a device with USB debugging enabled.`, `${step++}. Confirm it is visible with \`adb devices -l\`.`, `${step++}. The first Android run downloads and installs the Airticket demo app configured in \`allwright.config.yaml\`.`);
+    }
+    if (hasSurface(surfaces, "mobile-ios")) {
+        nextSteps.push(`${step++}. Start an iOS Simulator.`, `${step++}. The first iOS run downloads and installs the Flights simulator IPA configured in \`allwright.config.yaml\`; no manual app or agent installation is needed.`);
     }
+    nextSteps.push(`${step}. Run \`npm test\`.`);
     return `# allwright project
 
 Scaffolded with \`npm init allwright\`.
@@ -376,6 +415,9 @@ function parseSurfaceId(input) {
     if (normalized === "mobile" || normalized === "mobile-android" || normalized === "android") {
         return "mobile-android";
     }
+    if (normalized === "mobile-ios" || normalized === "ios") {
+        return "mobile-ios";
+    }
     throw new Error(`Unknown surface: ${input}`);
 }
 function parsePackageManager(input) {
@@ -459,6 +501,9 @@ function printSummary(absoluteTargetDir, relativeTargetDir, language, surfaces,
     if (hasSurface(surfaces, "mobile-android")) {
         console.log("  adb devices -l");
     }
+    if (hasSurface(surfaces, "mobile-ios")) {
+        console.log("  xcrun simctl list devices available");
+    }
     console.log(`${packageManager === "npm" ? "  npm test" : `  ${packageManager} test`}`);
 }
 function formatSurfaceLabel(surface) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-allwright",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "Create a new allwright test project with npm init allwright.",
   "license": "MIT",
   "type": "module",