smart-merge-cli 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# SmartMerge
+Your git cli's best friend.
+
+
+## About
+SmartMerge was made from the utter frustration of git merge errors. It is designed to help tracking down those pesky merge errors. It also has a `--json` flag that sends the output to machine readable output. And, it even comes with the `--no-color` flag for no reason at all.
+
+## Usage
+To use it, Well you will have to really fuck up your local git repository so much that rebase says `CONFLICT: ` or something. The SmartMerger can help you in this situation by telling you allmost all the info that git dosen't tell you. Because git is a tortuous and insuferable, No. I didn't say that. But anyway, SmartMerger allows you to see commits that are related to the file on your current branch, see an explaination for the curse git gave you and the repo status. Batterys included
+
+## Commands
+`
+smartmerge check .
+`
+This runs the checker in the local repo to find any conflicts and tell you the files they are in.
+
+`
+smartmerge status .
+`
+This command shows you the glorified git status.
+
+`
+smartmerge explain .
+`
+Tells you what is wrong and how to fix it
+
+`
+smartmerge history .
+`
+Shows you where it all went wrong.
+
+## Keynote
+
+Git created the problem.
+ SmartMerge helps explain it.
+
+Built by one f***ed off developer
+ For everyone who's ever stared at CONFLICT (content) and wondered what on earth Git was on about.

package/eslint.config.js

@@ -0,0 +1,20 @@
+import js from "@eslint/js";
+import globals from "globals";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+  {
+    files: ["**/*.js"],
+    languageOptions: {
+      sourceType: "module",
+    },
+  },
+]);

package/index.js

@@ -0,0 +1,72 @@
+import { Command } from "commander";
+import { checkConflicts } from "./src/commands/check.js";
+import { explainConflicts, renderExplain } from "./src/commands/explain.js";
+import { repoStatus, renderStatus } from "./src/commands/status.js";
+import { exportJson } from "./src/core/json.js";
+import { repoHistory, renderRepoHistory } from "./src/commands/history.js";
+
+const program = new Command();
+
+program
+  .name("SmartMerger")
+  .description("A tool to help with merging of git conflicts")
+  .version("1.0.0")
+  .option("--no-color", "Output with no color")
+  .option("--json", "Output in machine readable json format");
+
+program
+  .command("check")
+  .description("Check for git conflicts")
+  .argument("<path>", "Path to the git repository")
+  .action((path) => {
+    checkConflicts(path);
+  });
+
+program
+  .command("explain")
+  .description("Explain git conflicts")
+  .argument("<path>", "Path to the git repository")
+  .action((path) => {
+    const options = program.opts();
+    const data = explainConflicts(path);
+
+    if (options.json) {
+      exportJson(data);
+      return;
+    }
+
+    renderExplain(data);
+  });
+
+program
+  .command("status")
+  .description("Show current git repository status")
+  .argument("<path>", "Path to the git repository")
+  .action((path) => {
+    const options = program.opts();
+    const data = repoStatus(path);
+
+    if (options.json) {
+        exportJson(data);
+        return;
+    } 
+    renderStatus(data);
+  });
+
+program
+  .command("history")
+  .description("Show commit history for conflicting files")
+  .argument("<path>", "Path to the git repository")
+  .action((path) => {
+    const options = program.opts();
+    const data = repoHistory(path);
+
+    if (options.json) {
+        exportJson(data);
+        return;
+    }
+    renderRepoHistory(data);
+  })
+
+
+program.parse(process.argv);

package/package-support.json

@@ -0,0 +1,13 @@
+{
+    "versions": [
+        {
+            "version": "*",
+            "target": {
+                "node": "supported"
+            },
+            "response": {
+                "type": "time-permitting"
+            }
+        }
+    ]
+}

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "smart-merge-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "A tool that helps with git merge conflicts",
+  "keywords": [
+    "git",
+    "merge"
+  ],
+  "license": "MIT",
+  "author": "gtref",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"No Tests\"",
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "chalk": "^6.0.1",
+    "commander": "^15.0.0",
+    "glob": "^13.0.6"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.13.0",
+    "globals": "^17.13.0"
+  }
+}

package/src/commands/check.js

