@exposify/cli 0.0.3 → 0.0.4

package/dist/index.d.ts

@@ -23,6 +23,8 @@ interface ScannedRoute {
     exposed: boolean;
     /** Exposed only when listed in `expose`, even a read (core's RouteInfo.optIn), e.g. a Pages Router method detected in code. */
     optIn?: boolean;
+    /** Not a tool unless listed in `expose`, so setup leaves it unticked though it's a read: a page that's just a form, a route that finishes a sign-in. */
+    offByDefault?: boolean;
     /** "page": an App Router page read as a tool (its HTML, like a browser), not a route handler. */
     kind?: "page";
     reason: string;
@@ -215,8 +217,13 @@ interface ApplyPlan {
     after: string;
 }
 /** Either a plan, or why this one can't be applied safely (setup then prints the paste instructions). */
+/** `also`: edits to other files that go with the plan, each with what to do by hand when it isn't written. */
 type ApplyOutcome = {
     plan: ApplyPlan;
+    also?: Array<{
+        plan: ApplyPlan;
+        manual: string;
+    }>;
 } | {
     blocked: string;
 };
@@ -300,6 +307,8 @@ interface CliAdapter<R extends ScanResult = ScanResult> {
     entryExample: string;
     /** What `--entry` names, for the usage text, e.g. "The file that creates your Express app". */
     entryHelp: string;
+    /** The adapter's own commands, for the usage text: ["generate", "Writes …"]. Its bin runs them, not runCli. */
+    commands?: Array<[name: string, help: string]>;
     locate(cwd: string, entryFlag?: string): AppLocation | undefined;
     scan(location: AppLocation, env: Record<string, string>): Promise<AdapterScanOutcome<R>>;
     /**

package/dist/index.js

@@ -47,6 +47,7 @@ import { DESCRIPTIONS_FILE, parseDescriptions } from "@exposify/core";
 // src/checklist.ts
 var routeKey = (r) => `${r.method} ${r.path}`;
 var isRead = (r) => r.method === "GET" || r.method === "HEAD";
+var readByDefault = (r) => isRead(r) && !r.offByDefault;
 function isLocked(r) {
   return r.marker !== void 0;
 }
@@ -55,10 +56,10 @@ function initialState(routes, opts) {
   const listed = new Set(opts.listedActions ?? []);
   const selected = /* @__PURE__ */ new Set();
   for (const r of routes) {
-    const ticked = opts.hasConfig || isLocked(r) ? r.exposed : isRead(r);
+    const ticked = opts.hasConfig || isLocked(r) ? r.exposed : readByDefault(r);
     if (ticked) selected.add(routeKey(r));
   }
-  const readsOnly = new Set(routes.filter((r) => isLocked(r) ? r.exposed : isRead(r)).map(routeKey));
+  const readsOnly = new Set(routes.filter((r) => isLocked(r) ? r.exposed : readByDefault(r)).map(routeKey));
   return {
     routes,
     selected,
@@ -130,7 +131,7 @@ function reduce(state, action) {
     case "none":
       return setTicks(state, () => false, true);
     case "readsOnly":
-      return setTicks(state, isRead, true);
+      return setTicks(state, readByDefault, true);
     case "filter":
       return { ...state, filter: action.text, cursor: 0 };
     case "enterNuclear": {
@@ -1345,14 +1346,18 @@ function openInBrowser(url) {
 }
 
 // src/run.ts
-var usage = (bin, entryHelp) => `Usage: ${bin} <command> [options]
+var usage = ({ bin, entryHelp, commands: commands2 = [] }) => `Usage: ${bin} <command> [options]
 
 Commands:
   setup     Pick which endpoints agents can call, then get the aiReady() config to paste
   inspect   Show what agents see: every route, whether it's a tool, and why
   describe  Give tools real descriptions (AI-proposed and reviewed, or your own) in
             ${DESCRIPTIONS_FILE}, which aiReady() loads
-
+${commands2.map(([name, help]) => name.length > 8 ? `  ${name}
+            ${help}
+` : `  ${name.padEnd(8)}  ${help}
+`).join("")}${commands2.length ? `            (${bin} <command> --help for its options)
+` : ""}
 Options:
   --entry <path>        ${entryHelp} (default: detected)
   --env-vars <path>     Load these variables into the scan (setup asks about .env otherwise)
@@ -1795,6 +1800,7 @@ ${bold("Step 3/5")} \xB7 Your aiReady() config${copyNote}
 `);
   console.log(code.replace(/^/gm, "  "));
   let applied = false;
+  let manual = apply && "plan" in apply ? (apply.also ?? []).map((a) => a.manual) : [];
   if (args.apply !== false && (args.apply || tty && !args.quick)) {
     if (!apply) {
       if (args.apply) console.log(yellow("\n  Can't apply automatically here: paste it as described below."));
@@ -1803,20 +1809,31 @@ ${bold("Step 3/5")} \xB7 Your aiReady() config${copyNote}
   Can't apply automatically: ${apply.blocked}. Paste it as described below.`));
     } else {
       const { summary } = apply.plan;
+      const also = apply.also ?? [];
+      const all = [summary, ...also.map((a) => a.plan.summary.replace(/^./, (c) => c.toLowerCase()))];
       const yes = args.apply === true || ["y", "yes"].includes((await ask(`
-  Apply this: ${summary}? ${dim("(y/N)")} `)).toLowerCase());
+  Apply this: ${all.join(", and ")}? ${dim("(y/N)")} `)).toLowerCase());
       if (yes) {
         const written = writePlan(apply.plan);
         if (written.ok) {
           applied = true;
           console.log(green(`  \u2713 Applied: ${summary}.`) + dim(apply.plan.before === null ? "" : " Review it with git diff."));
+          manual = [];
+          for (const a of also) {
+            const done = writePlan(a.plan);
+            if (done.ok) console.log(green(`  \u2713 Applied: ${a.plan.summary}.`) + dim(" Review it with git diff."));
+            else {
+              console.log(yellow(`  Couldn't apply: ${a.plan.summary} (${done.error}).`));
+              manual.push(a.manual);
+            }
+          }
         } else console.log(yellow(`  Couldn't apply: ${written.error}. Paste it as described below.`));
       }
     }
   }
   if (!applied) console.log(`
   ${hint.lines[0]}`);
