gitxplain 0.1.8 → 0.1.9

package/cli/services/outputFormatter.js

@@ -1,34 +1,4 @@
-import process from "node:process";
-
-const ANSI = {
-  reset: "\u001b[0m",
-  bold: "\u001b[1m",
-  cyan: "\u001b[36m",
-  yellow: "\u001b[33m",
-  green: "\u001b[32m",
-  red: "\u001b[31m",
-  gray: "\u001b[90m"
-};
-
-function supportsColor() {
-  if (process.env.FORCE_COLOR != null && process.env.FORCE_COLOR !== "0") {
-    return true;
-  }
-
-  if (process.env.NO_COLOR != null) {
-    return false;
-  }
-
-  return Boolean(process.stdout?.isTTY);
-}
-
-function colorize(text, color) {
-  if (!supportsColor()) {
-    return text;
-  }
-
-  return `${color}${text}${ANSI.reset}`;
-}
+import { ANSI, colorize } from "./colorSupport.js";
 
 function stripInlineMarkdown(text) {
   return text
@@ -84,61 +54,37 @@ function normalizeMarkdownLine(line, state) {
 }
 
 function formatTargetLabel(commitData) {
-  return commitData.analysisType === "range" ? "Range" : "Commit";
-}
-
-function normalizeHeading(line) {
-  const match = line.match(/^([0-9]+\.)?\s*(Summary|Issues? Fixed|Issue|Root Cause|Fix(?: Explanation)?|Impact|Risk Level|Severity|Technical Breakdown|Full Analysis|Line-by-Line Code Walkthrough|Code Review|Security Review|Security Findings|Review Findings|Suggestions|Recommended Mitigations)\s*:?\s*$/i);
-
-  if (!match) {
-    return null;
+  if (commitData.analysisType === "range") {
+    return "Range";
   }
 
-  return `${match[2]}:`;
-}
-
-function isFileHeading(line) {
-  return /^(?:File|Path)\s*:/i.test(line) || /^[A-Za-z0-9_./-]+\.[A-Za-z0-9]+:\s*$/.test(line);
-}
-
-function classifyTone(line) {
-  if (/^\s*low(?:\b|[.:])/i.test(line)) {
-    return "good";
+  if (commitData.analysisType === "blame") {
+    return "File";
   }
 
-  if (/^\s*medium(?:\b|[.:])/i.test(line)) {
-    return "neutral";
+  if (commitData.analysisType === "stash") {
+    return "Stash";
   }
 
-  if (/^\s*high(?:\b|[.:])/i.test(line)) {
-    return "bad";
+  if (commitData.analysisType === "conflict") {
+    return "Conflict";
   }
 
-  if (
-    /\b(no significant findings|no security findings|none apparent|looks good|safe|improved|improvement|fixed|resolved|successful|passes?|low risk|low severity)\b/i.test(
-      line
-    )
-  ) {
-    return "good";
-  }
+  return "Commit";
+}
 
-  if (
-    /\b(issue|issues|bug|broken|failure|failing|risk|risky|severity|vulnerability|insecure|regression|warning|problem|bad|missing|error|high risk|high severity)\b/i.test(
-      line
-    )
-  ) {
-    return "bad";
-  }
+function normalizeHeading(line) {
+  const match = line.match(/^([0-9]+\.)?\s*(Summary|Issues? Fixed|Issue|Root Cause|Fix(?: Explanation)?|Impact|Risk Level|Severity|Technical Breakdown|Full Analysis|Line-by-Line Code Walkthrough|Code Review|Security Review|Security Findings|Review Findings|Suggestions|Recommended Mitigations)\s*:?\s*$/i);
 
-  if (/\b(suggestion|consider|follow-up|todo|medium risk|medium severity)\b/i.test(line)) {
-    return "neutral";
+  if (!match) {
+    return null;
   }
 
-  return null;
+  return `${match[2]}:`;
 }
 
-function colorizeByTone(line, tone) {
-  return line;
+function isFileHeading(line) {
+  return /^(?:File|Path)\s*:/i.test(line) || /^[A-Za-z0-9_./-]+\.[A-Za-z0-9]+:\s*$/.test(line);
 }
 
 function formatBulletLine(line) {
@@ -189,7 +135,7 @@ function formatLine(line) {
     return severityLine;
   }
 
-  return colorizeByTone(line, classifyTone(line));
+  return line;
 }
 
 function formatExplanation(explanation) {
@@ -266,6 +212,10 @@ export function formatFooter({ responseMeta, promptMeta, options }) {
     lines.push(`Usage: ${JSON.stringify(responseMeta.usage)}`);
   }
 
+  if (responseMeta.estimatedCostUsd != null) {
+    lines.push(`Estimated Cost: $${responseMeta.estimatedCostUsd.toFixed(6)}`);
+  }
+
   if (promptMeta?.warnings?.length) {
     lines.push(...promptMeta.warnings);
   }

package/cli/services/pipelineService.js

@@ -414,6 +414,24 @@ export function inspectRepositoryForPipeline(cwd) {
       label: "GitHub Actions CI verification",
       description: "Runs install, lint, test, build, and package checks when supported.",
       files: [".github/workflows/ci.yml"]
+    },
+    {
+      id: "gitlab-ci",
+      label: "GitLab CI verification",
+      description: "Creates a .gitlab-ci.yml pipeline with install, lint, test, and build stages.",
+      files: [".gitlab-ci.yml"]
+    },
+    {
+      id: "circleci",
+      label: "CircleCI verification",
+      description: "Creates a .circleci/config.yml pipeline for verification jobs.",
+      files: [".circleci/config.yml"]
+    },
+    {
+      id: "bitbucket-pipelines",
+      label: "Bitbucket Pipelines verification",
+      description: "Creates bitbucket-pipelines.yml with install, test, and build steps.",
+      files: ["bitbucket-pipelines.yml"]
     }
   ];
 
@@ -676,6 +694,87 @@ export function buildContainerWorkflow() {
   ].join("\n").concat("\n");
 }
 
+function buildPipelineCommands(context) {
+  return [context.commands.install, context.commands.lint, context.commands.test, context.commands.build, context.commands.pack]
+    .filter(Boolean);
+}
+
+export function buildGitLabCiWorkflow(context) {
+  const commands = buildPipelineCommands(context);
+  const image =
+    context.type === "python"
+      ? "python:3.12"
+      : context.type === "go"
+        ? "golang:1.22"
+        : context.type === "rust"
+          ? "rust:latest"
+          : "node:20";
+
+  return [
+    `image: ${image}`,
+    "",
+    "stages:",
+    "  - verify",
+    "",
+    "verify:",
+    "  stage: verify",
+    "  script:",
+    ...commands.map((command) => `    - ${command}`)
+  ].join("\n").concat("\n");
+}
+
+export function buildCircleCiWorkflow(context) {
+  const image =
+    context.type === "python"
+      ? "cimg/python:3.12"
+      : context.type === "go"
+        ? "cimg/go:1.22"
+        : context.type === "rust"
+          ? "cimg/rust:1.83"
+          : "cimg/node:20.10";
+  const commands = buildPipelineCommands(context);
+
+  return [
+    "version: 2.1",
+    "",
+    "jobs:",
+    "  verify:",
+    "    docker:",
+    `      - image: ${image}`,
+    "    steps:",
+    "      - checkout",
+    ...commands.map((command) => `      - run: ${command}`),
+    "",
+    "workflows:",
+    "  verify:",
+    "    jobs:",
+    "      - verify"
+  ].join("\n").concat("\n");
+}
+
+export function buildBitbucketPipelinesWorkflow(context) {
+  const image =
+    context.type === "python"
+      ? "python:3.12"
+      : context.type === "go"
+        ? "golang:1.22"
+        : context.type === "rust"
+          ? "rust:latest"
+          : "node:20";
+  const commands = buildPipelineCommands(context);
+
+  return [
+    `image: ${image}`,
+    "",
+    "pipelines:",
+    "  default:",
+    "    - step:",
+    "        name: Verify",
+    "        script:",
+    ...commands.map((command) => `          - ${command}`)
+  ].join("\n").concat("\n");
+}
+
 export function writePipelineFiles(cwd, analysis, selection) {
   if (!analysis.supported) {
     throw new Error(analysis.reason);
@@ -689,6 +788,7 @@ export function writePipelineFiles(cwd, analysis, selection) {
 
   const writeWorkflow = (relativePath, contents) => {
     const absolutePath = path.join(cwd, relativePath);
+    mkdirSync(path.dirname(absolutePath), { recursive: true });
     writeFileSync(absolutePath, contents, "utf8");
     writtenFiles.push(relativePath);
   };
@@ -713,6 +813,18 @@ export function writePipelineFiles(cwd, analysis, selection) {
     writeWorkflow(".github/workflows/container.yml", buildContainerWorkflow());
   }
 
+  if (selection.id === "gitlab-ci") {
+    writeWorkflow(".gitlab-ci.yml", buildGitLabCiWorkflow(analysis.primary));
+  }
+
+  if (selection.id === "circleci") {
+    writeWorkflow(".circleci/config.yml", buildCircleCiWorkflow(analysis.primary));
+  }
+
+  if (selection.id === "bitbucket-pipelines") {
+    writeWorkflow("bitbucket-pipelines.yml", buildBitbucketPipelinesWorkflow(analysis.primary));
+  }
+
   if (selection.id === "container" && !selection.files.includes(".github/workflows/ci.yml")) {
     notes.push("This option only creates the container workflow. Run `gitxplain --pipeline` again if you also want CI verification.");
   }

package/cli/services/promptService.js

@@ -16,7 +16,14 @@ const PROMPT_FILES = {
   review: "review.txt",
   security: "security.txt",
   split: "split.txt",
-  commit: "commit.txt"
+  commit: "commit.txt",
+  changelog: "changelog.txt",
+  refactor: "refactor.txt",
+  "test-suggest": "test-suggest.txt",
+  "pr-description": "pr-description.txt",
+  blame: "blame.txt",
+  stash: "stash.txt",
+  conflict: "conflict.txt"
 };
 
 function fillTemplate(template, values) {

package/cli/services/splitService.js

@@ -1,4 +1,3 @@
-import process from "node:process";
 import {
   createCommitFromTree,
   deletePaths,
@@ -32,26 +31,7 @@ import {
   runGitCommandUnchecked,
   resolveCommitSha
 } from "./gitService.js";
-
-const ANSI = {
-  reset: "\u001b[0m",
-  bold: "\u001b[1m",
-  cyan: "\u001b[36m",
-  yellow: "\u001b[33m",
-  green: "\u001b[32m"
-};
-
-function supportsColor() {
-  return Boolean(process.stdout?.isTTY) && process.env.NO_COLOR == null;
-}
-
-function colorize(text, color) {
-  if (!supportsColor()) {
-    return text;
-  }
-
-  return `${color}${text}${ANSI.reset}`;
-}
+import { ANSI, colorize } from "./colorSupport.js";
 
 function extractJsonPayload(explanation) {
   const fencedMatch = explanation.match(/```(?:json)?\s*([\s\S]*?)\s*```/i);

package/cli/services/usageService.js

@@ -0,0 +1,158 @@
+import { appendFileSync, existsSync, mkdirSync, readFileSync, rmSync } from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+function getUsageLogPath() {
+  return path.join(os.homedir(), ".gitxplain", "usage.jsonl");
+}
+
+export function getUsageLogFile() {
+  return getUsageLogPath();
+}
+
+function readRecords() {
+  const filePath = getUsageLogPath();
+  if (!existsSync(filePath)) {
+    return [];
+  }
+
+  return readFileSync(filePath, "utf8")
+    .split("\n")
+    .map((line) => line.trim())
+    .filter(Boolean)
+    .map((line) => JSON.parse(line));
+}
+
+function parseNumeric(value) {
+  return typeof value === "number" && Number.isFinite(value) ? value : 0;
+}
+
+export function normalizeUsageMetrics(usage) {
+  if (!usage || typeof usage !== "object") {
+    return {
+      inputTokens: 0,
+      outputTokens: 0,
+      totalTokens: 0
+    };
+  }
+
+  const inputTokens =
+    parseNumeric(usage.prompt_tokens) ||
+    parseNumeric(usage.input_tokens) ||
+    parseNumeric(usage.promptTokenCount);
+  const outputTokens =
+    parseNumeric(usage.completion_tokens) ||
+    parseNumeric(usage.output_tokens) ||
+    parseNumeric(usage.candidatesTokenCount);
+  const totalTokens =
+    parseNumeric(usage.total_tokens) ||
+    parseNumeric(usage.totalTokenCount) ||
+    inputTokens + outputTokens;
+
+  return {
+    inputTokens,
+    outputTokens,
+    totalTokens
+  };
+}
+
+function parseEnvPrice(envKey) {
+  const raw = process.env[envKey];
+  if (raw == null || raw === "") {
+    return null;
+  }
+
+  const parsed = Number.parseFloat(raw);
+  return Number.isFinite(parsed) && parsed >= 0 ? parsed : null;
+}
+
+export function resolvePricing(config) {
+  const providerKey = config.provider.toUpperCase().replace(/[^A-Z0-9]+/g, "_");
+  const modelKey = String(config.model ?? "default").toUpperCase().replace(/[^A-Z0-9]+/g, "_");
+
+  const inputPerMillion =
+    parseEnvPrice(`${providerKey}_${modelKey}_INPUT_COST_PER_MTOK`) ??
+    parseEnvPrice(`${providerKey}_INPUT_COST_PER_MTOK`) ??
+    parseEnvPrice("LLM_INPUT_COST_PER_MTOK");
+  const outputPerMillion =
+    parseEnvPrice(`${providerKey}_${modelKey}_OUTPUT_COST_PER_MTOK`) ??
+    parseEnvPrice(`${providerKey}_OUTPUT_COST_PER_MTOK`) ??
+    parseEnvPrice("LLM_OUTPUT_COST_PER_MTOK");
+
+  if (inputPerMillion == null || outputPerMillion == null) {
+    return null;
+  }
+
+  return {
+    inputPerMillion,
+    outputPerMillion
+  };
+}
+
+export function estimateCostUsd(usage, pricing) {
+  if (!pricing) {
+    return null;
+  }
+
+  const metrics = normalizeUsageMetrics(usage);
+  const costUsd =
+    (metrics.inputTokens / 1_000_000) * pricing.inputPerMillion +
+    (metrics.outputTokens / 1_000_000) * pricing.outputPerMillion;
+
+  return Number.isFinite(costUsd) ? costUsd : null;
+}
+
+export function appendUsageRecord({ provider, model, usage, latencyMs, estimatedCostUsd }) {
+  const metrics = normalizeUsageMetrics(usage);
+  if (metrics.totalTokens === 0 && estimatedCostUsd == null) {
+    return;
+  }
+
+  const filePath = getUsageLogPath();
+  mkdirSync(path.dirname(filePath), { recursive: true });
+  appendFileSync(
+    filePath,
+    `${JSON.stringify({
+      timestamp: new Date().toISOString(),
+      provider,
+      model,
+      usage: metrics,
+      latencyMs: latencyMs ?? null,
+      estimatedCostUsd
+    })}\n`,
+    "utf8"
+  );
+}
+
+export function getUsageStats() {
+  const records = readRecords();
+
+  return records.reduce(
+    (summary, record) => {
+      summary.requestCount += 1;
+      summary.inputTokens += parseNumeric(record.usage?.inputTokens);
+      summary.outputTokens += parseNumeric(record.usage?.outputTokens);
+      summary.totalTokens += parseNumeric(record.usage?.totalTokens);
+      summary.estimatedCostUsd += parseNumeric(record.estimatedCostUsd);
+      return summary;
+    },
+    {
+      requestCount: 0,
+      inputTokens: 0,
+      outputTokens: 0,
+      totalTokens: 0,
+      estimatedCostUsd: 0
+    }
+  );
+}
+
+export function clearUsageLog() {
+  const filePath = getUsageLogPath();
+  const count = readRecords().length;
+
+  if (existsSync(filePath)) {
+    rmSync(filePath, { force: true });
+  }
+
+  return count;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitxplain",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "AI-powered Git commit explainer CLI",
   "type": "module",
   "bin": {
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "start": "node ./cli/index.js",
-    "lint": "node --check ./cli/index.js && node --check ./cli/services/chatService.js && node --check ./cli/services/gitConnectionService.js && node --check ./cli/services/envLoader.js && node --check ./cli/services/pipelineService.js",
+    "lint": "node --check ./cli/index.js && node --check ./cli/services/envLoader.js && node --check ./cli/services/pipelineService.js",
     "test": "node --test"
   },
   "keywords": [

package/prompts/blame.txt

@@ -0,0 +1,29 @@
+Analyze this git blame report for a file and explain ownership patterns.
+
+Context:
+- The input below is not a diff. It is a compact blame summary built from `git blame --line-porcelain`.
+- Focus on who changed which parts of the file, when the major edits happened, and what kinds of changes appear to have shaped the file.
+- Call out concentrated ownership, legacy areas, and spots that may need extra care during onboarding or refactoring.
+
+Commit Message:
+{{commit_message}}
+
+Files Changed:
+{{files_changed}}
+
+Stats:
+{{stats}}
+
+Blame Report:
+{{diff}}
+
+Return:
+
+1. Ownership Summary:
+- Summarize the main authors or time periods that shaped the file
+
+2. Likely Change Themes:
+- Explain what kinds of changes the major contributors appear to have made
+
+3. Onboarding Notes:
+- Suggest where a new maintainer should read carefully, who to ask first, or what parts look risky or stable

package/prompts/changelog.txt

@@ -0,0 +1,36 @@
+Generate release notes in a conventional-changelog style.
+
+Context:
+- This may represent a single commit or a range of commits.
+- Prefer grouping entries under headings like Features, Fixes, Refactors, Docs, Tests, Chores, and Breaking Changes when supported by the evidence.
+- Use commit messages first, then use the diff to sharpen unclear items.
+- Be conservative and do not invent user-facing changes that are not visible in the Git data.
+
+Commit Message:
+{{commit_message}}
+
+Files Changed:
+{{files_changed}}
+
+Stats:
+{{stats}}
+
+Change Hints:
+{{change_hints}}
+
+Diff:
+{{diff}}
+
+Return:
+
+1. Release Summary:
+- One short paragraph describing the overall release/change set
+
+2. Changelog:
+- Group entries under relevant categories
+- Keep bullets concise and user-facing
+- If there are no clear entries for a category, omit it
+
+3. Upgrade Notes:
+- Mention any migration steps, rollout cautions, or compatibility risks
+- If none are apparent, say so clearly

package/prompts/conflict.txt

@@ -0,0 +1,33 @@
+You are helping resolve unresolved Git merge conflicts.
+
+Context:
+- The input below is a structured report extracted from conflict markers in the working tree.
+- Explain what each side appears to be doing, suggest the most likely safe resolution, and call out any ambiguity that requires human review.
+- Be conservative. Do not pretend a single resolution is certain when the intent is unclear.
+
+Conflict Summary:
+{{commit_message}}
+
+Files Changed:
+{{files_changed}}
+
+Stats:
+{{stats}}
+
+Conflict Report:
+{{diff}}
+
+Return:
+
+1. Conflict Summary:
+- Explain the overall source of the conflict
+
+2. Suggested Resolution:
+- For each file or conflict block, describe the most likely resolution
+- Be explicit about which lines to keep, merge, or rewrite
+
+3. Why:
+- Explain why the suggested resolution is the safest or most consistent
+
+4. Follow-Up Checks:
+- Suggest tests, manual verification steps, or edge cases to validate after resolving the conflict

package/prompts/pr-description.txt

@@ -0,0 +1,40 @@
+Write a pull request description for this change set.
+
+Context:
+- This may be a single commit, a commit range, or a branch comparison.
+- The result should be ready to paste into GitHub or GitLab.
+- Be accurate and concise. Do not invent testing or screenshots that are not evidenced by the diff.
+
+Commit Message:
+{{commit_message}}
+
+Files Changed:
+{{files_changed}}
+
+Stats:
+{{stats}}
+
+Change Hints:
+{{change_hints}}
+
+Diff:
+{{diff}}
+
+Return:
+
+## Summary
+- Short bullets describing the main changes
+
+## Why
+- Why this PR exists
+
+## Testing
+- Mention visible testing evidence from the diff if any
+- If no testing evidence is visible, say "Not specified in diff"
+
+## Risks
+- Briefly describe rollout, compatibility, or review risks
+
+## Screenshots
+- If the diff suggests UI work, include "Screenshots: Needed"
+- Otherwise include "Screenshots: Not needed"

package/prompts/refactor.txt

@@ -0,0 +1,29 @@
+Review this change for refactoring opportunities.
+
+Commit Message:
+{{commit_message}}
+
+Files Changed:
+{{files_changed}}
+
+Stats:
+{{stats}}
+
+Change Hints:
+{{change_hints}}
+
+Diff:
+{{diff}}
+
+Return:
+
+1. Refactor Opportunities:
+- List concrete refactors suggested by the code shown
+- Focus on duplication, naming, cohesion, dead code, control flow, error handling, and API clarity
+- If there are no worthwhile refactors, say so explicitly
+
+2. Why These Matter:
+- Explain the maintenance or correctness benefits of the top opportunities
+
+3. Safe Next Steps:
+- Suggest a small, practical follow-up plan that avoids mixing refactors with risky behavior changes