@verndale/ai-commit 2.4.1 → 2.4.2

package/.env-example

@@ -9,21 +9,30 @@ OPENAI_API_KEY=
 # Optional — default is gpt-4o-mini
 # COMMIT_AI_MODEL=
 
+
+# ------------------------------------------------------------
+# @verndale/ai-pr (pnpm open-pr) — GitHub PR create/update
+# ------------------------------------------------------------
 # @verndale/ai-pr — GH_TOKEN: Set for local CLI runs; CI uses workflow env / secrets. Also reads GITHUB_TOKEN.
-GH_TOKEN=
+#GH_TOKEN=
 
 # Optional — PR behavior
 # @verndale/ai-pr — PR_BASE_BRANCH: Base branch to merge into (default main).
 # PR_BASE_BRANCH=main
+
 # @verndale/ai-pr — PR_DRAFT: If true (default), new PRs are drafts.
 # PR_DRAFT=true
 
 # Optional — AI summary + labels (when PR_AI=true)
 # @verndale/ai-pr — PR_AI: Set true to enable AI summary and optional labels/checklist.
 # PR_AI=true
+
 # @verndale/ai-pr — PR_AI_ENDPOINT: AI API URL when PR_AI is true (e.g. OpenAI Responses endpoint).
 # PR_AI_ENDPOINT=https://api.openai.com/v1/responses
+
 # @verndale/ai-pr — PR_AI_API_KEY: Bearer token for the AI API when PR_AI is true.
 # PR_AI_API_KEY=
+
 # @verndale/ai-pr — PR_AI_MODEL: Model id (default string default).
 # PR_AI_MODEL=default
+

package/lib/init-env.js

@@ -5,9 +5,11 @@ const fs = require("fs");
 /** Detect our doc line so we do not duplicate or replace other packages’ comments. */
 const MARKER_PREFIX = "# @verndale/ai-commit — ";
 
-const SECTION_DIVIDER = "# ------------------------------------------------------------";
-const SECTION_TITLE = "# @verndale/ai-commit (pnpm commit / ai-commit run)";
-const SECTION_HEADER = [SECTION_DIVIDER, SECTION_TITLE, SECTION_DIVIDER];
+const HEADER_LINES = [
+  "# ------------------------------------------------------------",
+  "# @verndale/ai-commit (pnpm commit / ai-commit run)",
+  "# ------------------------------------------------------------",
+];
 
 const SUBSECTION_OPTIONAL_MODEL = "# Optional — default is gpt-4o-mini";
 
