@apexdevtools/git-ops 1.0.2 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # git-ops - Changelog
 
+## 1.1.1 - 2023-03-27
+
+- Update minimum version to 2.20.0
+
+## 1.1.0 - 2023-03-21
+
+- add new method `getDiffRange`
+- add new method `getLocalChanges`
+
 ## 1.0.2 - 2023-03-20
 
 - downgrade min git version to 2.30.0

package/README.md

@@ -4,7 +4,7 @@ Library to do git operations to find changed files in a given git repository.
 
 ## Prerequisite
 
-Minimum `git` version of `2.30.0` must already be installed on the host machine.
+Minimum `git` version of `2.20.0` must already be installed on the host machine.
 
 ## Getting Started
 
@@ -38,14 +38,40 @@ The output of the command is same as running `git diff branchName...ref` combine
 
 **Note:** files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
 
+### `getDefaultBranchDiffByRef`
+
+Works out changed files using the default branch in that repo given a ref.
+This find the default branch in the repo using `git symbolic-ref 'refs/remotes/origin/HEAD'`
+so the `HEAD` must be set. The output of the command is same as running `git diff branchName...ref` combined with `git status`.
+
+Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
+
 ```TypeScript
-getDefaultBranchDiffByRef(repoRootDir: string, ref: string): Promise<Set<string>>
+getDefaultBranchDiffByRef(repoDir: string, ref: string): Promise<Set<string>>
 ```
 
-Getting changed files using the default branch in that repo.
+### `getDefaultBranchDiff`
 
 This command is same as calling `getDefaultBranchDiffByRef(repoRootDir, 'HEAD')`.
 
 ```TypeScript
-getDefaultBranchDiff(repoRootDir: string): Promise<Set<string>>
+getDefaultBranchDiff(repoDir: string): Promise<Set<string>>
+```
+
+### `getDiffRange`
+
+Works out the diff between a given range. Equivalent to `git diff ref1...ref2`
+
+```Typescript
+getDiffRange(dir: string, fromRef: string, toRef: string): Promise<Set<string>>
+```
+
+### `getLocalChanges`
+
+Get the local changes that not have been committed. Equivalent to `git status`
+
+Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set
+
+```TypeScript
+getLocalChanges(dir: string): Promise<Set<string>>
 ```

package/lib/src/FilesChanged/BranchChanges.d.ts

@@ -11,7 +11,22 @@ export declare function getDefaultBranchDiff(dir: string): Promise<Set<string>>;
  * combined with `git status`.
  * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
  * @param dir: string of the directory thr operation should be performed on
- * @param red: string git ref. i.e HEAD, or commit hash
+ * @param refTo: string git ref. i.e HEAD, or commit hash
  * @returns set of absolute paths of changed files
  */
-export declare function getDefaultBranchDiffByRef(dir: string, ref: string): Promise<Set<string>>;
+export declare function getDefaultBranchDiffByRef(dir: string, refTo: string): Promise<Set<string>>;
+/**
+ * Works out the diff between a given range. Equivalent to `git diff ref1...ref2`
+ * @param dir string of the directory thr operation should be performed on
+ * @param fromRef string git ref. i.e HEAD, or commit hash
+ * @param toRef string git ref. i.e HEAD, or commit hash
+ * @returns set of absolute paths of changed files
+ */
+export declare function getDiffRange(dir: string, fromRef: string, toRef: string): Promise<Set<string>>;
+/**
+ * Get the local changes that not have been committed. Equivalent to `git status`
+ * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
+ * @param dir tring of the directory thr operation should be performed on
+ * @returns set of absolute paths of un committed files
+ */
+export declare function getLocalChanges(dir: string): Promise<Set<string>>;

package/lib/src/FilesChanged/BranchChanges.js

@@ -15,7 +15,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
+exports.getLocalChanges = exports.getDiffRange = exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
 const path_1 = __importDefault(require("path"));
 const Git_1 = require("../Git/Git");
 /**
@@ -36,35 +36,67 @@ exports.getDefaultBranchDiff = getDefaultBranchDiff;
  * combined with `git status`.
  * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
  * @param dir: string of the directory thr operation should be performed on
- * @param red: string git ref. i.e HEAD, or commit hash
+ * @param refTo: string git ref. i.e HEAD, or commit hash
  * @returns set of absolute paths of changed files
  */
