@farm.js/cli 0.1.0-beta.6 → 0.1.0-beta.60

package/bin/farm.js

@@ -16,20 +16,58 @@ const { program } = require("commander");
 const { version } = require("../package.json");
 
 const banner = `
- _______                         
-|  ___  |__ _ _ __ _ __ ___     
-| |_ /| / _\` | '__| '_ \` _ \\ 
-|  _ \\| | (_| | |  | | | | | |
-|_| \\_\\_|\\__,_|_|  |_| |_| |_|
+░██████████   ░███    ░█████████  ░███     ░███         ░█████   ░██████
+░██          ░██░██   ░██     ░██ ░████   ░████           ░██   ░██   ░██
+░██         ░██  ░██  ░██     ░██ ░██░██ ░██░██           ░██  ░██
+░█████████ ░█████████ ░█████████  ░██ ░████ ░██           ░██   ░████████
+░██        ░██    ░██ ░██   ░██   ░██  ░██  ░██     ░██   ░██          ░██
+░██        ░██    ░██ ░██    ░██  ░██       ░██     ░██   ░██   ░██   ░██
+░██        ░██    ░██ ░██     ░██ ░██       ░██ ░██  ░██████     ░██████
 `;
 
-program.name("farm").description("Farm.js CLI - A modern React meta-framework").version(version);
+program
+  .name("farm")
+  .description("Farm.js CLI - A framework for product-integrated apps")
+  .version(version);
 program.addHelpText("beforeAll", `${banner}\n`);
 
 function collectOption(value, previous) {
   return [...(previous || []), value];
 }
 
+function telemetryCommandPath(command) {
+  const segments = [];
+  let current = command;
+  while (current && current !== program) {
+    segments.unshift(current.name());
+    current = current.parent;
+  }
+  return segments.join(":");
+}
+
+function telemetryDeployTarget(commandPath, options) {
+  if (commandPath !== "deploy") return undefined;
+  if (options.vercel) return "vercel";
+  if (options.cloudflare) return "cloudflare";
+  if (options.netlify) return "netlify";
+  if (options.custom) return "custom";
+  return undefined;
+}
+
+program.hook("preAction", (_command, actionCommand) => {
+  const commandPath = telemetryCommandPath(actionCommand);
+  if (commandPath.startsWith("telemetry")) return;
+  const { resolveFarmTelemetryCommand, trackFarmCommand } = require("../dist/telemetry.js");
+  const command = resolveFarmTelemetryCommand(commandPath);
+  if (!command) return;
+  const options = actionCommand.opts();
+  void trackFarmCommand({
+    command,
+    packageVersion: version,
+    deployTarget: telemetryDeployTarget(commandPath, options),
+  });
+});
+
 program
   .command("dev")
   .description("Start development server")
@@ -80,6 +118,24 @@ program
     }
   });
 
+program
+  .command("start")
+  .description("Run the Node server produced by farm build")
+  .option("-r, --root <root>", "Root directory", process.cwd())
+  .option("-p, --port <port>", "Port for the server to listen on")
+  .option("-H, --host <host>", "Host for the server to bind to")
+  .action(async (options) => {
+    try {
+      const { startFarm } = require("../dist/index.js");
+      await startFarm(options);
+    } catch (error) {
+      const code = error?.name === "FarmStartError" ? ` [${error.code}]` : "";
+      const message = error instanceof Error ? error.message : String(error);
+      console.error(`Failed to start${code}: ${message}`);
+      process.exitCode = 1;
+    }
+  });
+
 const authCommand = program.command("auth").description("Manage Farm-native authentication");
 
 authCommand
@@ -144,6 +200,7 @@ program
   )
   .option("--dialect <dialect>", "SQL dialect for Drizzle generation (postgres, mysql, sqlite)")
   .option("-o, --output <output>", "Custom output path")