@@ -20,10 +22,7 @@ const DOC_OPENAI = [
  * @returns {boolean}
  */
 function hasAiCommitSectionHeader(text) {
-  return (
-    text.includes(SECTION_DIVIDER) &&
-    text.includes("@verndale/ai-commit (pnpm commit / ai-commit run)")
-  );
+  return text.includes(HEADER_LINES[0]) && text.includes(HEADER_LINES[1]);
 }
 
 /**
@@ -82,6 +81,25 @@ function hasOurDocForKey(lines, key) {
   return lines.some((line) => line.includes(needle));
 }
 
+/**
+ * @param {string[]} lines mutable
+ * @param {RegExp} assignmentRegex
+ * @param {string[]} docLines
+ * @param {string} key
+ * @returns {boolean}
+ */
+function injectDocBeforeAssignment(lines, assignmentRegex, docLines, key) {
+  if (hasOurDocForKey(lines, key)) {
+    return false;
+  }
+  const idx = lines.findIndex((line) => assignmentRegex.test(line));
+  if (idx === -1) {
+    return false;
+  }
+  lines.splice(idx, 0, ...docLines);
+  return true;
+}
+
 /**
  * For keys already present (possibly with another package’s comments), add our doc line(s)
  * above the assignment if missing. Does not remove or edit existing comment lines.
@@ -93,12 +111,10 @@ function injectAiCommitDocsForExistingKeys(content) {
   let changed = false;
 
   if (!hasOurDocForKey(lines, "OPENAI_API_KEY")) {
-    const idx = lines.findIndex((line) => /^\s*OPENAI_API_KEY\s*=/.test(line));
-    if (idx !== -1) {
-      const insert = hasAiCommitSectionHeader(lines.join("\n"))
-        ? [DOC_OPENAI[0]]
-        : [...SECTION_HEADER, DOC_OPENAI[0]];
-      lines.splice(idx, 0, ...insert);
+    const docLines = hasAiCommitSectionHeader(lines.join("\n"))
+      ? [...DOC_OPENAI]
+      : [...HEADER_LINES, ...DOC_OPENAI];
+    if (injectDocBeforeAssignment(lines, /^\s*OPENAI_API_KEY\s*=/, docLines, "OPENAI_API_KEY")) {
       changed = true;
     }
   }
@@ -111,7 +127,7 @@ function injectAiCommitDocsForExistingKeys(content) {
     if (idx !== -1) {
       const insert = hasAiCommitSectionHeader(lines.join("\n"))
         ? [SUBSECTION_OPTIONAL_MODEL]
-        : [...SECTION_HEADER, "", SUBSECTION_OPTIONAL_MODEL];
+        : [...HEADER_LINES, "", SUBSECTION_OPTIONAL_MODEL];
       lines.splice(idx, 0, ...insert);
       changed = true;
     }
@@ -140,35 +156,30 @@ function buildAiCommitEnvAppend(existing) {
     return null;
   }
 
+  const parts = [];
+
   if (needOpenai && needCommit) {
-    return [
-      ...SECTION_HEADER,
-      DOC_OPENAI[0],
-      "OPENAI_API_KEY=",
-      "",
-      SUBSECTION_OPTIONAL_MODEL,
-      "# COMMIT_AI_MODEL=",
-      "",
-      "",
-    ].join("\n");
-  }
-
-  if (needOpenai) {
-    return [...SECTION_HEADER, DOC_OPENAI[0], "OPENAI_API_KEY=", ""].join("\n");
-  }
-
-  if (hasSection) {
-    return [SUBSECTION_OPTIONAL_MODEL, "# COMMIT_AI_MODEL=", "", ""].join("\n");
-  }
-
-  return [
-    ...SECTION_HEADER,
-    "",
-    SUBSECTION_OPTIONAL_MODEL,
-    "# COMMIT_AI_MODEL=",
-    "",
-    "",
-  ].join("\n");
+    parts.push(
+      `${HEADER_LINES.join("\n")}\n${DOC_OPENAI[0]}\nOPENAI_API_KEY=\n\n${SUBSECTION_OPTIONAL_MODEL}\n# COMMIT_AI_MODEL=\n\n\n`,
+    );
+  } else if (needOpenai) {
+    parts.push(
+      `${HEADER_LINES.join("\n")}\n${DOC_OPENAI[0]}\nOPENAI_API_KEY=\n\n`,
+    );
+  } else if (needCommit) {
+    if (hasSection) {
+      parts.push(`${SUBSECTION_OPTIONAL_MODEL}\n# COMMIT_AI_MODEL=\n\n\n`);
+    } else {
+      parts.push(
+        `${HEADER_LINES.join("\n")}\n\n${SUBSECTION_OPTIONAL_MODEL}\n# COMMIT_AI_MODEL=\n\n\n`,
+      );
+    }
+  }
+
+  if (parts.length === 0) {
+    return null;
+  }
+  return parts.join("");
 }
 
 /**
@@ -176,7 +187,7 @@ function buildAiCommitEnvAppend(existing) {
  * @param {string} destPath
  * @param {string} bundledPath
  * @param {{ force?: boolean }} [options]
- * @returns {{ kind: 'replaced' | 'wrote' | 'unchanged' }}
+ * @returns {{ kind: 'replaced' | 'wrote' | 'merged' | 'unchanged' }}
  */
 function mergeAiCommitEnvFile(destPath, bundledPath, options = {}) {
   const { force = false } = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verndale/ai-commit",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "AI-assisted conventional commits with bundled commitlint — one install, aligned rules",
   "license": "MIT",
   "author": "Verndale",
@@ -57,7 +57,7 @@
     "openai": "^6.33.0"
   },
   "devDependencies": {
-    "@verndale/ai-pr": "^1.1.0",
+    "@verndale/ai-pr": "^1.1.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",