-function getDefaultBranchDiffByRef(dir, ref) {
+function getDefaultBranchDiffByRef(dir, refTo) {
     return __awaiter(this, void 0, void 0, function* () {
         const git = new Git_1.Git(dir);
-        const root = yield git.gitRoot();
         return git
             .getDefaultBranchName()
-            .then((branchName) => __awaiter(this, void 0, void 0, function* () {
-            return yield getChanges(git, branchName, ref);
-        }))
-            .then(changes => {
-            const fullPaths = [...changes].map(p => path_1.default.resolve(path_1.default.join(root, p)));
-            return new Set(fullPaths);
-        })
+            .then(branch => getDiffRange(dir, branch, refTo))
             .catch(er => {
-            if (er instanceof Error)
-                throw Error(`Failed getting diff: ${er.message}`);
-            else
-                throw Error('Failed getting diff');
+            throw new NoLocalBranchException(er);
         });
     });
 }
 exports.getDefaultBranchDiffByRef = getDefaultBranchDiffByRef;
-function getChanges(git, branchName, ref) {
+/**
+ * Works out the diff between a given range. Equivalent to `git diff ref1...ref2`
+ * @param dir string of the directory thr operation should be performed on
+ * @param fromRef string git ref. i.e HEAD, or commit hash
+ * @param toRef string git ref. i.e HEAD, or commit hash
+ * @returns set of absolute paths of changed files
+ */
+function getDiffRange(dir, fromRef, toRef) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const git = new Git_1.Git(dir);
+        const root = yield git.gitRoot();
+        return getDiffChanges(git, fromRef, toRef)
+            .then(changes => resolvePaths(changes, root))
+            .catch(er => {
+            throw new DiffFailedException(er);
+        });
+    });
+}
+exports.getDiffRange = getDiffRange;
+/**
+ * Get the local changes that not have been committed. Equivalent to `git status`
+ * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
+ * @param dir tring of the directory thr operation should be performed on
+ * @returns set of absolute paths of un committed files
+ */
+function getLocalChanges(dir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const git = new Git_1.Git(dir);
+        const root = yield git.gitRoot();
+        return git
+            .getLocalChangedAndCreated()
+            .then(changes => resolvePaths(changes, root))
+            .catch(er => {
+            throw new LocalChangeException(er);
+        });
+    });
+}
+exports.getLocalChanges = getLocalChanges;
+function resolvePaths(paths, root) {
+    const fullPaths = [...paths].map(p => path_1.default.resolve(path_1.default.join(root, p)));
+    return new Set(fullPaths);
+}
+function getDiffChanges(git, ref1, ref2) {
     return __awaiter(this, void 0, void 0, function* () {
         const changes = yield Promise.all([
-            git.diffRange(branchName, ref),
+            git.diffRange(ref1, ref2),
             git.getLocalChangedAndCreated(),
         ]);
         const allChanges = new Set();
@@ -72,3 +104,28 @@ function getChanges(git, branchName, ref) {
         return allChanges;
     });
 }
+class GitException extends Error {
+    constructor(msg, err) {
+        if (err instanceof Error) {
+            super(`${msg}. Cause: '${err.message}'`);
+        }
+        else {
+            super(msg);
+        }
+    }
+}
+class NoLocalBranchException extends GitException {
+    constructor(err) {
+        super('Local branch operation failed', err);
+    }
+}
+class LocalChangeException extends GitException {
+    constructor(err) {
+        super('Getting local changes operation failed', err);
+    }
+}
+class DiffFailedException extends GitException {
+    constructor(err) {
+        super('Getting diff operation failed', err);
+    }
+}

package/lib/src/Git/Git.d.ts

@@ -16,7 +16,7 @@ export declare class Git implements IGit {
     private static MIN_GIT_VERSION_MAJOR;
     private static MIN_GIT_VERSION_MINOR;
     private static MIN_GIT_VERSION_PATCH;
-    private static gitInstance;
+    private gitInstance;
     private dir;
     constructor(dir: string);
     static versionCheck(git: SimpleGit): Promise<void>;

package/lib/src/Git/Git.js

@@ -29,6 +29,7 @@ var FileStatus;
 })(FileStatus = exports.FileStatus || (exports.FileStatus = {}));
 class Git {
     constructor(dir) {
+        this.gitInstance = undefined;
         this.dir = dir;
     }
     static versionCheck(git) {
@@ -37,17 +38,20 @@ class Git {
             const isSupported = version.major >= this.MIN_GIT_VERSION_MAJOR &&
                 version.minor >= this.MIN_GIT_VERSION_MINOR &&
                 version.patch >= this.MIN_GIT_VERSION_PATCH;
+            if (!version.installed) {
+                throw new Error('"git" is not installed or available on the PATH');
+            }
             if (!isSupported)
                 throw new Error(`Unsupported version of git. Min version must be ${this.MIN_GIT_VERSION_MAJOR}.${this.MIN_GIT_VERSION_MINOR}.${this.MIN_GIT_VERSION_PATCH}`);
         });
     }
     get git() {
-        if (Git.gitInstance)
-            return Promise.resolve(Git.gitInstance);
+        if (this.gitInstance)
+            return Promise.resolve(this.gitInstance);
         //eslint-disable-next-line
         const git = (0, simple_git_1.simpleGit)(this.dir);
         return Git.versionCheck(git).then(() => {
-            Git.gitInstance = git;
+            this.gitInstance = git;
             return git;
         });
     }
