Skip to content

Commit 0b326b4

Browse files
github-actions[bot]steveukx
authored andcommitted
Version Packages
1 parent fb3c87d commit 0b326b4

File tree

5 files changed

+57
-57
lines changed

5 files changed

+57
-57
lines changed

.changeset/common-swans-buy.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

.changeset/nasty-bikes-say.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

.changeset/two-actors-taste.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

simple-git/CHANGELOG.md

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Change History & Release Notes
22

3+
## 3.29.0
4+
5+
### Minor Changes
6+
7+
- 240ec64: Support for absolute paths on Windows when using `git.checkIngore`, previously Windows would report
8+
paths with duplicate separators `\\\\` between directories.
9+
10+
Following this change all paths returned from `git.checkIgnore` will be normalized through `node:path`,
11+
this should have no impact on non-windows users where the `git` binary doesn't wrap absolute paths with
12+
quotes.
13+
14+
Thanks to @Maxim-Mazurok for reporting this issue.
15+
16+
- 9872f84: Support the use of `git.branch(['--show-current'])` to limit the branch list to only the current branch.
17+
18+
Thanks to @peterbe for pointing out the use-case.
19+
20+
- 5736bd8: Change to biome for lint and format
21+
322
## 3.28.0
423

524
### Minor Changes
@@ -136,7 +155,7 @@
136155
### Patch Changes
137156

138157
- 7746480: - Upgrade repo dependencies - lerna and jest
139-
- Include node@19 in the test matrix
158+
- Include node@19 in the test matrix
140159

141160
## 3.14.1
142161

@@ -197,7 +216,7 @@
197216

198217
- 25230cb: Support for additional log formats in diffSummary / log / stashList.
199218

200-
Adds support for the `--numstat`, `--name-only` and `--name-stat` in addition to the existing `--stat` option.
219+
Adds support for the `--numstat`, `--name-only` and `--name-stat` in addition to the existing `--stat` option.
201220

202221
### Patch Changes
203222

@@ -536,8 +555,8 @@
536555
`simpleGit('/some/path', { config: ['http.proxy=someproxy'] }).pull()`
537556
- Add deprecation notice to `git.silent`
538557
- Internal Updates:
539-
- switch from `run` to `runTask` in `git` core
540-
- finish converting all mocks to TypeScript
558+
- switch from `run` to `runTask` in `git` core
559+
- finish converting all mocks to TypeScript
541560

542561
## 2.31.0 Handle 'root' commit syntax
543562

@@ -566,8 +585,8 @@
566585

567586
- Update the `git.status` parser to account for staged deleted/modified files and staged files with subsequent
568587
modifications meaning a status of:
569-
- `RM old -> new` will now appear in `renamed` and `new` will also appear in `modified`
570-
- `D file` will now appear in both `deleted` and `staged` where `D file` would only appear in `deleted`
588+
- `RM old -> new` will now appear in `renamed` and `new` will also appear in `modified`
589+
- `D file` will now appear in both `deleted` and `staged` where `D file` would only appear in `deleted`
571590

572591
## 2.26.0 Fix error when using `git.log` with callback
573592

@@ -631,9 +650,9 @@
631650

632651
- adds the `TaskParser` type to describe a task's parser function and creates the `LineParser` utility to simplify line-by-line parsing of string responses.
633652
- renames some interfaces for consistency of naming, the original name remains as a type alias marked as `@deprecated` until version 3.x:
634-
- BranchDeletionSummary > BranchSingleDeleteResult
635-
- BranchDeletionBatchSummary > BranchMultiDeleteResult
636-
- MergeSummary > MergeResult
653+
- BranchDeletionSummary > BranchSingleDeleteResult
654+
- BranchDeletionBatchSummary > BranchMultiDeleteResult
655+
- MergeSummary > MergeResult
637656

638657
## 2.14.0 - Bug fix: `git.checkoutBranch` fails to pass commands to git child process
639658