-  for (const line of hint.lines.slice(1)) console.log(`    ${line}`);
+  for (const line of [...hint.lines.slice(1), ...manual]) console.log(`    ${line}`);
   if (hint.warning) console.log(yellow(`  ! ${hint.warning}`));
   if (droppedGlobs.length > 0) {
     console.log(yellow(`  ! Dropped exclude ${droppedGlobs.map((g) => `"${g}"`).join(", ")}: it would hide endpoints you ticked.`));
@@ -2190,11 +2207,11 @@ async function runCli(argv, forAdapter, cwd = process.cwd()) {
     args = parseArgs(argv);
   } catch (err) {
     console.error(red(err.message));
-    console.error(usage(adapter.bin, adapter.entryHelp));
+    console.error(usage(adapter));
     return 2;
   }
   if (args.help || !args.command) {
-    console.log(usage(adapter.bin, adapter.entryHelp));
+    console.log(usage(adapter));
     return args.help ? 0 : 2;
   }
   if (args.ci) disableColor();
@@ -2215,7 +2232,7 @@ async function runCli(argv, forAdapter, cwd = process.cwd()) {
   if (args.command === "setup") return setup(args, cwd);
   if (args.command === "describe") return describeCommand(args, cwd);
   console.error(red(`unknown command: ${args.command}`));
-  console.error(usage(adapter.bin, adapter.entryHelp));
+  console.error(usage(adapter));
   return 2;
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exposify/cli",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",