@@ -104,6 +108,5 @@ class Git {
 }
 exports.Git = Git;
 Git.MIN_GIT_VERSION_MAJOR = 2;
-Git.MIN_GIT_VERSION_MINOR = 30;
+Git.MIN_GIT_VERSION_MINOR = 20;
 Git.MIN_GIT_VERSION_PATCH = 0;
-Git.gitInstance = undefined;

package/lib/src/index.d.ts

@@ -1,3 +1,3 @@
-export { getDefaultBranchDiff, getDefaultBranchDiffByRef, } from './FilesChanged/BranchChanges';
+export { getDefaultBranchDiff, getDefaultBranchDiffByRef, getDiffRange, getLocalChanges, } from './FilesChanged/BranchChanges';
 export { IGit } from './api/IGit';
 export { Git } from './Git/Git';

package/lib/src/index.js

@@ -3,9 +3,11 @@
  * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
+exports.Git = exports.getLocalChanges = exports.getDiffRange = exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
 var BranchChanges_1 = require("./FilesChanged/BranchChanges");
 Object.defineProperty(exports, "getDefaultBranchDiff", { enumerable: true, get: function () { return BranchChanges_1.getDefaultBranchDiff; } });
 Object.defineProperty(exports, "getDefaultBranchDiffByRef", { enumerable: true, get: function () { return BranchChanges_1.getDefaultBranchDiffByRef; } });
+Object.defineProperty(exports, "getDiffRange", { enumerable: true, get: function () { return BranchChanges_1.getDiffRange; } });
+Object.defineProperty(exports, "getLocalChanges", { enumerable: true, get: function () { return BranchChanges_1.getLocalChanges; } });
 var Git_1 = require("./Git/Git");
 Object.defineProperty(exports, "Git", { enumerable: true, get: function () { return Git_1.Git; } });

package/lib/test/BranchChanges/BranchChanges.spec.js

