@algolia/wizard 0.15.0 → 0.16.0

package/dist/main.js

@@ -2507,8 +2507,8 @@ function writeFileTool(ctx) {
 // src/lib/tools/writeAlgoliaCredentials.ts
 import { tool as tool6 } from "ai";
 import z13 from "zod";
-import { mkdir as mkdir4, readFile as readFile5, writeFile as writeFile4 } from "node:fs/promises";
-import { dirname as dirname5 } from "node:path";
+import { mkdir as mkdir4, readFile as readFile6, writeFile as writeFile5 } from "node:fs/promises";
+import { dirname as dirname5, relative as relative3 } from "node:path";
 
 // src/lib/algoliaApiKey.ts
 import { z as z12 } from "zod";
@@ -2690,6 +2690,79 @@ async function resolveSearchOnlyKey(index, appId, envKey) {
   );
 }
 
+// src/lib/gitignore.ts
+import { execFile } from "node:child_process";
+import { lstat as lstat2, readFile as readFile5, writeFile as writeFile4 } from "node:fs/promises";
+import { join as join8, relative as relative2 } from "node:path";
+var GIT_ENV_OVERRIDES = [
+  "GIT_DIR",
+  "GIT_WORK_TREE",
+  "GIT_INDEX_FILE",
+  "GIT_OBJECT_DIRECTORY",
+  "GIT_COMMON_DIR"
+];
+function gitSucceeds(root, args) {
+  const env = { ...process.env };
+  for (const key of GIT_ENV_OVERRIDES) delete env[key];
+  return new Promise((resolve4) => {
+    execFile("git", ["-C", root, ...args], { env }, (err) => {
+      if (!err) return resolve4(true);
+      resolve4(
+        err.code === 1 ? false : void 0
+      );
+    });
+  });
+}
+function isIgnoredByRule(root, relPath) {
+  return gitSucceeds(root, ["check-ignore", "-q", "--no-index", "--", relPath]);
+}
+function isTracked(root, relPath) {
+  return gitSucceeds(root, ["ls-files", "--error-unmatch", "--", relPath]);
+}
+async function inspect(root, target) {
+  const relPath = relative2(root, target);
+  if (!relPath || relPath.startsWith("..")) {
+    return { ignoredByRule: void 0, tracked: false };
+  }
+  const ignoredByRule = await isIgnoredByRule(root, relPath);
+  if (ignoredByRule === void 0) {
+    logger.warn(
+      { root, relPath },
+      "gitignore: git check-ignore could not answer; not reporting on this path"
+    );
+    return { ignoredByRule, tracked: false };
+  }
+  return { ignoredByRule, tracked: await isTracked(root, relPath) };
+}
+async function ensureGitIgnored(root, target) {
+  const { ignoredByRule, tracked } = await inspect(root, target);
+  if (ignoredByRule === void 0) return "unknown";
+  if (ignoredByRule) return tracked ? "tracked" : "covered";
+  const pattern = relative2(root, target);
+  const gitIgnore = join8(root, ".gitignore");
+  try {
+    const link = await lstat2(gitIgnore).catch(() => null);
+    if (link?.isSymbolicLink()) {
+      logger.warn(
+        { gitIgnore },
+        "gitignore: root .gitignore is a symlink; not writing to it"
+      );
+      return "unknown";
+    }
+    const existing = link ? await readFile5(gitIgnore, "utf8") : "";
+    const prefix = existing.length > 0 && !existing.endsWith("\n") ? "\n" : "";
+    await writeFile4(gitIgnore, `${existing}${prefix}${pattern}
+`, "utf8");
+    return tracked ? "tracked" : "added";
+  } catch (err) {
+    logger.warn(
+      { gitIgnore, pattern, err: err.message },
+      "gitignore: could not add the pattern; continuing"
+    );
+    return "unknown";
+  }
+}
+
 // src/lib/tools/writeAlgoliaCredentials.ts
 var APP_ID_VAR = "ALGOLIA_APPLICATION_ID";
 var API_KEY_VAR = "ALGOLIA_WRITE_API_KEY";
