aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 4d90d548c3330be399b7c0b46213ba541b0bcf43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
github-suggestion
=================

Diffs and patches for GitHub pull request suggestions. Given a suggestion ID,
get a unified diff of the suggested change, or apply it directly to the working
copy in a Git repository.


## Examples

	$ git clone https://github.com/cli/cli.git
	Cloning into 'cli'...
	…
	$ cd cli/
	$ git checkout 74a39f3
	Note: checking out '74a39f3'.
	…
	$ git sugpatch https://github.com/cli/cli/pull/1150#discussion_r438352211
	diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go
	index b4a8dbd..c081b50 100644
	--- a/pkg/cmd/api/api.go
	+++ b/pkg/cmd/api/api.go
	@@ -247,8 +247,7 @@ func readUserFile(fn string, stdin io.ReadCloser) ([]byte, error) {
		if fn == "-" {
			r = stdin
		} else {
	-		var err error
	-		r, err = os.Open(fn)
	+		r, err := os.Open(fn)
			if err != nil {
				return nil, err
			}
	$ git status
	HEAD detached at 74a39f3
	nothing to commit, working tree clean
	$ git sugapply 438352211
	$ git status
	HEAD detached at 74a39f3
	Changes not staged for commit:
	  (use "git add <file>..." to update what will be committed)
	  (use "git checkout -- <file>..." to discard changes in working directory)

		modified:   pkg/cmd/api/api.go

	no changes added to commit (use "git add" and/or "git commit -a")
	$ git diff
	diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go
	index b4a8dbd..c081b50 100644
	--- a/pkg/cmd/api/api.go
	+++ b/pkg/cmd/api/api.go
	@@ -247,8 +247,7 @@ func readUserFile(fn string, stdin io.ReadCloser) ([]byte, error) {
		if fn == "-" {
			r = stdin
		} else {
	-		var err error
	-		r, err = os.Open(fn)
	+		r, err := os.Open(fn)
			if err != nil {
				return nil, err
			}


## Install
On Mac OS X, GitHub-Suggestion can be installed with Homebrew:

	$ brew install teddywing/formulae/github-suggestion

To compile from source or install on other platforms:

	$ cargo install --git https://github.com/teddywing/github-suggestion.git --root /usr/local


## Uninstall

	$ cargo uninstall --root /usr/local github-suggestion


## License
Copyright © 2020 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).