git-er-done 0.1.20 → 0.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-er-done",
-  "version": "0.1.20",
+  "version": "0.1.23",
   "description": "Utility for dealing with modified, created, deleted files since a git commit",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -77,6 +77,7 @@
     "README.md"
   ],
   "dependencies": {
+    "@davidwells/git-split-diffs": "^2.2.5",
     "debug": "^4.1.1",
     "json5": "^2.1.1",
     "jsonpointer": "^5.0.1",
@@ -95,7 +96,6 @@
   },
   "devDependencies": {
     "@davidwells/extract-deps": "^0.0.6",
-    "@davidwells/git-split-diffs": "^2.2.1",
     "@types/node": "^22.10.1",
     "configorama": "^0.7.1",
     "minimatch": "^10.0.1",

package/src/git/getDiffFormatted.js

@@ -51,6 +51,12 @@ function getLongestLineLength(diff) {
   return maxLength
 }
 
+/**
+ * @typedef {Object} FormattedDiffResult
+ * @property {string} formatted - Terminal-formatted diff with colors
+ * @property {string} raw - Raw unified diff from git
+ */
+
 /**
  * Get formatted diff for a specific file
  * @param {Object} options - Options for getting formatted diff
@@ -62,7 +68,11 @@ function getLongestLineLength(diff) {
  * @param {number} [options.leftMargin=0] - Number of spaces to add to the left of each line
  * @param {number} [options.width=140] - Width of the diff output (ignored if shrinkToLongestLine is true)
  * @param {boolean} [options.hideHeader=false] - Remove the file path header from the diff
- * @returns {Promise<string | null>} Formatted diff string or null if no diff
+ * @param {boolean} [options.hideFileHeader=false] - Hide file header (passed to formatDiff)
+ * @param {boolean} [options.hideHeaderTopLine=false] - Hide header top line (passed to formatDiff)
+ * @param {boolean} [options.disableDefaultBackground=false] - Disable default background colors (passed to formatDiff)
+ * @param {boolean} [options.returnRaw=false] - Return both formatted and raw diff
+ * @returns {Promise<string | FormattedDiffResult | null>} Formatted diff string, or {formatted, raw} if returnRaw, or null if no diff
  */
 async function getFormattedDiff({
   filePath,
@@ -72,7 +82,11 @@ async function getFormattedDiff({
   shrinkToLongestLine = false,
   leftMargin = 0,
   width = 140,
-  hideHeader = false
+  hideHeader = false,
+  hideFileHeader = false,
+  hideHeaderTopLine = false,
+  disableDefaultBackground = false,
+  returnRaw = false
 }) {
   try {
     const { formatDiff } = await import('@davidwells/git-split-diffs')
@@ -107,10 +121,6 @@ async function getFormattedDiff({
 
     // Format the diff with git-split-diffs
     let formatted = await formatDiff(diff, {
-      // hyperlinkFileNames: false,
-      // hyperlinkLineNumbers: false,
-      // hideFileHeader: true,
-      // omitHunkHeaders: true,
       trimLastEmptyLine: true,
       width: maxWidth,
       minLineWidth: 80,
@@ -118,6 +128,9 @@ async function getFormattedDiff({
       highlightLineChanges: true,
       themeName: 'dark',
       gitRootDir,
+      hideFileHeader,
+      hideHeaderTopLine,
+      disableDefaultBackground,
     })
 
     // Remove header if hideHeader is true
@@ -130,9 +143,12 @@ async function getFormattedDiff({
     // Add left margin if specified
     if (leftMargin > 0) {
       const margin = ' '.repeat(leftMargin)
-      return formatted.split('\n').map(line => margin + line).join('\n')
+      formatted = formatted.split('\n').map(line => margin + line).join('\n')
     }
 
+    if (returnRaw) {
+      return { formatted, raw: diff }
+    }
     return formatted
   } catch (err) {
     console.error(`Error formatting diff for ${filePath}:`, err.message)

package/types/git/getDiffFormatted.d.ts

@@ -1,3 +1,18 @@
+export type FormattedDiffResult = {
+    /**
+     * - Terminal-formatted diff with colors
+     */
+    formatted: string;
+    /**
+     * - Raw unified diff from git
+     */
+    raw: string;
+};
+/**
+ * @typedef {Object} FormattedDiffResult
+ * @property {string} formatted - Terminal-formatted diff with colors
+ * @property {string} raw - Raw unified diff from git
+ */
 /**
  * Get formatted diff for a specific file
  * @param {Object} options - Options for getting formatted diff
@@ -9,9 +24,13 @@
  * @param {number} [options.leftMargin=0] - Number of spaces to add to the left of each line
  * @param {number} [options.width=140] - Width of the diff output (ignored if shrinkToLongestLine is true)
  * @param {boolean} [options.hideHeader=false] - Remove the file path header from the diff
- * @returns {Promise<string | null>} Formatted diff string or null if no diff
+ * @param {boolean} [options.hideFileHeader=false] - Hide file header (passed to formatDiff)
+ * @param {boolean} [options.hideHeaderTopLine=false] - Hide header top line (passed to formatDiff)
+ * @param {boolean} [options.disableDefaultBackground=false] - Disable default background colors (passed to formatDiff)
+ * @param {boolean} [options.returnRaw=false] - Return both formatted and raw diff
+ * @returns {Promise<string | FormattedDiffResult | null>} Formatted diff string, or {formatted, raw} if returnRaw, or null if no diff
  */
-export function getFormattedDiff({ filePath, gitRootDir, cwd, baseBranch, shrinkToLongestLine, leftMargin, width, hideHeader }: {
+export function getFormattedDiff({ filePath, gitRootDir, cwd, baseBranch, shrinkToLongestLine, leftMargin, width, hideHeader, hideFileHeader, hideHeaderTopLine, disableDefaultBackground, returnRaw }: {
     filePath: string;
     gitRootDir?: string;
     cwd?: string;
@@ -20,4 +39,8 @@ export function getFormattedDiff({ filePath, gitRootDir, cwd, baseBranch, shrink
     leftMargin?: number;
     width?: number;
     hideHeader?: boolean;
-}): Promise<string | null>;
+    hideFileHeader?: boolean;
+    hideHeaderTopLine?: boolean;
+    disableDefaultBackground?: boolean;
+    returnRaw?: boolean;
+}): Promise<string | FormattedDiffResult | null>;