Merge pull request #20 from shoma-mano/fix

fix:  runScript can't be used in imported flow

fixtures/sample-flow.ts

@@ -0,0 +1,29 @@
+import { getOutput, M } from "maests";
+import { openApp } from "@/fixtures/utils/openApp";
+import { someScript } from "./utils/script";
+
+// use composable flow easiliy
+openApp();
+
+// run script like this
+M.runScript(someScript);
+
+// use variables set in someScript
+M.assertVisible({ id: getOutput("id") });
+
+// use runFlow to run some flow with condition
+M.runFlow({
+  flow: () => {
+    M.repeatWhileNotVisible(
+      {
+        text: "4",
+      },
+      () => {
+        M.tapOnText("Increment");
+      }
+    );
+  },
+  condition: {
+    visible: "Increment",
+  },
+});

fixtures/utils/hello.ts

@@ -0,0 +1 @@
+export const hello = () => "Hello, World!";

fixtures/utils/openApp.ts

@@ -0,0 +1,6 @@
+import { M } from "maests";
+
+export const openApp = () => {
+  M.initFlow({ appId: "com.my.app" });
+  M.launchApp({ appId: "com.my.app" });
+};

fixtures/utils/script.ts

@@ -0,0 +1,22 @@
+import type { APIResult } from "./type";
+import { hello } from "./hello";
+
+export const someScript = () => {
+  // typed http request
+  const body = http.get("https://jsonplaceholder.typicode.com/todos/1").body;
+  const result = json<APIResult>(body);
+  console.log("id " + result.userId);
+
+  // you can use environment variables
+  console.log(`appId from env: ${process.env.APP_ID}`);
+
+  // you can use imported functions
+  console.log("imported file " + hello());
+
+  if (maestro.platform === "android") {
+    console.log("platform is android");
+  }
+
+  // set a variable to output to use in flow
+  output.id = "com.my.app:id/action_bar_root";
+};

fixtures/utils/type.ts

@@ -0,0 +1,6 @@
+export type APIResult = {
+  userId: number;
+  id: number;
+  title: string;
+  completed: boolean;
+};

package.json

@@ -25,8 +25,6 @@
   "devDependencies": {
     "@types/node": "^18.14.0",
     "changelogen": "^0.5.7",
-    "typescript": "^5.5.4",
-    "@types/babel__core": "^7.20.5",
     "unbuild": "^2.0.0",
     "vitest": "^2.1.3"
   },
@@ -40,6 +38,7 @@
   "keywords": [
     "maestro",
     "e2e",
+    "typescript",
     "testing",
     "React Native"
   ],
@@ -49,13 +48,11 @@
   "homepage": "https://github.com/shoma-mano/maests#readme",
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.26.0",
-    "@babel/types": "^7.26.0",
-    "babel": "^6.23.0",
     "citty": "^0.1.6",
     "consola": "^3.2.3",
     "dotenv": "^16.4.5",
     "esbuild": "^0.24.0",
+    "typescript": "^5.5.4",
     "get-tsconfig": "^4.8.1",
     "jiti": "2.4.0",
     "magicast": "^0.3.5",

playground/e2e/utils/nest-script.ts

@@ -0,0 +1,3 @@
+export const nestScript = () => {
+  console.log("nestScript");
+};

playground/e2e/utils/openApp.ts

@@ -1,6 +1,8 @@
 import { M } from "maests";
+import { nestScript } from "./nest-script";
 
 export const openApp = () => {
   M.initFlow({ appId: "com.my.app" });
   M.launchApp({ appId: "com.my.app" });
+  M.runScript(nestScript);
 };

playground/package.json

@@ -23,7 +23,6 @@
     "expo-status-bar": "~1.12.1",
     "expo-system-ui": "~3.0.7",
     "expo-web-browser": "~13.0.3",
-    "maests": "link:..",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-native": "0.74.5",
@@ -36,6 +35,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.20.0",
+    "maests": "link:..",
     "@types/jest": "^29.5.12",
     "@types/react": "~18.2.45",
     "@types/react-test-renderer": "^18.0.7",

playground/tsconfig.json

@@ -11,6 +11,7 @@
     "**/*.tsx",
     ".expo/types/**/*.ts",
     "expo-env.d.ts",
-    "test.js"
+    "test.js",
+    "e2e/sample-flow.mts"
   ]
 }

src/commands/run.ts

@@ -10,6 +10,13 @@ import { deleteExport } from "../rewrite-code";
 
 export const runScript = (path: string | (() => void), funcName?: string) => {
   if (typeof path === "function") return;
+  const scriptPath = createScriptOutPath(path);
+
+  // add command that references scriptPath
+  const command = `- runScript: ${scriptPath}\n`;
+  addOut(command);
+
+  // write script file to scriptPath
   const { outputFiles } = buildSync({
     entryPoints: [path],
     bundle: true,
@@ -18,17 +25,13 @@ export const runScript = (path: string | (() => void), funcName?: string) => {
     legalComments: "none",
     write: false,
   });
-
   let code = outputFiles[0].text;
   code = code.replace(/(?:\${)?process\.env\.([^\n\s}]*)}?/g, (_, p1) => {
     return process.env[p1] || "";
   });
   code = deleteExport(code);
   code += `\n${funcName ? `${funcName}();` : ""}`;
-  const scriptPath = createScriptOutPath(path);
   writeFileWithDirectorySync(scriptPath, code);
-  const command = `- runScript: ${scriptPath}\n`;
-  addOut(command);
 };
 
 if (import.meta.vitest) {
@@ -47,19 +50,19 @@ if (import.meta.vitest) {
     expect(code).toMatchInlineSnapshot(`
       "// playground/e2e/utils/hello.ts
       var hello = () => "Hello, World!";
-
       // playground/e2e/utils/script.ts
       var someScript = () => {
-        const body = http.get("https://jsonplaceholder.typicode.com/todos/1").body;
-        const result = json(body);
-        console.log("id " + result.userId);
-        console.log(\`appId from env: \`);
-        console.log("imported file " + hello());
-        if (maestro.platform === "android") {
-          console.log("platform is android");
-        }
-        output.id = "com.my.app:id/action_bar_root";
+          const body = http.get("https://jsonplaceholder.typicode.com/todos/1").body;
+          const result = json(body);
+          console.log("id " + result.userId);
+          console.log(\`appId from env: \`);
+          console.log("imported file " + hello());
+          if (maestro.platform === "android") {
+              console.log("platform is android");
+          }
+          output.id = "com.my.app:id/action_bar_root";
       };
+
       someScript();"
     `);
     unlinkSync(scriptPath);

src/main.ts

@@ -31,7 +31,7 @@ const main = defineCommand({
       : join(cwd, args.path);
 
     let code = fs.readFileSync(args.path, "utf-8");
-    code = rewriteCode({ code, yamlOutPath, fullFlowPath });
+    code = await rewriteCode({ yamlOutPath, fullFlowPath });
 
     const tempFilePath = fullFlowPath.replace(".ts", ".temp.ts");
     writeFileSync(tempFilePath, code);