@@ -0,0 +1,20 @@
+import { getConflictFiles } from "../core/git-commands.js";
+import { info } from "../core/colors.js";
+
+export function checkConflicts(path) {
+  try {
+    const files = getConflictFiles(path);
+
+    if (files.length === 0) {
+      console.log(info("No merge conflicts found."));
+      return;
+    }
+
+    for (const file of files) {
+      console.log(file);
+    }
+  } catch (error) {
+    console.error(error.message);
+    process.exit(1);
+  }
+}

package/src/commands/explain.js

@@ -0,0 +1,125 @@
+import fs from "node:fs";
+import { getConflictFiles } from "../core/git-commands.js";
+import { info } from "../core/colors.js"
+
+export function explainConflicts(path = ".") {
+  const files = getConflictFiles(path);
+
+  const results = [];
+
+  for (const file of files) {
+    const contents = fs.readFileSync(
+      `${path}/${file}`,
+      "utf8",
+    );
+
+    const lines = contents.split("\n");
+
+    let ours = [];
+    let theirs = [];
+    let state = "normal";
+    let conflictNumber = 0;
+
+    const conflicts = [];
+
+    for (const line of lines) {
+      if (line.startsWith("<<<<<<<")) {
+        conflictNumber++;
+        ours = [];
+        theirs = [];
+        state = "ours";
+        continue;
+      }
+
+      if (line.startsWith("=======")) {
+        state = "theirs";
+        continue;
+      }
+
+      if (line.startsWith(">>>>>>>")) {
+        conflicts.push({
+          number: conflictNumber,
+          identical:
+            ours.join("\n") === theirs.join("\n"),
+          current: {
+            lineCount: ours.length,
+            content: ours,
+          },
+          incoming: {
+            lineCount: theirs.length,
+            content: theirs,
+          },
+        });
+
+        state = "normal";
+        continue;
+      }
+
+      if (state === "ours") {
+        ours.push(line);
+      }
+
+      if (state === "theirs") {
+        theirs.push(line);
+      }
+    }
+
+    results.push({
+      file,
+      conflicts,
+    });
+  }
+
+  return {
+    totalFiles: results.length,
+    files: results,
+  };
+}
+
+export function renderExplain(data) {
+  if (!data.files.length) {
+    console.log(info("No merge conflicts found."));
+    return;
+  }
+
+  for (const file of data.files) {
+    console.log(info(`\nFile ${file.file}`));
+
+    for (const conflict of file.conflicts) {
+      console.log(info(`\nConflict: #${conflict.number}`));
+      console.log(info("\nSummary:"));
+
+      if (conflict.identical) {
+        console.log(info("Both sides are identical"));
+      } else {
+        console.log(
+          info(
+            `- Current branch has ${conflict.current.lineCount} line(s).`,
+          ),
+        );
+
+        console.log(
+          info(
+            `- Incoming branch has ${conflict.incoming.lineCount} line(s).`,
+          ),
+        );
+
+        console.log(info("- The content differs."));
+      }
+
+      console.log("\nCurrent:");
+      console.log(
+        conflict.current.content
+          .map((line) => `  ${line}`)
+          .join("\n"),
+      );
+
+      console.log("\nIncoming:");
+      console.log(
+        conflict.incoming.content
+          .map((line) => `  ${line}`)
+          .join("\n"),
+      );
+    }
+  }
+}

package/src/commands/history.js

@@ -0,0 +1,43 @@
+import { getHistory, getConflictFiles } from "../core/git-commands.js";
+
+export function repoHistory(path) {
+    const files = getConflictFiles(path);
+
+    const data = [];
+
+    for (const file of files) {
+        const history = getHistory(file, path)
+            .split("\n")
+            .filter(Boolean)
+            .map((entry) => {
+                const [hash, date, message] = entry.split("|");
+
+                return {
+                    hash,
+                    date,
+                    message,
+                };
+            });
+
+        data.push({
+            file,
+            history,
+        });
+    }
+
+    return data;
+}
+
+export function renderRepoHistory(data) {
+    for (const item of data) {
+        console.log();
+        console.log(`Conflicting file: ${item.file}`);
+        console.log();
+
+        for (const commit of item.history) {
+            console.log(
+                `  ${commit.hash.slice(0, 7)} ${commit.date} ${commit.message}`,
+            );
+        }
+    }
+}