@@ -66,7 +66,7 @@ describe('Branch changes', () => {
             //Given
             mockGitImpl.getDefaultBranchName.mockRejectedValue(Error('no head ref error'));
             //When/Then
-            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error('Failed getting diff: no head ref error'));
+            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error("Local branch operation failed. Cause: 'no head ref error'"));
         }));
         it('rejects and throws error when "getLocalChangedAndCreated" fails', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given
@@ -74,7 +74,7 @@ describe('Branch changes', () => {
             mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
             mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
             //When/Then
-            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error('Failed getting diff: op failed'));
+            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error("Local branch operation failed. Cause: 'Getting diff operation failed. Cause: 'op failed''"));
         }));
     });
     describe('getDefaultBranchDiff', () => {
@@ -102,7 +102,51 @@ describe('Branch changes', () => {
             mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
             mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
             //When/Then
-            yield expect((0, BranchChanges_1.getDefaultBranchDiff)('./some/path/to/dir')).rejects.toEqual(Error('Failed getting diff: op failed'));
+            yield expect((0, BranchChanges_1.getDefaultBranchDiff)('./some/path/to/dir')).rejects.toEqual(Error("Local branch operation failed. Cause: 'Getting diff operation failed. Cause: 'op failed''"));
+        }));
+    });
+    describe('getDiffRange', () => {
+        it('returns the correct set of files', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockResolvedValue(new Set(['SomeFile.txt']));
+            //When
+            const res = yield (0, BranchChanges_1.getDiffRange)('./some/path/to/dir', 'ref1', 'ref2');
+            //Then
+            expect(mockedGit).toHaveBeenCalledWith('./some/path/to/dir');
+            expect(mockGitImpl.getLocalChangedAndCreated).toBeCalledTimes(1);
+            expect(mockGitImpl.diffRange).toHaveBeenCalledWith('ref1', 'ref2');
+            expect(res).toEqual(new Set([
+                `${mockRootDir}/abs/path/to/repo/File.txt`,
+                `${mockRootDir}/abs/path/to/repo/AnotherClass.txt`,
+                `${mockRootDir}/abs/path/to/repo/SomeFile.txt`,
+            ]));
+        }));
+        it('rejects and throws error when "getLocalChangedAndCreated" fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockResolvedValue('default/branch/name');
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
+            //When/Then
+            yield expect((0, BranchChanges_1.getDiffRange)('./some/path/to/dir', 'ref1', 'ref2')).rejects.toEqual(Error("Getting diff operation failed. Cause: 'op failed'"));
+        }));
+    });
+    describe('getLocalChanges', () => {
+        it('returns the correct set of files', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getLocalChangedAndCreated.mockResolvedValue(new Set(['SomeFile.txt']));
+            //When
+            const res = yield (0, BranchChanges_1.getLocalChanges)('./some/path/to/dir');
+            //Then
+            expect(mockedGit).toHaveBeenCalledWith('./some/path/to/dir');
+            expect(mockGitImpl.getLocalChangedAndCreated).toBeCalledTimes(1);
+            expect(res).toEqual(new Set([`${mockRootDir}/abs/path/to/repo/SomeFile.txt`]));
+        }));
+        it('rejects and throws error when op fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
+            //When/Then
+            yield expect((0, BranchChanges_1.getLocalChanges)('./some/path/to/dir')).rejects.toEqual(Error("Getting local changes operation failed. Cause: 'op failed'"));
         }));
     });
 });

package/lib/test/Git/Git.spec.js

@@ -28,37 +28,62 @@ describe('Git', () => {
         yield repoManager.tearDown();
     }));
     describe('version check', () => {
-        it('does not fail when Git version is equal to 2.30.0', () => {
+        it('does not fail when Git version is equal to 2.20.0', () => {
             //Given/When
             const mock = {
-                version: jest.fn().mockReturnValue({ major: 2, minor: 30, patch: 0 }),
+                version: jest.fn().mockReturnValue({
+                    installed: true,
+                    major: 2,
+                    minor: 20,
+                    patch: 0,
+                }),
             };
             expect(Git_1.Git.versionCheck(mock)).resolves;
         });
-        it('fails when Git major version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('does not fail when Git version is higher', () => {
+            //Given/When
+            const mock = {
+                version: jest.fn().mockReturnValue({
+                    installed: true,
+                    major: 2,
+                    minor: 30,
+                    patch: 2,
+                }),
+            };
+            //Then
+            expect(Git_1.Git.versionCheck(mock)).resolves;
+        });
+        it('fails when Git is not installed', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given/When
             const mock = {
-                version: jest.fn().mockReturnValue({ major: 1 }),
+                version: jest.fn().mockReturnValue({ installed: false }),
             };
             //Then
-            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.30.0'));
+            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('"git" is not installed or available on the PATH'));
         }));
-        it('fails when Git minor version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('fails when Git major version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given/When
             const mock = {
-                version: jest.fn().mockReturnValue({ major: 3, minor: 36 }),
+                version: jest.fn().mockReturnValue({
+                    installed: true,
+                    major: 1,
+                }),
             };
             //Then
-            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.30.0'));
+            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.20.0'));
         }));
-        it('fails when Git patch version is more than 0', () => {
+        it('fails when Git minor version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given/When
             const mock = {
-                version: jest.fn().mockReturnValue({ major: 3, minor: 38, patch: 1 }),
+                version: jest.fn().mockReturnValue({
+                    installed: true,
+                    major: 2,
+                    minor: 19,
+                }),
             };
             //Then
-            expect(Git_1.Git.versionCheck(mock)).resolves;
-        });
+            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.20.0'));
+        }));
     });
     describe('rev parse', () => {
         it('get git root', () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apexdevtools/git-ops",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Library to do git operations to find changed files in a given git repository",
   "author": {
     "name": "Apex Dev Tools Team",
@@ -50,7 +50,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "install": "^0.13.0",
     "simple-git": "^3.16.0"
   },
   "config": {