@rnx-kit/cli 0.9.57 → 0.11.1

package/src/clean.ts

@@ -0,0 +1,189 @@
+import type { Config as CLIConfig } from "@react-native-community/cli-types";
+import { spawn } from "child_process";
+import { existsSync as fileExists } from "fs";
+import fs from "fs/promises";
+import ora from "ora";
+import os from "os";
+import path from "path";
+
+type Args = {
+  include?: string;
+  projectRoot?: string;
+  verify?: boolean;
+};
+
+type Task = {
+  label: string;
+  action: () => Promise<void>;
+};
+
+type CLICommand = {
+  [key: string]: Task[];
+};
+
+export async function rnxClean(
+  _argv: string[],
+  _config: CLIConfig,
+  cliOptions: Args
+): Promise<void> {
+  const projectRoot = cliOptions.projectRoot ?? process.cwd();
+  if (!fileExists(projectRoot)) {
+    throw new Error(`Invalid path provided! ${projectRoot}`);
+  }
+
+  const npm = os.platform() === "win32" ? "npm.cmd" : "npm";
+  const yarn = os.platform() === "win32" ? "yarn.cmd" : "yarn";
+
+  const COMMANDS: CLICommand = {
+    android: [
+      {
+        label: "Clean Gradle cache",
+        action: () => {
+          const candidates =
+            os.platform() === "win32"
+              ? ["android/gradlew.bat", "gradlew.bat"]
+              : ["android/gradlew", "gradlew"];
+          const gradlew = findPath(projectRoot, candidates);
+          if (gradlew) {
+            const script = path.basename(gradlew);
+            return execute(
+              os.platform() === "win32" ? script : `./${script}`,
+              ["clean"],
+              path.dirname(gradlew)
+            );
+          } else {
+            return Promise.resolve();
+          }
+        },
+      },
+    ],
+    cocoapods: [
+      {
+        label: "Clean CocoaPods cache",
+        action: () => execute("pod", ["cache", "clean", "--all"], projectRoot),
+      },
+    ],
+    metro: [
+      {
+        label: "Clean Metro cache",
+        action: () => cleanDir(`${os.tmpdir()}/metro-*`),
+      },
+      {
+        label: "Clean Haste cache",
+        action: () => cleanDir(`${os.tmpdir()}/haste-map-*`),
+      },
+      {
+        label: "Clean React Native cache",
+        action: () => cleanDir(`${os.tmpdir()}/react-*`),
+      },
+    ],
+    npm: [
+      {
+        label: "Remove node_modules",
+        action: () => cleanDir(`${projectRoot}/node_modules`),
+      },
+      ...(cliOptions.verify
+        ? [
+            {
+              label: "Verify npm cache",
+              action: () => execute(npm, ["cache", "verify"], projectRoot),
+            },
+          ]
+        : []),
+    ],
+    watchman: [
+      {
+        label: "Stop Watchman",
+        action: () =>
+          execute(
+            os.platform() === "win32" ? "tskill" : "killall",
+            ["watchman"],
+            projectRoot
+          ),
+      },
+      {
+        label: "Delete Watchman cache",
+        action: () => execute("watchman", ["watch-del-all"], projectRoot),
+      },
+    ],
+    yarn: [
+      {
+        label: "Clean Yarn cache",
+        action: () => execute(yarn, ["cache", "clean"], projectRoot),
+      },
+    ],
+  };
+
+  const categories = cliOptions.include?.split(",") ?? [
+    "metro",
+    "npm",
+    "watchman",
+    "yarn",
+  ];
+
+  const spinner = ora();
+  for (const category of categories) {
+    const commands = COMMANDS[category];
+    if (!commands) {
+      spinner.warn(`Unknown category: ${category}`);
+      return;
+    }
+
+    for (const { action, label } of commands) {
+      spinner.start(label);
+      await action()
+        .then(() => {
+          spinner.succeed();
+        })
+        .catch((e) => {
+          spinner.fail(`${label} » ${e}`);
+        });
+    }
+  }
+}
+
+function cleanDir(path: string): Promise<void> {
+  if (!fileExists(path)) {
+    return Promise.resolve();
+  }
+
+  return fs.rmdir(path, { maxRetries: 3, recursive: true });
+}
+
+function findPath(startPath: string, files: string[]): string | undefined {
+  // TODO: Find project files via `@react-native-community/cli`
+  for (const file of files) {
+    const filename = path.resolve(startPath, file);
+    if (fileExists(filename)) {
+      return filename;
+    }
+  }
+
+  return undefined;
+}
+
+function execute(command: string, args: string[], cwd: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const process = spawn(command, args, {
+      cwd,
+      stdio: ["inherit", null, null],
+    });
+
+    const stderr: Buffer[] = [];
+    process.stderr.on("data", (data) => {
+      stderr.push(data);
+    });
+
+    process.on("close", (code, signal) => {
+      if (code === 0) {
+        resolve();
+      } else if (stderr) {
+        reject(Buffer.concat(stderr).toString().trimEnd());
+      } else if (signal) {
+        reject(`Failed with signal ${signal}`);
+      } else {
+        reject(`Failed with exit code ${code}`);
+      }
+    });
+  });
+}

