git-er-done 0.1.14 → 0.1.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-er-done",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "Utility for dealing with modified, created, deleted files since a git commit",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -33,6 +33,10 @@
       "types": "./types/git/getGitRoot.d.ts",
       "default": "./src/git/getGitRoot.js"
     },
+    "./get-current-branch": {
+      "types": "./types/git/getCurrentBranch.d.ts",
+      "default": "./src/git/getCurrentBranch.js"
+    },
     "./get-files": {
       "types": "./types/git/getGitFiles.d.ts",
       "default": "./src/git/getGitFiles.js"
@@ -75,7 +79,7 @@
   "dependencies": {
     "debug": "^4.1.1",
     "json5": "^2.1.1",
-    "jsonpointer": "^4.0.1",
+    "jsonpointer": "^5.0.1",
     "lodash.includes": "^4.3.0",
     "lodash.isobject": "^3.0.2",
     "lodash.keys": "^4.2.0",
@@ -83,17 +87,17 @@
     "lodash.memoize": "^4.1.2",
     "micromatch": "^4.0.2",
     "parse-diff": "^0.6.0",
-    "rfc6902": "^3.0.4"
+    "rfc6902": "^5.1.2"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/DavidWells/components/tree/master/packages/util-git-info"
   },
   "devDependencies": {
-    "@davidwells/extract-deps": "^0.0.5",
+    "@davidwells/extract-deps": "^0.0.6",
     "@davidwells/git-split-diffs": "^2.2.1",
     "@types/node": "^22.10.1",
-    "configorama": "^0.6.14",
+    "configorama": "^0.7.1",
     "minimatch": "^10.0.1",
     "typescript": "^5.7.2",
     "uvu": "^0.5.6"

package/src/git/getCurrentBranch.js

@@ -0,0 +1,25 @@
+// Gets the current git branch name
+const { executeCommand } = require('./utils/exec')
+
+/**
+ * Gets the current branch name of the git repository
+ * @returns {Promise<string>} A promise that resolves to the current branch name
+ */
+function getCurrentBranch() {
+  return new Promise((resolve, reject) => {
+    executeCommand('git rev-parse --abbrev-ref HEAD', (err, res) => {
+      if (err) return reject(err)
+      resolve(res.trim())
+    })
+  })
+}
+
+/*
+if (require.main === module) {
+  getCurrentBranch().then(res => {
+    console.log('getCurrentBranch', res)
+  })
+}
+/** */
+
+module.exports = { getCurrentBranch }

package/src/git/getCurrentBranch.test.js

@@ -0,0 +1,18 @@
+// Tests for getCurrentBranch utility
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const { getCurrentBranch } = require('./getCurrentBranch')
+
+test('getCurrentBranch returns a string', async () => {
+  const branch = await getCurrentBranch()
+  assert.type(branch, 'string')
+  assert.ok(branch.length > 0, 'branch name should not be empty')
+})
+
+test('getCurrentBranch returns expected branch name', async () => {
+  const branch = await getCurrentBranch()
+  // We're on master based on git status
+  assert.is(branch, 'master')
+})
+
+test.run()

package/src/git/jsonDiff.test.js

@@ -0,0 +1,152 @@
+// Tests for rfc6902 and jsonpointer usage (used in gitJSONToGitDSL)
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const jsonDiff = require('rfc6902')
+const jsonpointer = require('jsonpointer')
+
+// Tests for rfc6902.createPatch - used in JSONPatchForFile
+test('rfc6902.createPatch detects added keys', () => {
+  const before = { name: 'test' }
+  const after = { name: 'test', version: '1.0.0' }
+  const patch = jsonDiff.createPatch(before, after)
+
+  assert.is(patch.length, 1)
+  assert.is(patch[0].op, 'add')
+  assert.is(patch[0].path, '/version')
+  assert.is(patch[0].value, '1.0.0')
+})
+
+test('rfc6902.createPatch detects removed keys', () => {
+  const before = { name: 'test', version: '1.0.0' }
+  const after = { name: 'test' }
+  const patch = jsonDiff.createPatch(before, after)
+
+  assert.is(patch.length, 1)
+  assert.is(patch[0].op, 'remove')
+  assert.is(patch[0].path, '/version')
+})
+
+test('rfc6902.createPatch detects changed values', () => {
+  const before = { version: '1.0.0' }
+  const after = { version: '2.0.0' }
+  const patch = jsonDiff.createPatch(before, after)
+
+  assert.is(patch.length, 1)
+  assert.is(patch[0].op, 'replace')
+  assert.is(patch[0].path, '/version')
+  assert.is(patch[0].value, '2.0.0')
+})
+
+test('rfc6902.createPatch handles nested objects', () => {
+  const before = { deps: { lodash: '4.0.0' } }
+  const after = { deps: { lodash: '4.0.0', axios: '1.0.0' } }
+  const patch = jsonDiff.createPatch(before, after)
+
+  assert.is(patch.length, 1)
+  assert.is(patch[0].op, 'add')
+  assert.is(patch[0].path, '/deps/axios')
+})
+
+test('rfc6902.createPatch handles arrays', () => {
+  const before = { items: ['a', 'b'] }
+  const after = { items: ['a', 'b', 'c'] }
+  const patch = jsonDiff.createPatch(before, after)
+
+  assert.is(patch.length, 1)
+  assert.is(patch[0].op, 'add')
+  assert.is(patch[0].path, '/items/-') // RFC 6902 uses - for array append
+  assert.is(patch[0].value, 'c')
+})
+
+test('rfc6902.createPatch returns empty array for identical objects', () => {
+  const obj = { name: 'test', version: '1.0.0' }
+  const patch = jsonDiff.createPatch(obj, obj)
+
+  assert.is(patch.length, 0)
+})
+
+// Tests for jsonpointer.get - used in JSONDiffForFile
+test('jsonpointer.get retrieves root level values', () => {
+  const obj = { name: 'test', version: '1.0.0' }
+
+  assert.is(jsonpointer.get(obj, '/name'), 'test')
+  assert.is(jsonpointer.get(obj, '/version'), '1.0.0')
+})
+
+test('jsonpointer.get retrieves nested values', () => {
+  const obj = { deps: { lodash: '4.0.0' } }
+
+  assert.is(jsonpointer.get(obj, '/deps/lodash'), '4.0.0')
+  assert.equal(jsonpointer.get(obj, '/deps'), { lodash: '4.0.0' })
+})
+
+test('jsonpointer.get retrieves array elements', () => {
+  const obj = { items: ['a', 'b', 'c'] }
+
+  assert.is(jsonpointer.get(obj, '/items/0'), 'a')
+  assert.is(jsonpointer.get(obj, '/items/2'), 'c')
+})
+
+test('jsonpointer.get returns undefined for missing paths', () => {
+  const obj = { name: 'test' }
+
+  assert.is(jsonpointer.get(obj, '/missing'), undefined)
+  assert.is(jsonpointer.get(obj, '/deep/missing/path'), undefined)
+})
+
+// Tests for jsonpointer.set - used in JSONDiffForFile
+test('jsonpointer.set creates root level values', () => {
+  const obj = {}
+  jsonpointer.set(obj, '/name', 'test')
+
+  assert.is(obj.name, 'test')
+})
+
+test('jsonpointer.set creates nested values', () => {
+  const obj = { deps: {} }
+  jsonpointer.set(obj, '/deps/lodash', '4.0.0')
+
+  assert.is(obj.deps.lodash, '4.0.0')
+})
+
+test('jsonpointer.set overwrites existing values', () => {
+  const obj = { version: '1.0.0' }
+  jsonpointer.set(obj, '/version', '2.0.0')
+
+  assert.is(obj.version, '2.0.0')
+})
+
+// Integration test - simulates JSONDiffForFile behavior
+test('integration: build diff object from patches', () => {
+  const before = {
+    name: 'my-pkg',
+    dependencies: { lodash: '4.0.0' }
+  }
+  const after = {
+    name: 'my-pkg',
+    dependencies: { lodash: '4.0.0', axios: '1.0.0' }
+  }
+
+  const patches = jsonDiff.createPatch(before, after)
+  const result = Object.create(null)
+
+  for (const patch of patches) {
+    const pathSteps = patch.path.split('/')
+    const backAStepPath = pathSteps.length <= 2
+      ? patch.path
+      : pathSteps.slice(0, pathSteps.length - 1).join('/')
+
+    const diff = {
+      before: jsonpointer.get(before, backAStepPath) || null,
+      after: jsonpointer.get(after, backAStepPath) || null
+    }
+    jsonpointer.set(result, backAStepPath, diff)
+  }
+
+  assert.equal(result.dependencies, {
+    before: { lodash: '4.0.0' },
+    after: { lodash: '4.0.0', axios: '1.0.0' }
+  })
+})
+
+test.run()

package/src/index.js

@@ -5,6 +5,7 @@ const { getLastCommit } = require('./git/commits/getLastCommit')
 const { getAllCommits } = require('./git/commits/getAllCommits')
 const { getGitFiles } = require('./git/getGitFiles')
 const { getGitRoot } = require('./git/getGitRoot')
+const { getCurrentBranch } = require('./git/getCurrentBranch')
 const { getRemotes, getRemote } = require('./git/remotes/getRemotes')
 const { getFileAtCommit } = require('./git/getFileAtCommit')
 const {
@@ -17,6 +18,7 @@ module.exports = {
   // Get Git Details
   gitDetails,
   getGitRoot,
+  getCurrentBranch,
   // Get Commits
   getCommit,
   getAllCommits,

package/types/git/getCurrentBranch.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Gets the current branch name of the git repository
+ * @returns {Promise<string>} A promise that resolves to the current branch name
+ */
+export function getCurrentBranch(): Promise<string>;

package/types/index.d.ts

@@ -1,5 +1,6 @@
 import { gitDetails } from "./git/getDetails";
 import { getGitRoot } from "./git/getGitRoot";
+import { getCurrentBranch } from "./git/getCurrentBranch";
 import { getCommit } from "./git/commits/getCommit";
 import { getAllCommits } from "./git/commits/getAllCommits";
 import { getFirstCommit } from "./git/commits/getFirstCommit";
@@ -11,4 +12,4 @@ import { getFileCreatedTimeStamp } from "./git/dates/getFileDates";
 import { getFileDates } from "./git/dates/getFileDates";
 import { getRemotes } from "./git/remotes/getRemotes";
 import { getRemote } from "./git/remotes/getRemotes";
-export { gitDetails, getGitRoot, getCommit, getAllCommits, getFirstCommit, getLastCommit, getGitFiles, getFileAtCommit, getFileModifiedTimeStamp, getFileCreatedTimeStamp, getFileDates, getRemotes, getRemote };
+export { gitDetails, getGitRoot, getCurrentBranch, getCommit, getAllCommits, getFirstCommit, getLastCommit, getGitFiles, getFileAtCommit, getFileModifiedTimeStamp, getFileCreatedTimeStamp, getFileDates, getRemotes, getRemote };