Skip to content

Revise Dugite usage examples in README (Replace deprecated GitProcess usage with new exec() API) #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
princeaden1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revise Dugite usage examples in README (Replace deprecated GitProcess usage with new exec() API) #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,27 @@ or
> yarn add dugite
```

Then reference it in your application:
### Then reference it in your application:
*Note: Dugite previously used the GitProcess, but this is no longer exported in the latest versions.
The example below shows the updated recommended usage, followed by the older (deprecated) approach.*

#### Current Usage (Recommended)
```js
import { exec, GitError, IGitResult } from 'dugite'

const pathToRepository = 'C:/path/to/git/repository/'

const result = await exec(['status'], pathToRepository)
if (result.exitCode === 0) {
const output = result.stdout
// do some things with the output
} else {
const error = result.stderr
// error handling
}
```

#### Previous Standard
```js
import { GitProcess, GitError, IGitResult } from 'dugite'

Expand Down