@@ -2722,7 +2795,7 @@ function upsertEnv(content, name, value) {
 }
 function writeCredentialsTool(ctx) {
   return tool6({
-    description: `Write the active Algolia credentials (${APP_ID_VAR} and ${API_KEY_VAR}) and the target index name (${INDEX_NAME_VAR}) into the given env file. The credentials come from the selected Algolia application, with a write key scoped to the target index; you only pass the path to the env file. ${INDEX_NAME_VAR} is always set to this run's target index, replacing any value already there. An ${APP_ID_VAR} or ${API_KEY_VAR} the file already gives a value is left untouched; a missing or blank one is filled in when it can be paired with the selected application.`,
+    description: `Write the active Algolia credentials (${APP_ID_VAR} and ${API_KEY_VAR}) and the target index name (${INDEX_NAME_VAR}) into the given env file. The credentials come from the selected Algolia application, with a write key scoped to the target index; you only pass the path to the env file. ${INDEX_NAME_VAR} is always set to this run's target index, replacing any value already there. An ${APP_ID_VAR} or ${API_KEY_VAR} the file already gives a value is left untouched; a missing or blank one is filled in when it can be paired with the selected application. The env file is added to .gitignore automatically; do not edit .gitignore yourself.`,
     inputSchema: z13.object({
       filePath: z13.string().describe(
         'Path to the env file to write credentials into (e.g. ".env")'
@@ -2743,7 +2816,7 @@ function writeCredentialsTool(ctx) {
           return `Refused: ${resolved2.target} is outside the repo root (${ctx.root}).`;
         }
         try {
-          existing = await readFile5(resolved2.target, "utf8");
+          existing = await readFile6(resolved2.target, "utf8");
         } catch (err) {
           if (err.code !== "ENOENT") throw err;
         }
@@ -2782,6 +2855,7 @@ function writeCredentialsTool(ctx) {
           return `Error: could not resolve Algolia credentials (${err.message}). Ask the user to authenticate with the Algolia CLI first.`;
         }
       }
+      let wrote;
       try {
         const updated = [
           ...credentials,
@@ -2793,7 +2867,7 @@ function writeCredentialsTool(ctx) {
           existing
         );
         await mkdir4(dirname5(resolved2.target), { recursive: true });
-        await writeFile4(resolved2.target, updated, "utf8");
+        await writeFile5(resolved2.target, updated, "utf8");
         const sentences = [
           `Wrote ${[...credentials.map(([name]) => name), INDEX_NAME_VAR].join(", ")} to ${filePath}.`
         ];
@@ -2807,19 +2881,33 @@ function writeCredentialsTool(ctx) {
             `Skipped ${present.join(" and ")}: already defined there.`
           );
         }
-        return [...sentences, ...notes].join(" ");
+        wrote = [...sentences, ...notes].join(" ");
       } catch (err) {
         return `Error writing credentials to ${filePath}: ${err.message}`;
       }
+      return wrote + await gitIgnoreOutcome(ctx, resolved2.target);
     }
   });
 }
+async function gitIgnoreOutcome(ctx, target) {
+  const name = relative3(ctx.root, target);
+  switch (await ensureGitIgnored(ctx.root, target)) {
+    case "added":
+      return ` Added "${name}" to .gitignore so the credentials are not stageable.`;
+    case "tracked":
+      return ` Warning: ${name} is already tracked by git, and a .gitignore rule cannot un-stage it. Tell the user with notifyUser to run "git rm --cached ${name}" before committing.`;
+    case "unknown":
+      return ` Warning: could not confirm ${name} is gitignored. Tell the user with notifyUser to check before committing.`;
+    case "covered":
+      return "";
+  }
+}
 
 // src/lib/tools/searchFiles.ts
 import { tool as tool7 } from "ai";
 import z14 from "zod";
-import { readdir as readdir2, readFile as readFile6 } from "node:fs/promises";
-import { join as join8 } from "node:path";
+import { readdir as readdir2, readFile as readFile7 } from "node:fs/promises";
+import { join as join9 } from "node:path";
 var MAX_QUERY_LENGTH = 1e3;
 var SKIP_DIRS = /* @__PURE__ */ new Set([
   "node_modules",
@@ -2834,7 +2922,7 @@ async function walkFiles(dir) {
   const out = [];
   for (const e of await readdir2(dir, { withFileTypes: true })) {
     if (e.name.startsWith(".") || SKIP_DIRS.has(e.name)) continue;
-    const full = join8(dir, e.name);
+    const full = join9(dir, e.name);
     if (e.isDirectory()) out.push(...await walkFiles(full));
     else if (e.isFile()) out.push(full);
   }
@@ -2867,7 +2955,7 @@ function searchFilesTool(ctx) {
       for (const file of await walkFiles(resolved2.target)) {
         let content;
         try {
-          content = await readFile6(file, "utf8");
+          content = await readFile7(file, "utf8");
         } catch {
           continue;
         }
@@ -2890,7 +2978,7 @@ function searchFilesTool(ctx) {
 // src/lib/tools/runShell.ts
 import { tool as tool8 } from "ai";
 import z15 from "zod";
-import { relative as relative2 } from "node:path";
+import { relative as relative4 } from "node:path";
 
 // src/lib/tools/utils/runShell.ts
 import { spawn as spawn2 } from "node:child_process";
@@ -2987,7 +3075,7 @@ function runShell(command, opts) {
 // src/lib/tools/runShell.ts
 function storeApproval(root) {
   return async (req) => {
-    const rel = relative2(root, req.cwd);
+    const rel = relative4(root, req.cwd);
     const answer = await useWizard.getState().requestUserInput({
       prompt: "Run this command?",
       promptType: "commandApproval",
@@ -3081,7 +3169,7 @@ function runShellTool(ctx) {
 import { tool as tool9, generateText, Output, NoObjectGeneratedError } from "ai";
 import { createAnthropic } from "@ai-sdk/anthropic";
 import { nanoid as nanoid2 } from "nanoid";
-import { mkdir as mkdir5, writeFile as writeFile5 } from "node:fs/promises";
+import { mkdir as mkdir5, writeFile as writeFile6 } from "node:fs/promises";
 import { dirname as dirname6 } from "node:path";
 import z16 from "zod";
 var DATA_DIR = ".algolia-wizard/data";
@@ -3158,7 +3246,7 @@ function generateRecordTool(ctx) {
           return `Refused: ${resolved2.target} is outside the repo root (${ctx.root}).`;
         }
         await mkdir5(dirname6(resolved2.target), { recursive: true });
-        await writeFile5(resolved2.target, JSON.stringify(records, null, 2), "utf8");
+        await writeFile6(resolved2.target, JSON.stringify(records, null, 2), "utf8");
         logger.info({ entityName, count: records.length, relPath }, "generateRecord wrote records to disk");
         return {
           filePath: relPath,
@@ -3451,7 +3539,7 @@ async function runAnalysis(mode, extraInstructions = []) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.15.0",
+  version: "0.16.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -3857,17 +3945,18 @@ ${formatCompletedSteps(ctx.completedSteps)}`,
 
 // src/actions/implement.ts
 import z27 from "zod";
+import { join as join12 } from "node:path";
 
 // src/lib/worktree.ts
-import { execFile } from "node:child_process";
-import { copyFile, mkdir as mkdir6, readdir as readdir3, readFile as readFile7, stat as stat2, writeFile as writeFile6 } from "node:fs/promises";
-import { basename as basename2, dirname as dirname7, isAbsolute as isAbsolute2, join as join9, resolve as resolve3 } from "node:path";
+import { execFile as execFile2 } from "node:child_process";
+import { copyFile, mkdir as mkdir6, readdir as readdir3, readFile as readFile8, stat as stat2, writeFile as writeFile7 } from "node:fs/promises";
+import { basename as basename2, dirname as dirname7, isAbsolute as isAbsolute2, join as join10, resolve as resolve3 } from "node:path";
 var MAX_BUFFER = 32 * 1024 * 1024;
 var MAX_WIZARD_WORKTREES = 3;
 var WIZARD_BRANCH_PREFIX = "wizard/implement-";
 function git(args) {
   return new Promise((resolve4, reject) => {
-    execFile("git", args, { maxBuffer: MAX_BUFFER }, (err, stdout, stderr) => {
+    execFile2("git", args, { maxBuffer: MAX_BUFFER }, (err, stdout, stderr) => {
       if (err)
         return reject(
           new Error(
@@ -3892,7 +3981,7 @@ async function isWorkingTreeDirty(repoRoot) {
   return out.trim().length > 0;
 }
 async function pruneOldWorktrees(repoRoot) {
-  const dir = join9(stateDir(repoRoot), "worktrees");
+  const dir = join10(stateDir(repoRoot), "worktrees");
   const stale = (await readdir3(dir).catch(() => [])).filter((name) => /^wizard-implement-\d+$/.test(name)).sort().reverse().slice(MAX_WIZARD_WORKTREES - 1);
   for (const slug of stale) {
     const branch = slug.replace("wizard-implement-", WIZARD_BRANCH_PREFIX);
@@ -3903,7 +3992,7 @@ async function pruneOldWorktrees(repoRoot) {
         "worktree",
         "remove",
         "--force",
-        join9(dir, slug)
+        join10(dir, slug)
       ]);
       await git(["-C", repoRoot, "branch", "-D", branch]);
     } catch (err) {
@@ -3917,7 +4006,7 @@ async function pruneOldWorktrees(repoRoot) {
 async function createWorktree(repoRoot) {
   const branch = `${WIZARD_BRANCH_PREFIX}${Date.now()}`;
   const dirSlug = branch.replace(/\//g, "-");
-  const path = join9(stateDir(repoRoot), "worktrees", dirSlug);
+  const path = join10(stateDir(repoRoot), "worktrees", dirSlug);
   await git(["-C", repoRoot, "worktree", "prune"]);
   await pruneOldWorktrees(repoRoot);
   await mkdir6(dirname7(path), { recursive: true });
@@ -3937,8 +4026,8 @@ async function copyUploadIntoWorktree(repoRoot, worktreePath, ingestDir, sourceP
   } catch {
     return { ok: false, reason: `"${sourcePath}" does not exist` };
   }
-  const relPath = join9(ingestDir, basename2(source));
-  const dest = join9(worktreePath, relPath);
+  const relPath = join10(ingestDir, basename2(source));
+  const dest = join10(worktreePath, relPath);
   try {
     await mkdir6(dirname7(dest), { recursive: true });
     await copyFile(source, dest);
@@ -3956,7 +4045,7 @@ function hasEnvVar(content, name) {
 async function readEnvVar(worktreePath, name) {
   let content;
   try {
-    content = await readFile7(join9(worktreePath, ".env"), "utf8");
+    content = await readFile8(join10(worktreePath, ".env"), "utf8");
   } catch (err) {
     if (err.code !== "ENOENT") throw err;
     return void 0;
@@ -3971,10 +4060,10 @@ async function readEnvVar(worktreePath, name) {
   return value;
 }
 async function writeSearchEnvValues(worktreePath, vars) {
-  const target = join9(worktreePath, ".env");
+  const target = join10(worktreePath, ".env");
   let existing = "";
   try {
-    existing = await readFile7(target, "utf8");
+    existing = await readFile8(target, "utf8");
   } catch (err) {
     if (err.code !== "ENOENT") throw err;
   }
@@ -3983,7 +4072,7 @@ async function writeSearchEnvValues(worktreePath, vars) {
   const prefix = existing.length > 0 && !existing.endsWith("\n") ? "\n" : "";
   const lines = missing.map(({ name, value }) => `${name}=${value}
 `).join("");
-  await writeFile6(target, existing + prefix + lines, "utf8");
+  await writeFile7(target, existing + prefix + lines, "utf8");
   return missing.map((v) => v.name);
 }
 async function listChangedFiles(worktreePath) {
@@ -4044,13 +4133,13 @@ async function confirmDirtyWorkingTree(ctx, repoRoot) {
 
 // src/lib/algoliaDocs.ts
 import { readFileSync, readdirSync, existsSync } from "node:fs";
-import { dirname as dirname8, join as join10 } from "node:path";
+import { dirname as dirname8, join as join11 } from "node:path";
 import { fileURLToPath as fileURLToPath2 } from "node:url";
-var DOCS_SUBPATH = join10("docs", "algolia-sdk");
+var DOCS_SUBPATH = join11("docs", "algolia-sdk");
 function findDocsDir() {
   let dir = dirname8(fileURLToPath2(import.meta.url));
   for (; ; ) {
-    const candidate = join10(dir, DOCS_SUBPATH);
+    const candidate = join11(dir, DOCS_SUBPATH);
     if (existsSync(candidate)) return candidate;
     const parent = dirname8(dir);
     if (parent === dir) return void 0;
@@ -4073,7 +4162,7 @@ function loadAlgoliaDoc(language) {
     );
     return "";
   }
-  return readFileSync(join10(docsDir, files[0]), "utf8").trim();
+  return readFileSync(join11(docsDir, files[0]), "utf8").trim();
 }
 function getNamedDoc(name, language) {
   const docsDir = findDocsDir();
@@ -4081,7 +4170,7 @@ function getNamedDoc(name, language) {
     logger.warn("docs/algolia-sdk not found");
     return "";
   }
-  const file = join10(docsDir, `${name}-${language}.md`);
+  const file = join11(docsDir, `${name}-${language}.md`);
   if (!existsSync(file)) {
     logger.warn({ name, language }, "named SDK reference not found");
     return "";
@@ -4728,6 +4817,14 @@ ${detail}` : ""}`
         if (written.length > 0) {
           summaries.push(`Wrote ${written.join(", ")} to .env.`);
         }
+        const ignored = await ensureGitIgnored(worktree, join12(worktree, ".env"));
+        if (ignored === "added") {
+          summaries.push("Added .env to .gitignore.");
+        } else if (ignored === "tracked") {
+          summaries.push(
+            '\u26A0\uFE0F .env is tracked by git, so a .gitignore rule cannot un-stage it. Run "git rm --cached .env" before committing, or the credentials go into history.'
+          );
+        }
         const stale = [];
         for (const v of resolvedSearchEnvVars) {
           if (written.includes(v.name)) continue;
@@ -5100,7 +5197,7 @@ function parseCliArgs(argv) {
 
 // src/lib/resetState.ts
 import { readdir as readdir4, rm as rm2 } from "node:fs/promises";
-import { join as join11 } from "node:path";
+import { join as join13 } from "node:path";
 var KEEP = ["wizard.log"];
 async function resetProjectState() {
   const dir = stateDir();
@@ -5114,7 +5211,7 @@ async function resetProjectState() {
   const targets = entries.filter((name) => !KEEP.includes(name));
   await Promise.all(
     targets.map(
-      (name) => rm2(join11(dir, name), { recursive: true, force: true })
+      (name) => rm2(join13(dir, name), { recursive: true, force: true })
     )
   );
   return { dir, removed: targets };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/wizard",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Magically implement Algolia functionality in your codebase",
   "type": "module",
   "engines": {