Skip to content
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

docs(patch-commit): clarify #476

Merged
merged 5 commits into from
Nov 13, 2023
Merged

docs(patch-commit): clarify #476

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c06fe34
docs(patch-commit): replace confusing placeholder
KSXGitHub Nov 9, 2023
f282bd3
docs(patch-commit): explain the `path` placeholder
KSXGitHub Nov 9, 2023
1482bcf
docs(patch-commit): mention "save"
KSXGitHub Nov 9, 2023
ae16fb5
docs(patch-commit): add more details
KSXGitHub Nov 9, 2023
7a51b78
Update docs/cli/patch-commit.md
zkochan Nov 13, 2023
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
12 changes: 9 additions & 3 deletions docs/cli/patch-commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@ id: patch-commit
title: "pnpm patch-commit <path>"
---

Generate a patch out of a directory (inspired by a similar command in Yarn).
Generate a patch out of a directory and save it (inspired by a similar command in Yarn).

This command will compare the changes from `path` to the package it was supposed to patch, generate a patch file, save the a patch file to `patchesDir` (which can be customized by the `--patches-dir` option), and add an entry to `patchesDependencies` in the top level manifest file.

Usage:

```sh
pnpm patch-commit <patchDir>
pnpm patch-commit <path>
```

* `path` is the path to a modified copy of the patch target package, it is usually a temporary directory generated by [`pnpm patch`](./patch).

## Options

### ---patches-dir &lt;dir>
### ---patches-dir &lt;patchesDir>

The generated patch file will be saved to this directory. By default, patches are saved to the `patches` directory in the root of the project.