package/src/index.ts

@@ -4,3 +4,4 @@ export { rnxStart } from "./start";
 export { rnxTest, rnxTestCommand } from "./test";
 export { rnxWriteThirdPartyNotices } from "./write-third-party-notices";
 export { parseBoolean } from "./parsers";
+export { rnxClean } from "./clean";

package/src/start.ts

@@ -6,13 +6,15 @@ import {
   startServer,
 } from "@rnx-kit/metro-service";
 import chalk from "chalk";
-import type { Reporter, ReportableEvent } from "metro";
-import type Server from "metro/src/Server";
+import type { ReportableEvent, Reporter } from "metro";
 import type { Middleware } from "metro-config";
+import type Server from "metro/src/Server";
+import os from "os";
 import path from "path";
+import qrcode from "qrcode";
 import readline from "readline";
-import { getKitServerConfig } from "./serve/kit-config";
 import { customizeMetroConfig } from "./metro-config";
+import { getKitServerConfig } from "./serve/kit-config";
 import type { TypeScriptValidationOptions } from "./types";
 
 export type CLIStartOptions = {
@@ -85,17 +87,16 @@ export async function rnxStart(
         reportEventDelegate(event);
       }
       if (interactive && event.type === "dep_graph_loading") {
-        terminal.log("To reload the app press '" + chalk.cyanBright("r") + "'");
-        terminal.log(
-          "To open developer menu press '" + chalk.cyanBright("d") + "'"
-        );
-        terminal.log(
-          "To quit, press '" +
-            chalk.cyanBright("control") +
-            "-" +
-            chalk.cyanBright("c") +
-            "'"
-        );
+        const dim = chalk.dim;
+        const press = dim(" › Press ");
+        [
+          ["r", "reload the app"],
+          ["d", "open developer menu"],
+          ["a", "show bundler address QR code"],
+          ["ctrl-c", "quit"],
+        ].forEach(([key, description]) => {
+          terminal.log(press + key + dim(` to ${description}.`));
+        });
       }
     },
   };
@@ -199,14 +200,31 @@ export async function rnxStart(
             process.emit("SIGTSTP", "SIGTSTP");
             break;
         }
-      } else if (name === "r") {
-        terminal.log(chalk.green("Reloading app..."));
-        messageSocket.broadcast("reload", undefined);
-      } else if (name === "d") {
-        terminal.log(chalk.green("Opening developer menu..."));
-        messageSocket.broadcast("devMenu", undefined);
       } else {
-        terminal.log(chalk.grey(_key));
+        switch (name) {
+          case "a": {
+            const protocol = cliOptions.https ? "https" : "http";
+            const host = cliOptions.host || os.hostname();
+            const port = metroConfig.server.port;
+            const url = `${protocol}://${host}:${port}/index.bundle`;
+            qrcode.toString(url, { type: "terminal" }, (_err, qr) => {
+              terminal.log("");
+              terminal.log(url + ":");
+              terminal.log(qr);
+            });
+            break;
+          }
+
+          case "d":
+            terminal.log(chalk.green("Opening developer menu..."));
+            messageSocket.broadcast("devMenu", undefined);
+            break;
+
+          case "r":
+            terminal.log(chalk.green("Reloading app..."));
+            messageSocket.broadcast("reload", undefined);
+            break;
+        }
       }
     });
   }