inkbridge 0.1.0-beta.20 → 0.1.0-beta.21

package/README.md

@@ -36,13 +36,14 @@ pnpm add -D inkbridge
 pnpm exec inkbridge setup
 ```
 
-`pnpm exec inkbridge setup` is the only required step after install. It prints exactly what it will change before writing anything (run with `--dry-run` to preview without applying):
+`pnpm exec inkbridge setup` is the only required step after install. It prints exactly what it will change before writing anything (run with `--dry-run` to preview without applying, or `--force` to refresh route templates and `inkbridge.config.json` after a plugin update):
 
 - Creates `inkbridge.config.json` in your project root (auto-detects component paths from `.storybook/main.*`)
 - Creates the scanner API route at `src/app/api/inkbridge/scan-components/route.ts`
 - Creates the token patch API route at `src/app/api/inkbridge/patch-tokens/route.ts`
 - Adds `inkbridge:dev` and `inkbridge:scan` scripts to your `package.json`
 - Adds `headers()` to your `next.config.*` exposing CORS on `/api/inkbridge/:path*` so the Figma plugin iframe can reach those routes (scoped — your other routes are untouched)
+- Appends `.inkbridge/` to your `.gitignore` so the scanner-output JSON doesn't show up in every diff
 
 Inkbridge does not modify your ESLint config or any other tooling. The recommended `react/forbid-dom-props` rule for inline styles is suggested in "Recommended lint rules" below, but never written by setup.
 

package/bin/inkbridge.mjs

@@ -157,6 +157,14 @@ function printEnvironment(env) {
 
 async function setup() {
   const dryRun = process.argv.includes("--dry-run");
+  // `--force` re-creates the inkbridge-managed files (route templates,
+  // inkbridge.config.json) even when they already exist. Useful when a
+  // newer plugin version ships an updated template (e.g. the
+  // INKBRIDGE_LOCAL check in the scanner route) and the consumer wants
+  // to refresh without hand-editing. Never touches package.json or
+  // next.config — those are partial-edit territory and force-rewriting
+  // them would clobber consumer state.
+  const force = process.argv.includes("--force");
   const scanRouteDest = join(PROJECT_ROOT, "src/app/api/inkbridge/scan-components/route.ts");
   const scanRouteSrc = join(PACKAGE_DIR, "templates/scan-components-route.ts");
   const patchRouteDest = join(PROJECT_ROOT, "src/app/api/inkbridge/patch-tokens/route.ts");
@@ -165,7 +173,7 @@ async function setup() {
   const inkbridgeCfgPath = join(PROJECT_ROOT, "inkbridge.config.json");
 
   console.log("");
-  console.log(`  inkbridge setup${dryRun ? " — dry run (no files will be written)" : ""}`);
+  console.log(`  inkbridge setup${dryRun ? " — dry run (no files will be written)" : ""}${force ? " — force (overwrite existing inkbridge files)" : ""}`);
   console.log("");
 
   const env = detectEnvironment(PROJECT_ROOT);
@@ -176,14 +184,24 @@ async function setup() {
   // ------------------------------------------------------------------
   const plan = [];
 
-  if (!existsSync(inkbridgeCfgPath)) {
-    plan.push({ kind: "create", path: "inkbridge.config.json", detail: `componentPaths: [${env.componentPaths.join(", ")}]` });
+  if (!existsSync(inkbridgeCfgPath) || force) {
+    plan.push({
+      kind: existsSync(inkbridgeCfgPath) ? "overwrite" : "create",
+      path: "inkbridge.config.json",
+      detail: `componentPaths: [${env.componentPaths.join(", ")}]`,
+    });
   }
-  if (!existsSync(scanRouteDest)) {
-    plan.push({ kind: "create", path: "src/app/api/inkbridge/scan-components/route.ts" });
+  if (!existsSync(scanRouteDest) || force) {
+    plan.push({
+      kind: existsSync(scanRouteDest) ? "overwrite" : "create",
+      path: "src/app/api/inkbridge/scan-components/route.ts",
+    });
   }
-  if (!existsSync(patchRouteDest)) {
-    plan.push({ kind: "create", path: "src/app/api/inkbridge/patch-tokens/route.ts" });
+  if (!existsSync(patchRouteDest) || force) {
+    plan.push({
+      kind: existsSync(patchRouteDest) ? "overwrite" : "create",
+      path: "src/app/api/inkbridge/patch-tokens/route.ts",
+    });
   }
 
   let pkg = null;
@@ -215,6 +233,27 @@ async function setup() {
     });
   }
 
+  // Make sure the scanner-output directory is gitignored. The API
+  // route writes `.inkbridge/component-definitions.json` on every
+  // plugin run; without this entry consumers see the file in their
+  // diff after every `pnpm inkbridge:scan`.
+  const gitignorePath = join(PROJECT_ROOT, ".gitignore");
+  const gitignoreSource = existsSync(gitignorePath)
+    ? readFileSync(gitignorePath, "utf8")
+    : "";
+  const gitignoreNeedsPatch = existsSync(join(PROJECT_ROOT, ".git"))
+    && !gitignoreSource.split("\n").some(line => {
+      const trimmed = line.trim();
+      return trimmed === ".inkbridge" || trimmed === ".inkbridge/";
+    });
+  if (gitignoreNeedsPatch) {
+    plan.push({
+      kind: "modify",
+      path: ".gitignore",
+      detail: "+ .inkbridge/   (scanner output)",
+    });
+  }
+
   if (plan.length === 0) {
     console.log("  Nothing to do — setup is already complete.");
     console.log("");
@@ -224,7 +263,11 @@ async function setup() {
 
   console.log("  Setup will make these changes:");
   for (const item of plan) {
-    const prefix = item.kind === "create" ? "+ create" : "~ modify";
+    const prefix = item.kind === "create"
+      ? "+ create"
+      : item.kind === "overwrite"
+        ? "↻ overwrite"
+        : "~ modify";
     console.log(`    ${prefix}  ${item.path}${item.detail ? `   (${item.detail})` : ""}`);
   }
   console.log("");
@@ -259,8 +302,20 @@ async function setup() {
     } else if (env.nextConfig && item.path === env.nextConfig) {
       await patchNextConfig(PROJECT_ROOT);
       continue;  // patchNextConfig already prints
+    } else if (item.path === ".gitignore") {
+      const existing = existsSync(gitignorePath)
+        ? readFileSync(gitignorePath, "utf8")
+        : "";
+      const needsLeadingNewline = existing.length > 0 && !existing.endsWith("\n");
+      const block = (needsLeadingNewline ? "\n" : "")
+        + "\n# Inkbridge scanner output (regenerated on every plugin run)\n.inkbridge/\n";
+      await writeFile(gitignorePath, existing + block, "utf8");
     }
-    const prefix = item.kind === "create" ? "✓ created" : "✓ modified";
+    const prefix = item.kind === "create"
+      ? "✓ created"
+      : item.kind === "overwrite"
+        ? "✓ overwrote"
+        : "✓ modified";
     console.log(`  ${prefix}  ${item.path}`);
   }