create-allwright 0.1.21 → 0.1.23

package/README.md

@@ -15,7 +15,7 @@ npm create allwright@latest
 The initializer prompts for:
 
 - `TypeScript` or `JavaScript`
-- one or more surfaces such as `Web`, `Mobile Android`, and `Mobile iOS`
+- one or more surfaces such as `Web`, `Mobile Android`, `Mobile iOS`, and `Desktop macOS`
 - 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.
@@ -26,9 +26,16 @@ Select Mobile iOS interactively, or scaffold it non-interactively:
 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.
+Select Desktop macOS interactively, or scaffold a `macosApp` project
+non-interactively:
+
+```bash
+npm init allwright@latest macos-tests -- --yes --macos
+```
+
+Use `--all` to scaffold Web, Mobile Android, Mobile iOS, and Desktop macOS
+together. The repeatable `--surface` flag supports the ids `web`,
+`mobile-android`, `mobile-ios`, and `desktop-mac` 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
@@ -36,4 +43,10 @@ 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.
 
+The Desktop macOS starter configures the installed Calculator app and writes a
+lazy `macosApp` screenshot test. Its first run installs `desktop-mac`, starts a
+locally signed copy of the bundled XCUITest runner, and launches Calculator.
+It requires macOS 14 or newer, Xcode, and UI Automation permission for the
+process running Xcode.
+
 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

@@ -13,6 +13,7 @@ const SURFACE_OPTIONS = [
     { label: "Web", value: "web" },
     { label: "Mobile Android", value: "mobile-android" },
     { label: "Mobile iOS", value: "mobile-ios" },
+    { label: "Desktop macOS", value: "desktop-mac" },
 ];
 async function main() {
     const options = parseArgs(process.argv.slice(2));
@@ -100,11 +101,16 @@ function parseArgs(args) {
             case "--ios":
                 options.surfaces.push("mobile-ios");
                 break;
+            case "--desktop-mac":
+            case "--macos":
+            case "--mac":
+                options.surfaces.push("desktop-mac");
+                break;
             case "--both":
                 options.surfaces.push("web", "mobile-android");
                 break;
             case "--all":
-                options.surfaces.push("web", "mobile-android", "mobile-ios");
+                options.surfaces.push("web", "mobile-android", "mobile-ios", "desktop-mac");
                 break;
             case "--surface": {
                 const value = args[index + 1];
@@ -162,7 +168,9 @@ async function selectSurfaces(interactive) {
                 ? "browser automation"
                 : surface.value === "mobile-android"
                     ? "Android app automation"
-                    : "iOS app automation",
+                    : surface.value === "mobile-ios"
+                        ? "iOS app automation"
+                        : "native macOS app automation",
         })),
         required: true,
     });
@@ -235,6 +243,9 @@ function buildProjectFiles(input) {
     if (hasSurface(surfaces, "mobile-ios")) {
         files[`tests/ios.spec.${extension}`] = iosSpecContents(language);
     }
+    if (hasSurface(surfaces, "desktop-mac")) {
+        files[`tests/macos.spec.${extension}`] = macosSpecContents(language);
+    }
     return files;
 }
 function packageJsonContents(packageName, language) {
@@ -324,6 +335,13 @@ function allwrightConfigContents(surfaces) {
         lines.push("      id: com.sedinqa.Flights");
         lines.push('      binary: "https://allwright.dev/Flights-simulator.ipa"');
     }
+    if (hasSurface(surfaces, "desktop-mac")) {
+        lines.push("");
+        lines.push("desktop:");
+        lines.push("  mac:");
+        lines.push("    app:");
+        lines.push("      id: com.apple.calculator");
+    }
     lines.push("");
     lines.push("expect:");
     lines.push("  timeoutMs: 7000");
@@ -373,6 +391,18 @@ test("opens the iOS Flights demo app", { timeout: 180_000 }, async ({ iosApp })
 });
 `;
 }
+function macosSpecContents(language) {
+    const importLine = language === "ts"
+        ? 'import { expect, test } from "@allwright.dev/vitest";'
+        : 'import { expect, test } from "@allwright.dev/vitest";';
+    return `${importLine}
+
+test("opens Calculator through the macOS desktop agent", { timeout: 90_000 }, async ({ macosApp }) => {
+  const screenshot = await macosApp.screenshot();
+  expect(screenshot.byteLength).toBeGreaterThan(0);
+});
+`;
+}
 function generatedReadmeContents(surfaces) {
     const nextSteps = [
         "## Next steps",
@@ -386,6 +416,9 @@ function generatedReadmeContents(surfaces) {
     if (hasSurface(surfaces, "mobile-ios")) {
         nextSteps.push(`${step++}. Start an iOS Simulator, or connect a registered physical device with Developer Mode and UI Automation enabled.`, `${step++}. The first Simulator run downloads and installs the Flights IPA configured in \`allwright.config.yaml\`; physical-device apps must use a signed device build. No manual app or agent installation is needed.`);
     }
+    if (hasSurface(surfaces, "desktop-mac")) {
+        nextSteps.push(`${step++}. Run the suite on macOS 14 or newer with Xcode installed and UI Automation enabled for the process running Xcode.`, `${step++}. The first macOS run installs the desktop plugin, starts its bundled XCUITest runner, and launches Calculator by bundle identifier.`);
+    }
     nextSteps.push(`${step}. Run \`npm test\`.`);
     return `# allwright project
 
@@ -418,6 +451,12 @@ function parseSurfaceId(input) {
     if (normalized === "mobile-ios" || normalized === "ios") {
         return "mobile-ios";
     }
+    if (normalized === "desktop-mac" ||
+        normalized === "desktop-macos" ||
+        normalized === "macos" ||
+        normalized === "mac") {
+        return "desktop-mac";
+    }
     throw new Error(`Unknown surface: ${input}`);
 }
 function parsePackageManager(input) {
@@ -504,6 +543,9 @@ function printSummary(absoluteTargetDir, relativeTargetDir, language, surfaces,
     if (hasSurface(surfaces, "mobile-ios")) {
         console.log("  xcrun simctl list devices available");
     }
+    if (hasSurface(surfaces, "desktop-mac")) {
+        console.log("  xcodebuild -version");
+    }
     console.log(`${packageManager === "npm" ? "  npm test" : `  ${packageManager} test`}`);
 }
 function formatSurfaceLabel(surface) {

package/package.json

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