+  .option("--check", "Fail when committed generated framework types are stale")
   .action(async (options) => {
     try {
       const { generateFarmArtifacts } = require("../dist/index.js");
@@ -153,6 +210,7 @@ program
         orm: options.orm,
         dialect: options.dialect,
         output: options.output,
+        check: options.check,
       });
     } catch (error) {
       console.error("Failed to generate Farm artifacts:", error);
@@ -169,6 +227,7 @@ program
   .option("--host <host>", "Host of a running local app")
   .option("--url <url>", "Base URL of a running Farm app")
   .option("--offline", "Inspect project files without probing a running app")
+  .option("--fix", "Apply safe additive corrections without overwriting application files")
   .option("--timeout <ms>", "Live runtime probe timeout in milliseconds", "1200")
   .option("--json", "Print machine-readable JSON")
   .action(async (options) => {
@@ -185,6 +244,7 @@ program
         host: options.host,
         url: options.url,
         offline: options.offline,
+        fix: options.fix,
         timeoutMs,
       });
       console.log(options.json ? JSON.stringify(report, null, 2) : formatFarmDoctorReport(report));
@@ -195,6 +255,30 @@ program
     }
   });
 
+program
+  .command("explain <path>")
+  .description("Explain how a URL maps to a Farm route and deployment runtime")
+  .option("-r, --root <root>", "Root directory", process.cwd())
+  .option("-c, --config <config>", "Path to farm config file")
+  .option("--json", "Print machine-readable JSON")
+  .action(async (pathname, options) => {
+    try {
+      const { explainFarmRoute, formatFarmRouteExplanation } = require("../dist/index.js");
+      const explanation = await explainFarmRoute(pathname, {
+        root: options.root,
+        configPath: options.config,
+      });
+      console.log(
+        options.json
+          ? JSON.stringify(explanation, null, 2)
+          : formatFarmRouteExplanation(explanation),
+      );
+    } catch (error) {
+      console.error("Failed to explain Farm route:", error);
+      process.exit(1);
+    }
+  });
+
 program
   .command("preview")
   .description("Create a public URL for a running local Farm app")
@@ -433,15 +517,63 @@ program
   .option("--cloudflare", "Deploy to Cloudflare")
   .option("--netlify", "Deploy to Netlify")
   .option("--prod", "Deploy to production (Vercel: uses prebuilt output)")
+  .option("--plan", "Print the resolved deployment plan without building or deploying")
   .option("--custom", "Use your own credentials (not Farm.js managed)")
   .action(async (options) => {
     try {
       const { deployFarm } = require("../dist/index.js");
       await deployFarm(options);
     } catch (error) {
-      console.error("Failed to deploy:", error);
-      process.exit(1);
+      const code = error?.name === "FarmDeployError" ? ` [${error.code}]` : "";
+      const message = error instanceof Error ? error.message : String(error);
+      console.error(`Failed to deploy${code}: ${message}`);
+      process.exitCode = 1;
+    }
+  });
+
+const telemetryCommand = program
+  .command("telemetry")
+  .description("Control anonymous Farm.js product telemetry");
+
+telemetryCommand
+  .command("status")
+  .description("Show the current telemetry setting")
+  .action(async () => {
+    const { getFarmTelemetryStatus } = require("../dist/telemetry.js");
+    const status = await getFarmTelemetryStatus();
+    console.log(`Anonymous telemetry: ${status.enabled ? "enabled" : "disabled"}`);
+    console.log(`Active for this command: ${status.active ? "yes" : "no"}`);
+    console.log(`Setting source: ${status.source}`);
+    if (status.reason) console.log(`Reason: ${status.reason}`);
+    console.log(`Local anonymous ID: ${status.anonymousId ? "created" : "not created"}`);
+    console.log(`Configuration: ${status.configFile}`);
+    console.log("Privacy details: https://farmjs.dev/docs/telemetry");
+  });
+
+telemetryCommand
+  .command("enable")
+  .description("Enable anonymous Farm.js product telemetry")
+  .action(async () => {
+    const { setFarmTelemetryEnabled } = require("../dist/telemetry.js");
+    const status = await setFarmTelemetryEnabled(true);
+    console.log("Anonymous Farm.js telemetry is enabled.");
+    if (!status.active && status.reason)
+      console.log(`It is inactive here because ${status.reason}.`);
+  });
+
+telemetryCommand
+  .command("disable")
+  .description("Opt out and delete the local anonymous installation ID")
+  .action(async () => {
+    const { setFarmTelemetryEnabled } = require("../dist/telemetry.js");
+    const status = await setFarmTelemetryEnabled(false);
+    console.log("Anonymous Farm.js telemetry is disabled and its local ID was deleted.");
+    if (status.enabled) {
+      console.log("An environment variable currently overrides the saved setting.");
     }
   });
 
-program.parse();
+program.parseAsync().catch((error) => {
+  console.error("Farm CLI failed:", error);
+  process.exitCode = 1;
+});