create-allwright 0.1.23 → 0.1.24

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`, `Mobile iOS`, and `Desktop macOS`
+- one or more surfaces such as `Web`, `Mobile Android`, `Mobile iOS`, `Desktop macOS`, and `Desktop Windows`
 - 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.
@@ -33,9 +33,16 @@ non-interactively:
 npm init allwright@latest macos-tests -- --yes --macos
 ```
 
-Use `--all` to scaffold Web, Mobile Android, Mobile iOS, and Desktop macOS
+Select Desktop Windows interactively, or scaffold a `windowsApp` project
+non-interactively:
+
+```bash
+npm init allwright@latest windows-tests -- --yes --windows
+```
+
+Use `--all` to scaffold Web, Mobile Android, Mobile iOS, Desktop macOS, and Desktop Windows
 together. The repeatable `--surface` flag supports the ids `web`,
-`mobile-android`, `mobile-ios`, and `desktop-mac` for explicit combinations.
+`mobile-android`, `mobile-ios`, `desktop-mac`, and `desktop-windows` 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
@@ -49,4 +56,9 @@ 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.
 
+The Desktop Windows starter configures Notepad and writes a lazy `windowsApp`
+screenshot test. Its first run installs `desktop-windows` and starts the bundled,
+self-contained FlaUI UIA3 agent. It requires an interactive Windows 10 or newer
+desktop session; no separate Appium, WinAppDriver, or .NET installation is needed.
+
 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

@@ -14,6 +14,7 @@ const SURFACE_OPTIONS = [
     { label: "Mobile Android", value: "mobile-android" },
     { label: "Mobile iOS", value: "mobile-ios" },
     { label: "Desktop macOS", value: "desktop-mac" },
+    { label: "Desktop Windows", value: "desktop-windows" },
 ];
 async function main() {
     const options = parseArgs(process.argv.slice(2));
@@ -106,11 +107,16 @@ function parseArgs(args) {
             case "--mac":
                 options.surfaces.push("desktop-mac");
                 break;
+            case "--desktop-windows":
+            case "--windows":
+            case "--win":
+                options.surfaces.push("desktop-windows");
+                break;
             case "--both":
                 options.surfaces.push("web", "mobile-android");
                 break;
             case "--all":
-                options.surfaces.push("web", "mobile-android", "mobile-ios", "desktop-mac");
+                options.surfaces.push("web", "mobile-android", "mobile-ios", "desktop-mac", "desktop-windows");
                 break;
             case "--surface": {
                 const value = args[index + 1];
@@ -170,7 +176,9 @@ async function selectSurfaces(interactive) {
                     ? "Android app automation"
                     : surface.value === "mobile-ios"
                         ? "iOS app automation"
-                        : "native macOS app automation",
+                        : surface.value === "desktop-mac"
+                            ? "native macOS app automation"
+                            : "native Windows app automation",
         })),
         required: true,
     });
@@ -246,6 +254,9 @@ function buildProjectFiles(input) {
     if (hasSurface(surfaces, "desktop-mac")) {
         files[`tests/macos.spec.${extension}`] = macosSpecContents(language);
     }
+    if (hasSurface(surfaces, "desktop-windows")) {
+        files[`tests/windows.spec.${extension}`] = windowsSpecContents(language);
+    }
     return files;
 }
 function packageJsonContents(packageName, language) {
@@ -335,13 +346,20 @@ function allwrightConfigContents(surfaces) {
         lines.push("      id: com.sedinqa.Flights");
         lines.push('      binary: "https://allwright.dev/Flights-simulator.ipa"');
     }
-    if (hasSurface(surfaces, "desktop-mac")) {
+    if (hasSurface(surfaces, "desktop-mac") || hasSurface(surfaces, "desktop-windows")) {
         lines.push("");
         lines.push("desktop:");
+    }
+    if (hasSurface(surfaces, "desktop-mac")) {
         lines.push("  mac:");
         lines.push("    app:");
         lines.push("      id: com.apple.calculator");
     }
+    if (hasSurface(surfaces, "desktop-windows")) {
+        lines.push("  windows:");
+        lines.push("    app:");
+        lines.push("      id: notepad.exe");
+    }
     lines.push("");
     lines.push("expect:");
     lines.push("  timeoutMs: 7000");
@@ -403,6 +421,18 @@ test("opens Calculator through the macOS desktop agent", { timeout: 90_000 }, as
 });
 `;
 }
+function windowsSpecContents(language) {
+    const importLine = language === "ts"
+        ? 'import { expect, test } from "@allwright.dev/vitest";'
+        : 'import { expect, test } from "@allwright.dev/vitest";';
+    return `${importLine}
+
+test("opens Notepad through the Windows desktop agent", { timeout: 90_000 }, async ({ windowsApp }) => {
+  const screenshot = await windowsApp.screenshot();
+  expect(screenshot.byteLength).toBeGreaterThan(0);
+});
+`;
+}
 function generatedReadmeContents(surfaces) {
     const nextSteps = [
         "## Next steps",
@@ -419,6 +449,9 @@ function generatedReadmeContents(surfaces) {
     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.`);
     }
+    if (hasSurface(surfaces, "desktop-windows")) {
+        nextSteps.push(`${step++}. Run the suite from an interactive Windows 10 or newer desktop session.`, `${step++}. The first Windows run installs the desktop plugin, starts its bundled FlaUI UIA3 agent, and launches Notepad.`);
+    }
     nextSteps.push(`${step}. Run \`npm test\`.`);
     return `# allwright project
 
@@ -457,6 +490,12 @@ function parseSurfaceId(input) {
         normalized === "mac") {
         return "desktop-mac";
     }
+    if (normalized === "desktop-windows" ||
+        normalized === "desktop-win" ||
+        normalized === "windows" ||
+        normalized === "win") {
+        return "desktop-windows";
+    }
     throw new Error(`Unknown surface: ${input}`);
 }
 function parsePackageManager(input) {

package/package.json

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