package/src/commands/status.js

@@ -0,0 +1,85 @@
+import { getStatus, getBranches } from "../core/git-commands.js";
+import { info } from "../core/colors.js";
+
+export function repoStatus(path = ".") {
+  const status = getStatus(path);
+  const branches = getBranches(path);
+
+  const files = status
+    .split("\n")
+    .filter(Boolean)
+    .map((line) => ({
+      index: line[0],
+      workingTree: line[1],
+      file: line.slice(3),
+    }));
+
+  const rBranches = branches
+    .split("\n")
+    .filter(Boolean)
+    .map((line) => ({
+        name: line.replace("*", " ").trim(),
+        current: line.startsWith("*"),
+    }));
+
+  return {
+    totalFiles: files.length,
+    files,
+    branches: rBranches
+  };
+}
+
+function getStatusText(index, workingTree) {
+  if (
+    index === "U" ||
+    workingTree === "U" ||
+    (index === "A" && workingTree === "A") ||
+    (index === "D" && workingTree === "D")
+  ) {
+    return "! CONFLICT";
+  }
+
+  if (index === "?" && workingTree === "?") {
+    return "Untracked";
+  }
+
+  if (index === "A") {
+    return "+ Added";
+  }
+
+  if (index === "M" || workingTree === "M") {
+    return "Modified";
+  }
+
+  if (index === "D" || workingTree === "D") {
+    return "- Deleted";
+  }
+
+  if (index === "R") {
+    return "Renamed";
+  }
+
+  return "Changed";
+}
+
+export function renderStatus(data) {
+  if (data.totalFiles === 0) {
+    console.log(info("Working tree clean."));
+    return;
+  }
+
+  console.log(info(`Found ${data.totalFiles} changed file(s):\n`));
+
+  for (const file of data.files) {
+    console.log(
+      `${getStatusText(file.index, file.workingTree)}: ${file.file}`,
+    );
+  }
+
+  console.log(info("\nBranches:"));
+  for (const branch of data.branches) {
+    console.log(
+        `${branch.current ? "*" : " "} ${branch.name}`
+    );
+  }
+}

package/src/core/colors.js

@@ -0,0 +1,7 @@
+import chalk from 'chalk';
+
+export const err = chalk.bold.red;
+export const warn = chalk.yellow;
+export const info = chalk.blue;
+export const success = chalk.green;
+export const debug = chalk.magenta;

package/src/core/git-commands.js

@@ -0,0 +1,51 @@
+import { execSync } from "node:child_process";
+import {err} from "./colors.js";
+
+function run(command, cwd = process.cwd()) {
+  try {
+    return execSync(command, {
+      cwd,
+      encoding: "utf8",
+      stdio: ["ignore", "pipe", "pipe"],
+    }).trim();
+  } catch (error) {
+    const message = error.stderr?.toString().trim();
+
+    if (message.includes("Not a git repository")) {
+      console.log(err("Not a Git repository."));
+      process.exit(1);
+    }
+
+    console.log(err(message || error.message));
+    process.exit(1);
+  }
+}
+
+export function getConflictFiles(path = process.cwd()) {
+  return run(
+    "git diff --name-only --diff-filter=U",
+    path,
+  )
+    .split("\n")
+    .map((file) => file.trim())
+    .filter(Boolean);
+}
+
+export function getDiffCheck(path = process.cwd()) {
+  return run("git diff --check", path);
+}
+
+export function getStatus(path = process.cwd()) {
+  return run("git status --short", path);
+}
+
+export function getBranches(path = process.cwd()) {
+  return run("git branch --list", path);
+}
+
+export function getHistory(file, path = process.cwd()) {
+  return run(
+    `git log --format="%H|%ad|%s" --date=short -- "${file}"`,
+    path,
+  );
+}

package/src/core/json.js

@@ -0,0 +1,17 @@
+import chalk from "chalk";
+
+export function exportJson(data) {
+  if (data === undefined) {
+    console.error(
+      chalk.red("Error: Command did not return any data to export."),
+    );
+    process.exitCode = 1;
+    return;
+  }
+
+  console.log(
+    chalk.yellow(
+      JSON.stringify(data, null, 2),
+    ),
+  );
+}