Skip to content

Commit

Permalink
Allow using just one of from and to in the git.log options. (#846)
Browse files Browse the repository at this point in the history
* Allow using just one of `from` and `to` in the `git.log` options.

Closes #845
  • Loading branch information
steveukx authored Aug 22, 2022
1 parent 6b3e05c commit d0dceda
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/spotty-needles-leave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'simple-git': minor
---

Allow supplying just one of to/from in the options supplied to git.log
4 changes: 2 additions & 2 deletions simple-git/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,14 +295,14 @@ For type details of the response for each of the tasks, please see the [TypeScri

- `options.file` - the path to a file in your repository to only consider this path.
- `options.format` - custom log format object, keys are the property names used on the returned object, values are the format string from [pretty formats](https://git-scm.com/docs/pretty-formats#Documentation/pretty-formats.txt)
- `options.from` - when supplied along with `options.to` sets the range of commits to log
- `options.from` - sets the oldest commit in the range to return, use along with `options.to` to set a bounded range
- `options.mailMap` - defaults to true, enables the use of [mail map](https://git-scm.com/docs/gitmailmap) in returned values for email and name from the default format
- `options.maxCount` - equivalent to setting the `--max-count` option
- `options.multiLine` - enables multiline body values in the default format (disabled by default)
- `options.splitter` - the character sequence to use as a delimiter between fields in the log, should be a value that doesn't appear in any log message (defaults to `ò`)
- `options.strictDate` - switches the authored date value from an ISO 8601-like format to be strict ISO 8601 format
- `options.symmetric` - defaults to true, enables [symmetric revision range](https://git-scm.com/docs/gitrevisions#_dotted_range_notations) rather than a two-dot range
- `options.to` - when supplied along with `options.from` sets the range of commits to log
- `options.to` - sets the newset commit in the range to return, use along with `options.from` to set a bounded range

## git merge

Expand Down
4 changes: 2 additions & 2 deletions simple-git/src/lib/tasks/log.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ export function parseLogOptions<T extends Options>(
command.push(`--max-count=${maxCount}`);
}

if (opt.from && opt.to) {
if (opt.from || opt.to) {
const rangeOperator = opt.symmetric !== false ? '...' : '..';
suffix.push(`${opt.from}${rangeOperator}${opt.to}`);
suffix.push(`${opt.from || ''}${rangeOperator}${opt.to || ''}`);
}

if (filterString(opt.file)) {
Expand Down
16 changes: 16 additions & 0 deletions simple-git/test/unit/log.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,22 @@ ${START_BOUNDARY}207601debebc170830f2921acf2b6b27034c3b1f::2016-01-03 15:50:58 +
assertExecutedCommandsContains('--all');
});

it.each([
[{ from: 'from' }, 'from...'],
[{ to: 'to' }, '...to'],
[{ from: 'from', to: '' }, 'from...'],
[{ from: '', to: 'to' }, '...to'],
[{ from: 'from', symmetric: true }, 'from...'],
[{ to: 'to', symmetric: true }, '...to'],
[{ from: 'from', symmetric: false }, 'from..'],
[{ to: 'to', symmetric: false }, '..to'],
])(`supports partial with options %s`, async (options, result) => {
git.log(options);

await closeWithSuccess();
assertExecutedCommandsContains(result);
});

it('when awaiting options object', async () => {
const from = 'from-name';
const to = 'to-name';
Expand Down

0 comments on commit d0dceda

Please sign in to comment.