Skip to content

Commit

Permalink
Add support for using the -B modifier instead of the default -b w…
Browse files Browse the repository at this point in the history
…hen using `checkoutBranch` / `checkoutLocalBranch`.

Based on requirement detailed in #873
  • Loading branch information
steveukx committed Dec 15, 2022
1 parent edfd459 commit 97fde2c
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 31 deletions.
5 changes: 5 additions & 0 deletions .changeset/nasty-bikes-dance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'simple-git': minor
---

Support the use of `-B` in place of the default `-b` in checkout methods
28 changes: 0 additions & 28 deletions simple-git/src/git.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ const { checkIgnoreTask } = require('./lib/tasks/check-ignore');
const { checkIsRepoTask } = require('./lib/tasks/check-is-repo');
const { cloneTask, cloneMirrorTask } = require('./lib/tasks/clone');
const { cleanWithOptionsTask, isCleanOptionsArray } = require('./lib/tasks/clean');
const { commitTask } = require('./lib/tasks/commit');
const { diffSummaryTask } = require('./lib/tasks/diff');
const { fetchTask } = require('./lib/tasks/fetch');
const { moveTask } = require('./lib/tasks/move');
Expand Down Expand Up @@ -283,33 +282,6 @@ Git.prototype.addAnnotatedTag = function (tagName, tagMessage) {
);
};

/**
* Check out a tag or revision, any number of additional arguments can be passed to the `git checkout` command
* by supplying either a string or array of strings as the first argument.
*/
Git.prototype.checkout = function () {
const commands = ['checkout', ...getTrailingOptions(arguments, true)];
return this._runTask(straightThroughStringTask(commands), trailingFunctionArgument(arguments));
};

/**
* Check out a remote branch
*
* @param {string} branchName name of branch
* @param {string} startPoint (e.g origin/development)
* @param {Function} [then]
*/
Git.prototype.checkoutBranch = function (branchName, startPoint, then) {
return this.checkout(['-b', branchName, startPoint], trailingFunctionArgument(arguments));
};

/**
* Check out a local branch
*/
Git.prototype.checkoutLocalBranch = function (branchName, then) {
return this.checkout(['-b', branchName], trailingFunctionArgument(arguments));
};

/**
* Delete a local branch
*/
Expand Down
3 changes: 2 additions & 1 deletion simple-git/src/lib/simple-git-api.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { SimpleGitBase } from '../../typings';
import { taskCallback } from './task-callback';
import { changeWorkingDirectoryTask } from './tasks/change-working-directory';
import checkout from './tasks/checkout';
import commit from './tasks/commit';
import config from './tasks/config';
import grep from './tasks/grep';
Expand Down Expand Up @@ -137,4 +138,4 @@ export class SimpleGitApi implements SimpleGitBase {
}
}

Object.assign(SimpleGitApi.prototype, commit(), config(), grep(), log(), version());
Object.assign(SimpleGitApi.prototype, checkout(), commit(), config(), grep(), log(), version());
38 changes: 38 additions & 0 deletions simple-git/src/lib/tasks/checkout.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import type { SimpleGit } from '../../../typings';
import type { SimpleGitApi } from '../simple-git-api';
import { getTrailingOptions, remove, trailingFunctionArgument } from '../utils';
import { straightThroughStringTask } from './task';

function checkoutTask(args: string[]) {
const commands = ['checkout', ...args];
if (commands[1] === '-b' && commands.includes('-B')) {
commands[1] = remove(commands, '-B');
}

return straightThroughStringTask(commands);
}

export default function (): Pick<SimpleGit, 'checkout' | 'checkoutBranch' | 'checkoutLocalBranch'> {
return {
checkout(this: SimpleGitApi) {
return this._runTask(
checkoutTask(getTrailingOptions(arguments, 1)),
trailingFunctionArgument(arguments)
);
},

checkoutBranch(this: SimpleGitApi, branchName, startPoint) {
return this._runTask(
checkoutTask(['-b', branchName, startPoint, ...getTrailingOptions(arguments)]),
trailingFunctionArgument(arguments)
);
},

checkoutLocalBranch(this: SimpleGitApi, branchName) {
return this._runTask(
checkoutTask(['-b', branchName, ...getTrailingOptions(arguments)]),
trailingFunctionArgument(arguments)
);
},
};
}
14 changes: 14 additions & 0 deletions simple-git/test/unit/checkout.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ describe('checkout', () => {
});

describe('checkoutLocalBranch', () => {
it('allows using -B', async () => {
git.checkoutLocalBranch('foo', { '-B': null });
await closeWithSuccess();

assertExecutedCommands('checkout', '-B', 'foo');
});

it('with callback', async () => {
git.checkoutLocalBranch('new-branch', callback);
await closeWithSuccess();
Expand All @@ -76,6 +83,13 @@ describe('checkout', () => {
});

describe('checkoutBranch', () => {
it('allows using -B', async () => {
git.checkoutBranch('foo', 'bar', ['-B']);
await closeWithSuccess();

assertExecutedCommands('checkout', '-B', 'foo', 'bar');
});

it('with callback', async function () {
git.checkoutBranch('branch', 'start', callback);

Expand Down
17 changes: 15 additions & 2 deletions simple-git/typings/simple-git.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ export interface SimpleGit extends SimpleGitBase {
): Response<string>;

/**
* Checkout a remote branch.
* Checkout a remote branch - equivalent to `git checkout -b ${branchName} ${startPoint}`
*
* - branchName name of branch.
* - startPoint (e.g origin/development).
Expand All @@ -330,6 +330,13 @@ export interface SimpleGit extends SimpleGitBase {
callback?: types.SimpleGitTaskCallback<void>
): Response<void>;

checkoutBranch(
branchName: string,
startPoint: string,
options?: types.TaskOptions,
callback?: types.SimpleGitTaskCallback<void>
): Response<void>;

/**
* Internally uses pull and tags to get the list of tags then checks out the latest tag.
*/
Expand All @@ -340,13 +347,19 @@ export interface SimpleGit extends SimpleGitBase {
): Response<void>;

/**
* Checkout a local branch
* Checkout a local branch - equivalent to `git checkout -b ${branchName}`
*/
checkoutLocalBranch(
branchName: string,
callback?: types.SimpleGitTaskCallback<void>
): Response<void>;

checkoutLocalBranch(
branchName: string,
options?: types.TaskOptions,
callback?: types.SimpleGitTaskCallback<void>
): Response<void>;

/**
* Deletes unwanted content from the local repo - when supplying the first argument as
* an array of `CleanOptions`, the array must include one of `CleanOptions.FORCE` or
Expand Down

0 comments on commit 97fde2c

Please sign in to comment.