diff options
author | Teddy Wing | 2020-08-23 20:55:08 +0200 |
---|---|---|
committer | Teddy Wing | 2020-08-23 20:55:08 +0200 |
commit | 623f60844478a3cfc60d697f5e5d804254c01c50 (patch) | |
tree | 981f8e57bc35fbc3022a58f7442a9e7f92926491 | |
parent | bce2e554408404233b66f11e2e342d83c3ca81dd (diff) | |
download | git-suggestion-623f60844478a3cfc60d697f5e5d804254c01c50.tar.bz2 |
Rename `git-sugpatch` to `git-sugdiff`
The word "patch" reminds me more of the `patch` Unix command, which is
what `git-sugapply` does.
Since this command outputs diffs, it makes more sense to call it
`sugdiff`. That also brings these closer to the native Git commands,
`git-diff` and `git-apply`.
I had chosen "patch" originally because the command generated a unified
diff that could be used as a patch file to apply to the repo.
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | doc/git-sugapply.1 | 6 | ||||
-rw-r--r-- | doc/git-sugapply.1.txt | 2 | ||||
-rw-r--r-- | doc/git-sugdiff.1 (renamed from doc/git-sugpatch.1) | 16 | ||||
-rw-r--r-- | doc/git-sugdiff.1.txt (renamed from doc/git-sugpatch.1.txt) | 14 | ||||
-rw-r--r-- | src/bin/git-sugdiff.rs | 2 | ||||
-rw-r--r-- | src/bin/git-sugpatch.rs | 55 |
7 files changed, 21 insertions, 76 deletions
@@ -15,7 +15,7 @@ copy in a Git repository. $ git checkout 74a39f3 Note: checking out '74a39f3'. … - $ git sugpatch https://github.com/cli/cli/pull/1150#discussion_r438352211 + $ git sugdiff 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 diff --git a/doc/git-sugapply.1 b/doc/git-sugapply.1 index d9eb195..c1a03ad 100644 --- a/doc/git-sugapply.1 +++ b/doc/git-sugapply.1 @@ -2,12 +2,12 @@ .\" Title: git-sugapply .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 08/06/2020 +.\" Date: 08/23/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "GIT\-SUGAPPLY" "1" "08/06/2020" "\ \&" "\ \&" +.TH "GIT\-SUGAPPLY" "1" "08/23/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -125,4 +125,4 @@ $ git sugapply 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#d .\} .SH "SEE ALSO" .sp -git\-sugpatch(1) +git\-sugdiff(1) diff --git a/doc/git-sugapply.1.txt b/doc/git-sugapply.1.txt index d513505..ca55726 100644 --- a/doc/git-sugapply.1.txt +++ b/doc/git-sugapply.1.txt @@ -68,4 +68,4 @@ They can also be mixed: SEE ALSO -------- -git-sugpatch(1) +git-sugdiff(1) diff --git a/doc/git-sugpatch.1 b/doc/git-sugdiff.1 index 6f5ad15..345b91c 100644 --- a/doc/git-sugpatch.1 +++ b/doc/git-sugdiff.1 @@ -1,13 +1,13 @@ '\" t -.\" Title: git-sugpatch +.\" Title: git-sugdiff .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 08/06/2020 +.\" Date: 08/23/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "GIT\-SUGPATCH" "1" "08/06/2020" "\ \&" "\ \&" +.TH "GIT\-SUGDIFF" "1" "08/23/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,10 +28,10 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -git-sugpatch \- Show diffs for GitHub suggestions +git-sugdiff \- Show diffs for GitHub suggestions .SH "SYNOPSIS" .sp -\fIgit sugpatch\fR [options] <suggestion>\&... +\fIgit sugdiff\fR [options] <suggestion>\&... .SH "DESCRIPTION" .sp Show the diffs of the given GitHub suggestion references\&. @@ -94,7 +94,7 @@ Suggestion references can be specified either as URLs: .RS 4 .\} .nf -$ git sugpatch https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 +$ git sugdiff https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 .fi .if n \{\ .RE @@ -106,7 +106,7 @@ or as comment IDs: .RS 4 .\} .nf -$ git sugpatch 459691747 +$ git sugdiff 459691747 .fi .if n \{\ .RE @@ -118,7 +118,7 @@ They can also be mixed: .RS 4 .\} .nf -$ git sugpatch 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 +$ git sugdiff 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 .fi .if n \{\ .RE diff --git a/doc/git-sugpatch.1.txt b/doc/git-sugdiff.1.txt index c1513a4..9960949 100644 --- a/doc/git-sugpatch.1.txt +++ b/doc/git-sugdiff.1.txt @@ -1,13 +1,13 @@ -git-sugpatch(1) -=============== +git-sugdiff(1) +============== NAME ---- -git-sugpatch - Show diffs for GitHub suggestions +git-sugdiff - Show diffs for GitHub suggestions SYNOPSIS -------- -'git sugpatch' [options] <suggestion>... +'git sugdiff' [options] <suggestion>... DESCRIPTION ----------- @@ -55,15 +55,15 @@ EXAMPLES -------- Suggestion references can be specified either as URLs: - $ git sugpatch https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 + $ git sugdiff https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 or as comment IDs: - $ git sugpatch 459691747 + $ git sugdiff 459691747 They can also be mixed: - $ git sugpatch 459692838 https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 + $ git sugdiff 459692838 https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 SEE ALSO -------- diff --git a/src/bin/git-sugdiff.rs b/src/bin/git-sugdiff.rs index 3bc787a..c703e2b 100644 --- a/src/bin/git-sugdiff.rs +++ b/src/bin/git-sugdiff.rs @@ -29,7 +29,7 @@ fn main() { let config = match Config::get( &args, - "usage: git sugpatch [options] <suggestion>...", + "usage: git sugdiff [options] <suggestion>...", ) { Ok(c) => c, Err(e) => { diff --git a/src/bin/git-sugpatch.rs b/src/bin/git-sugpatch.rs deleted file mode 100644 index 615bcff..0000000 --- a/src/bin/git-sugpatch.rs +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright (c) 2020 Teddy Wing -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see <https://www.gnu.org/licenses/>. - - -use std::env; -use std::process; - -use exitcode; - -use github_suggestion_cli::{gseprintln, for_suggestion}; -use github_suggestion_cli::config::Config; - - -fn main() { - let args: Vec<_> = env::args().collect(); - - let config = match Config::get( - &args, - "usage: git sugpatch [options] <suggestion>...", - ) { - Ok(c) => c, - Err(e) => { - gseprintln!(e); - - process::exit(exitcode::CONFIG); - }, - }; - - for_suggestion( - &config, - |suggestion| { - let diff = match suggestion.diff() { - Ok(d) => d, - Err(e) => { - gseprintln!(e); - process::exit(exitcode::UNAVAILABLE); - }, - }; - - print!("{}", diff); - }, - ); -} |