@unotest/mobile 0.1.0 → 0.8.0

package/dist/runner/doctor.js

@@ -101,22 +101,22 @@ function runEnvironmentChecks(opts = {}) {
     const pkg = JSON.parse(pkgRaw);
     const deps = { ...pkg.dependencies, ...pkg.devDependencies };
     const isRn = "react-native" in deps || "expo" in deps;
-    if (!isRn) {
+    if (isRn) {
+      results.push({ name: "project-type", severity: "ok", message: "React Native / Expo detected" });
+    } else {
       results.push({
-        name: "rn-project",
-        severity: "warning",
-        message: "package.json doesn't declare react-native or expo.",
-        detail: "unotest-mobile is iOS RN/Expo-focused. Continuing \u2014 but make sure this is intentional."
+        name: "project-type",
+        severity: "ok",
+        message: "no React Native / Expo dependency in package.json",
+        detail: "Assuming a native iOS app (Swift/SwiftUI/Obj-C) or a non-Node project. Selectors resolve via the iOS accessibility tree \u2014 set accessibilityIdentifier on the views you want to target."
       });
-    } else {
-      results.push({ name: "rn-project", severity: "ok", message: "React Native / Expo detected" });
     }
   } catch {
     results.push({
-      name: "rn-project",
-      severity: "warning",
-      message: "No readable package.json in current directory.",
-      detail: "Run init from your project's root."
+      name: "project-type",
+      severity: "ok",
+      message: "no package.json in current directory",
+      detail: "That's fine for native iOS projects. If this is a Node-based project, run from its root so unotest-mobile can detect React Native / Expo."
     });
   }
   return results;
@@ -155,4 +155,3 @@ ${warnings} warning(s). Tests may still work, but review them.`);
 }
 __name(main, "main");
 process.exit(main());
-//# sourceMappingURL=doctor.js.map

package/dist/runner/init.js

@@ -1,7 +1,7 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
-// src/runner/init.ts
+// src/runner/init/run.ts
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { dirname, join, relative, resolve } from "path";
 import { fileURLToPath } from "url";
@@ -106,22 +106,22 @@ function runEnvironmentChecks(opts = {}) {
     const pkg = JSON.parse(pkgRaw);
     const deps = { ...pkg.dependencies, ...pkg.devDependencies };
     const isRn = "react-native" in deps || "expo" in deps;
-    if (!isRn) {
+    if (isRn) {
+      results.push({ name: "project-type", severity: "ok", message: "React Native / Expo detected" });
+    } else {
       results.push({
-        name: "rn-project",
-        severity: "warning",
-        message: "package.json doesn't declare react-native or expo.",
-        detail: "unotest-mobile is iOS RN/Expo-focused. Continuing \u2014 but make sure this is intentional."
+        name: "project-type",
+        severity: "ok",
+        message: "no React Native / Expo dependency in package.json",
+        detail: "Assuming a native iOS app (Swift/SwiftUI/Obj-C) or a non-Node project. Selectors resolve via the iOS accessibility tree \u2014 set accessibilityIdentifier on the views you want to target."
       });
-    } else {
-      results.push({ name: "rn-project", severity: "ok", message: "React Native / Expo detected" });
     }
   } catch {
     results.push({
-      name: "rn-project",
-      severity: "warning",
-      message: "No readable package.json in current directory.",
-      detail: "Run init from your project's root."
+      name: "project-type",
+      severity: "ok",
+      message: "no package.json in current directory",
+      detail: "That's fine for native iOS projects. If this is a Node-based project, run from its root so unotest-mobile can detect React Native / Expo."
     });
   }
   return results;
@@ -137,6 +137,37 @@ function test_smoke_welcome() {
   setDevice("A");
   appLaunch(true);
 }
+`,
+  // Canonical syntax reference for AI agents writing new scenarios. The
+  // sentinel banner up top is the strongest single-line signal against the
+  // default "this is modern JS" assumption that drives agents to write
+  // import/export/async/await. Skill references this file by path; eval
+  // harness seeds the same content into temp workdirs.
+  e2eTemplateExample: `// unotest-mobile JS-DSL \u2014 NOT Node.js.
+//
+// Bare top-level functions only. NO \`import\`/\`export\`/\`async\`/\`await\`/
+// \`const\`/\`let\`/\`var\`/arrow-functions. Assignments are bare-name: \`x = expr;\`.
+// Member access (\`obj.field\`) and object literals (\`{key: value}\`) are
+// forbidden \u2014 payloads are passed as JSON strings.
+//
+// After editing any scenario in this directory:
+//   npx unotest-mobile lint
+//
+// Below: minimal valid example. Copy its shape when writing new scenarios.
+
+// id-example-001
+// Example sign-in flow
+// #4a90e2
+function test_example() {
+  setDevice("A");
+  appLaunch(true);
+
+  type(getByTestId("email-input"), "user@example.com");
+  type(getByTestId("password-input"), "secret123");
+  tap(getByTestId("signin-button"));
+
+  waitFor(getByTestId("home-screen"), 15000);
+}
 `,
   scenarioTemplate: `// id-<your-scenario-id>
 // <one-line description>
@@ -189,54 +220,68 @@ Inside Claude Code, prefer the MCP \`run_test\` tool with
 \`pauseOnFailure: true\` \u2014 it pauses on the failed step so you can
 \`inspect_runtime\`, fix the scenario, and \`resume\`.
 `,
-  envExample: `# unotest-mobile \u2014 copied to unotest/.env by \`init\`. Fill in below.
+  envExample: `# unotest-mobile \u2014 copied to unotest/.env by \`init\`. Fill in only what
+# your scenarios actually use. Most variables are optional.
 
-# --- App under test --------------------------------------------------------
-APP_BUNDLE_ID=com.example.myapp
-APP_URL_SCHEME=myapp
-INVITE_DEEPLINK_PREFIX=myapp://invite/
-
-# --- Backend ---------------------------------------------------------------
-API_BASE_URL=http://localhost:3000/api
-# Optional. Absolute path used as default cwd for the \`shell(...)\` DSL
-# primitive. Set if your scenarios shell out to project-local CLIs
-# (pnpm cli, rails runner, etc.) that must run from the project root.
-PROJECT_ROOT=
-
-# --- Database --------------------------------------------------------------
-# Pick the driver matching your backend. Install peer-deps only as needed:
-#   npm i -D pg @types/pg                 # for postgresql://
-#   npm i -D mysql2                       # for mysql://
-# (SQLite via better-sqlite3 is bundled \u2014 no separate install.)
+# --- Simulators (required for any UI scenario) -----------------------------
+# Names must match \`xcrun simctl list devices\`. SIM_POOL controls which
+# slots are active; each slot in the pool needs the matching SIM_<slot>_NAME.
 #
-# Docker-compose Postgres/MySQL \u2014 ensure host port is exposed
-# (\`ports: ["5432:5432"]\`). Native clients connect from the host, not from
-# inside the compose network.
-DATABASE_URL=postgresql://postgres:postgres@localhost:5432/myapp_test
+# If you have multiple sims with the same name across iOS versions,
+# disambiguate via "<name> @ <runtime>" \u2014 runtime is a substring match,
+# so "iOS 17" or "iOS 17.5" both work.
+# SIM_A_NAME=                        # pick interactively on first \`install\`
+# SIM_A_NAME=iPhone 16 @ iOS 17.5    # pin to a specific runtime
+# SIM_B_NAME=                        # only needed if SIM_POOL includes "B"
+# SIM_POOL=A,B                       # default \u2014 drop "B" if you only need one sim
 
-# --- Simulators ------------------------------------------------------------
-# Names must match \`xcrun simctl list devices\`.
-SIM_A_NAME=iPhone 15
-SIM_B_NAME=iPhone 15 Plus
-SIM_POOL=A,B
+# --- App under test (required if scenarios call appLaunch / openDeeplink) --
+APP_BUNDLE_ID=com.example.myapp
+# APP_URL_SCHEME=myapp           # only used by Expo dev-client recovery flow
+# Optional. Path to a built .app bundle. When set, \`unotest-mobile install\`
+# (and the \`app_install\` MCP tool) can be invoked without an explicit path.
+# Useful for repeated installs after each app rebuild.
+# APP_PATH=./build-sim/Build/Products/Release-iphonesimulator/MyApp.app
+# Comma-separated \`simctl privacy\` services to auto-grant on \`install --clean\`.
+# Populated by \`unotest-mobile install --update-env\` from your app's
+# Info.plist NS*UsageDescription keys. Pre-empts the iOS permission dialog
+# on first launch \u2014 those dialogs live in SpringBoard, not in the app's
+# a11y tree, and would otherwise block your scenarios.
+# APP_PERMISSIONS=location,motion
+
+# --- Backend (optional \u2014 only required if scenarios use apiCall / db) ------
+# API_BASE_URL=http://localhost:3000/api
+# DATABASE_URL=postgresql://postgres:postgres@localhost:5432/myapp_test
+#   Drivers (install peer-deps as needed):
+#     npm i -D pg @types/pg              # for postgresql://
+#     npm i -D mysql2                    # for mysql://
+#   SQLite via better-sqlite3 is bundled \u2014 no separate install.
+#   Docker-compose Postgres/MySQL: ensure host port is exposed
+#   (\`ports: ["5432:5432"]\`). Native clients connect from the host, not
+#   from inside the compose network.
 
-# --- Dev tooling -----------------------------------------------------------
-METRO_URL=http://localhost:8081
-# Expo dev-client: auto-open dev-client deep link after a clean launch.
-EXPO_DEV_CLIENT=false
-SESSION_LOG_PATH=sessions/current.jsonl
-ARTIFACTS_DIR=artifacts
+# --- Optional: shell() default cwd -----------------------------------------
+# Absolute path used as default cwd for the \`shell(...)\` DSL primitive.
+# When unset, shell commands run from process.cwd(). Set to your project
+# root if your scenarios shell out to project-local CLIs that must run
+# from there.
+# PROJECT_ROOT=
 
 # --- WebDriverAgent --------------------------------------------------------
 # Per-slot WDA ports. Each slot in SIM_POOL needs one. Format: "slot=port".
 WDA_PORTS=A=8100,B=8101
-WDA_DEFAULT_ACTION_WAIT_MS=2000
-WDA_DEFAULT_WAITFOR_TIMEOUT_MS=10000
+# WDA_DEFAULT_ACTION_WAIT_MS=2000
+# WDA_DEFAULT_WAITFOR_TIMEOUT_MS=10000
+
+# --- Artifacts / sessions / paused-runtime TTL -----------------------------
+# Defaults are sensible \u2014 uncomment only to override.
+# SESSION_LOG_PATH=unotest/sessions/current.jsonl
+# ARTIFACTS_DIR=unotest/artifacts
+# PAUSED_RUNTIME_TTL_MS=1800000  # 30 min before paused-on-failure auto-abort
 
-# --- D-17 paused-runtime TTL ----------------------------------------------
-# How long a paused-on-failure runtime stays alive before auto-abort (ms).
-# Default 30 minutes. Inspecting the runtime resets the timer.
-PAUSED_RUNTIME_TTL_MS=1800000
+# --- Expo dev-client (reserved for future use) -----------------------------
+# METRO_URL=http://localhost:8081
+# EXPO_DEV_CLIENT=false
 `,
   gitignoreLines: [
     "",
@@ -314,16 +359,16 @@ function appendUniqueLines(existingContent, linesToAdd) {
 }
 __name(appendUniqueLines, "appendUniqueLines");
 
-// src/runner/init.ts
+// src/runner/init/run.ts
 var here = dirname(fileURLToPath(import.meta.url));
 var packageRoot = resolve(here, "..", "..");
-function parseArgs(argv) {
+function parseInitArgs(argv) {
   return {
     force: argv.includes("--force"),
     allowNonMacos: argv.includes("--allow-non-macos")
   };
 }
-__name(parseArgs, "parseArgs");
+__name(parseInitArgs, "parseInitArgs");
 function symbol(severity) {
   return severity === "ok" ? "\u2713" : severity === "warning" ? "\u26A0" : "\u2717";
 }
@@ -346,8 +391,8 @@ function readPackageFile(relativePath) {
   return readFileSync(abs, "utf8");
 }
 __name(readPackageFile, "readPackageFile");
-function main() {
-  const opts = parseArgs(process.argv.slice(2));
+function runInit(argv = process.argv.slice(2)) {
+  const opts = parseInitArgs(argv);
   const target = process.cwd();
   console.log("unotest-mobile init \u2014 bootstrapping project\n");
   console.log("Environment:");
@@ -365,6 +410,7 @@ function main() {
   console.log("\nFiles:");
   const summary = [];
   ensureDir(join(target, "unotest/e2e/_helpers"));
+  ensureDir(join(target, "unotest/e2e/_template"));
   summary.push({
     path: "unotest/e2e/smoke-welcome.js",
     status: writeIfNeeded(join(target, "unotest/e2e/smoke-welcome.js"), templates.smokeWelcome, opts.force)
@@ -373,6 +419,14 @@ function main() {
     path: "unotest/e2e/_template.js",
     status: writeIfNeeded(join(target, "unotest/e2e/_template.js"), templates.scenarioTemplate, opts.force)
   });
+  summary.push({
+    path: "unotest/e2e/_template/example.js",
+    status: writeIfNeeded(
+      join(target, "unotest/e2e/_template/example.js"),
+      templates.e2eTemplateExample,
+      opts.force
+    )
+  });
   summary.push({
     path: "unotest/AGENTS.md",
     status: writeIfNeeded(join(target, "unotest/AGENTS.md"), templates.agentsMd, opts.force)
@@ -448,6 +502,7 @@ Re-check environment anytime: \`npx @unotest/mobile doctor\`
 `);
   return 0;
 }
-__name(main, "main");
-process.exit(main());
-//# sourceMappingURL=init.js.map
+__name(runInit, "runInit");
+
+// src/runner/init.ts
+process.exit(runInit());