@@ -669,10 +688,10 @@
669688
giving the developer more control over which tasks should be treated as atomic chains, and which can be
670689
[run in parallel](https://github.com/steveukx/git-js/blob/main/readme.md#concurrent--parallel-requests).
671690

672-
To support this, and to prevent the issues seen when `git` is run concurrently in too many child processes,
673-
`simple-git` will limit the number of tasks running in parallel at any one time to be at most 1 from each
674-
chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains (
675-
[configurable](https://github.com/steveukx/git-js/blob/main/readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor).
691+
To support this, and to prevent the issues seen when `git` is run concurrently in too many child processes,
692+
`simple-git` will limit the number of tasks running in parallel at any one time to be at most 1 from each
693+
chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains (
694+
[configurable](https://github.com/steveukx/git-js/blob/main/readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor).
676695

677696
- add support to `git.status()` for parsing the response of a repo that has no commits yet, previously
678697
it wouldn't determine the branch name correctly.
@@ -684,47 +703,52 @@
684703
- `git.checkout` now supports both object and array forms of supplying trailing options.
685704

686705
```typescript
687-
import simpleGit from 'simple-git';
688-
await simpleGit().checkout('branch-name', ['--track', 'remote/branch']);
689-
await simpleGit().checkout(['branch-name', '--track', 'remote/branch']);
690-
await simpleGit().checkout({ 'branch-name': null });
706+
import simpleGit from "simple-git";
707+
await simpleGit().checkout("branch-name", ["--track", "remote/branch"]);
708+
await simpleGit().checkout(["branch-name", "--track", "remote/branch"]);
709+
await simpleGit().checkout({ "branch-name": null });
691710
```
692711

693712
- `git.init` now supports both object and array forms of supplying trailing options and now
694713
parses the response to return an [InitResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts);
695714

696715
```typescript
697-
import simpleGit, { InitResult } from 'simple-git';
698-
const notSharedInit: InitResult = await simpleGit().init(false, ['--shared=false']);
699-
const notSharedBareInit: InitResult = await simpleGit().init(['--bare', '--shared=false']);
716+
import simpleGit, { InitResult } from "simple-git";
717+
const notSharedInit: InitResult = await simpleGit().init(false, [
718+
"--shared=false",
719+
]);
720+
const notSharedBareInit: InitResult = await simpleGit().init([
721+
"--bare",
722+
"--shared=false",
723+
]);
700724
const sharedInit: InitResult = await simpleGit().init(false, {
701-
'--shared': 'true',
725+
"--shared": "true",
702726
});
703727
const sharedBareInit: InitResult = await simpleGit().init({
704-
'--bare': null,
705-
'--shared': 'false',
728+
"--bare": null,
729+
"--shared": "false",
706730
});
707731
```
708732

709733
- `git.status` now supports both object and array forms of supplying trailing options.
710734

711735
```typescript
712-
import simpleGit, { StatusResult } from 'simple-git';
736+
import simpleGit, { StatusResult } from "simple-git";
713737
const repoStatus: StatusResult = await simpleGit().status();
714-
const subDirStatus: StatusResult = await simpleGit().status(['--', 'sub-dir']);
738+
const subDirStatus: StatusResult = await simpleGit().status(["--", "sub-dir"]);
715739
```
716740

717741
- `git.reset` upgraded to the new task style and exports an enum `ResetMode` with all supported
718742
merge modes and now supports both object and array forms of supplying trailing options.
719743

720744
```typescript
721-
import simpleGit, { ResetMode } from 'simple-git';
745+
import simpleGit, { ResetMode } from "simple-git";
722746

723747
// git reset --hard
724748
await simpleGit().reset(ResetMode.HARD);
725749

726750
// git reset --soft -- sub-dir
727-
await simpleGit().reset(ResetMode.SOFT, ['--', 'sub-dir']);
751+
await simpleGit().reset(ResetMode.SOFT, ["--", "sub-dir"]);
728752
```
729753

730754
- bug-fix: it should not be possible to await the `simpleGit()` task runner, only the tasks it returns.
@@ -739,9 +763,9 @@ expect(simpleGit().init().then).toBe(expect.any(Function));
739763
- `.checkIsRepo()` updated to allow choosing the type of check to run, either by using the exported `CheckRepoActions` enum
740764
or the text equivalents ('bare', 'root' or 'tree'):
741765

742-
- `checkIsRepo(CheckRepoActions.BARE): Promise<boolean>` determines whether the working directory represents a bare repo.
743-
- `checkIsRepo(CheckRepoActions.IS_REPO_ROOT): Promise<boolean>` determines whether the working directory is at the root of a repo.
744-
- `checkIsRepo(CheckRepoActions.IN_TREE): Promise<boolean>` determines whether the working directory is a descendent of a git root.
766+
- `checkIsRepo(CheckRepoActions.BARE): Promise<boolean>` determines whether the working directory represents a bare repo.
767+
- `checkIsRepo(CheckRepoActions.IS_REPO_ROOT): Promise<boolean>` determines whether the working directory is at the root of a repo.
768+
- `checkIsRepo(CheckRepoActions.IN_TREE): Promise<boolean>` determines whether the working directory is a descendent of a git root.
745769

746770
- `.revparse()` converted to a new style task
747771

@@ -778,8 +802,8 @@ expect(simpleGit().init().then).toBe(expect.any(Function));
778802
- The main export from `simple-git` no longer shows the deprecation notice for using the
779803
`.then` function, it now exposes the promise chain generated from the most recently run
780804
task, allowing the combination of chain building and ad-hoc splitting off to a new promise chain.
781-
- See the [unit](https://github.com/steveukx/git-js/blob/main/simple-git/test/unit/promises.spec.js) and [integration](https://github.com/steveukx/git-js/blob/main/simple-git/test/integration/promise-from-root.spec.js) tests.
782-
- See the [typescript consumer](https://github.com/steveukx/git-js/blob/main/simple-git/test/consumer/ts-default-from-root.spec.ts) test.
805+
- See the [unit](https://github.com/steveukx/git-js/blob/main/simple-git/test/unit/promises.spec.js) and [integration](https://github.com/steveukx/git-js/blob/main/simple-git/test/integration/promise-from-root.spec.js) tests.
806+
- See the [typescript consumer](https://github.com/steveukx/git-js/blob/main/simple-git/test/consumer/ts-default-from-root.spec.ts) test.
783807

784808
### TypeScript Importing
785809

simple-git/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "simple-git",
33
"description": "Simple GIT interface for node.js",
4-
"version": "3.28.0",
4+
"version": "3.29.0",
55
"author": "Steve King <steve@mydev.co>",
66
"contributors": [
77
{

0 commit comments

Comments
 (0)