From 623f60844478a3cfc60d697f5e5d804254c01c50 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sun, 23 Aug 2020 20:55:08 +0200 Subject: 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. --- README.md | 2 +- doc/git-sugapply.1 | 6 +-- doc/git-sugapply.1.txt | 2 +- doc/git-sugdiff.1 | 128 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/git-sugdiff.1.txt | 70 ++++++++++++++++++++++++++ doc/git-sugpatch.1 | 128 ------------------------------------------------ doc/git-sugpatch.1.txt | 70 -------------------------- src/bin/git-sugdiff.rs | 2 +- src/bin/git-sugpatch.rs | 55 --------------------- 9 files changed, 204 insertions(+), 259 deletions(-) create mode 100644 doc/git-sugdiff.1 create mode 100644 doc/git-sugdiff.1.txt delete mode 100644 doc/git-sugpatch.1 delete mode 100644 doc/git-sugpatch.1.txt delete mode 100644 src/bin/git-sugpatch.rs diff --git a/README.md b/README.md index 7107aa9..a247bb8 100644 --- a/README.md +++ b/README.md @@ -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 -.\" 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-sugdiff.1 b/doc/git-sugdiff.1 new file mode 100644 index 0000000..345b91c --- /dev/null +++ b/doc/git-sugdiff.1 @@ -0,0 +1,128 @@ +'\" t +.\" Title: git-sugdiff +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 08/23/2020 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "GIT\-SUGDIFF" "1" "08/23/2020" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +git-sugdiff \- Show diffs for GitHub suggestions +.SH "SYNOPSIS" +.sp +\fIgit sugdiff\fR [options] \&... +.SH "DESCRIPTION" +.sp +Show the diffs of the given GitHub suggestion references\&. +.sp +A suggestion reference is either a URL to the comment, or its ID\&. +.SH "OPTIONS" +.PP +\-\-github\-token= +.RS 4 +A GitHub API token with the \(lqrepo\(rq permission\&. This can also be set with +\fBgithubSuggestion\&.githubToken\fR +or the +\fBGITHUB_TOKEN\fR +environment variable\&. +.RE +.PP +\-h, \-\-help +.RS 4 +Print usage help\&. +.RE +.PP +\-\-remote= +.RS 4 +The remote to use to fetch the suggestion from when passing a suggestion ID\&. This can also be set with +\fBgithubSuggestion\&.remote\fR\&. Defaults to +\fBorigin\fR\&. +.RE +.PP +\-V, \-\-version +.RS 4 +Print the program version\&. +.RE +.SH "CONFIGURATION" +.sp +Configuration options can be specified either as command line options, or in the Git config\&. Command line options take precedence\&. +.PP +githubSuggestion\&.githubToken +.RS 4 +A GitHub API token with the \(lqrepo\(rq permission\&. This will override the +\fBGITHUB_TOKEN\fR +environment variable\&. +.RE +.PP +githubSuggestion\&.remote +.RS 4 +The remote to use to fetch the suggestion from when passing a suggestion ID\&. Defaults to +\fBorigin\fR\&. +.RE +.SH "ENVIRONMENT VARIABLES" +.PP +GITHUB_TOKEN +.RS 4 +A GitHub API token with the \(lqrepo\(rq permission\&. +.RE +.SH "EXAMPLES" +.sp +Suggestion references can be specified either as URLs: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ git sugdiff https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 +.fi +.if n \{\ +.RE +.\} +.sp +or as comment IDs: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ git sugdiff 459691747 +.fi +.if n \{\ +.RE +.\} +.sp +They can also be mixed: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ git sugdiff 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.sp +git\-sugapply(1) diff --git a/doc/git-sugdiff.1.txt b/doc/git-sugdiff.1.txt new file mode 100644 index 0000000..9960949 --- /dev/null +++ b/doc/git-sugdiff.1.txt @@ -0,0 +1,70 @@ +git-sugdiff(1) +============== + +NAME +---- +git-sugdiff - Show diffs for GitHub suggestions + +SYNOPSIS +-------- +'git sugdiff' [options] ... + +DESCRIPTION +----------- +Show the diffs of the given GitHub suggestion references. + +A suggestion reference is either a URL to the comment, or its ID. + +OPTIONS +------- +--github-token=:: + A GitHub API token with the “repo” permission. This can also be set + with `githubSuggestion.githubToken` or the `GITHUB_TOKEN` + environment variable. + +-h, --help:: + Print usage help. + +--remote=:: + The remote to use to fetch the suggestion from when passing a + suggestion ID. This can also be set with `githubSuggestion.remote`. + Defaults to `origin`. + +-V, --version:: + Print the program version. + +CONFIGURATION +------------- +Configuration options can be specified either as command line options, +or in the Git config. Command line options take precedence. + +githubSuggestion.githubToken:: + A GitHub API token with the “repo” permission. This will override + the `GITHUB_TOKEN` environment variable. + +githubSuggestion.remote:: + The remote to use to fetch the suggestion from when passing a + suggestion ID. Defaults to `origin`. + +ENVIRONMENT VARIABLES +--------------------- +GITHUB_TOKEN:: + A GitHub API token with the “repo” permission. + +EXAMPLES +-------- +Suggestion references can be specified either as URLs: + + $ git sugdiff https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 + +or as comment IDs: + + $ git sugdiff 459691747 + +They can also be mixed: + + $ git sugdiff 459692838 https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 + +SEE ALSO +-------- +git-sugapply(1) diff --git a/doc/git-sugpatch.1 b/doc/git-sugpatch.1 deleted file mode 100644 index 6f5ad15..0000000 --- a/doc/git-sugpatch.1 +++ /dev/null @@ -1,128 +0,0 @@ -'\" t -.\" Title: git-sugpatch -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 08/06/2020 -.\" Manual: \ \& -.\" Source: \ \& -.\" Language: English -.\" -.TH "GIT\-SUGPATCH" "1" "08/06/2020" "\ \&" "\ \&" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -git-sugpatch \- Show diffs for GitHub suggestions -.SH "SYNOPSIS" -.sp -\fIgit sugpatch\fR [options] \&... -.SH "DESCRIPTION" -.sp -Show the diffs of the given GitHub suggestion references\&. -.sp -A suggestion reference is either a URL to the comment, or its ID\&. -.SH "OPTIONS" -.PP -\-\-github\-token= -.RS 4 -A GitHub API token with the \(lqrepo\(rq permission\&. This can also be set with -\fBgithubSuggestion\&.githubToken\fR -or the -\fBGITHUB_TOKEN\fR -environment variable\&. -.RE -.PP -\-h, \-\-help -.RS 4 -Print usage help\&. -.RE -.PP -\-\-remote= -.RS 4 -The remote to use to fetch the suggestion from when passing a suggestion ID\&. This can also be set with -\fBgithubSuggestion\&.remote\fR\&. Defaults to -\fBorigin\fR\&. -.RE -.PP -\-V, \-\-version -.RS 4 -Print the program version\&. -.RE -.SH "CONFIGURATION" -.sp -Configuration options can be specified either as command line options, or in the Git config\&. Command line options take precedence\&. -.PP -githubSuggestion\&.githubToken -.RS 4 -A GitHub API token with the \(lqrepo\(rq permission\&. This will override the -\fBGITHUB_TOKEN\fR -environment variable\&. -.RE -.PP -githubSuggestion\&.remote -.RS 4 -The remote to use to fetch the suggestion from when passing a suggestion ID\&. Defaults to -\fBorigin\fR\&. -.RE -.SH "ENVIRONMENT VARIABLES" -.PP -GITHUB_TOKEN -.RS 4 -A GitHub API token with the \(lqrepo\(rq permission\&. -.RE -.SH "EXAMPLES" -.sp -Suggestion references can be specified either as URLs: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ git sugpatch https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 -.fi -.if n \{\ -.RE -.\} -.sp -or as comment IDs: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ git sugpatch 459691747 -.fi -.if n \{\ -.RE -.\} -.sp -They can also be mixed: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ git sugpatch 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747 -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.sp -git\-sugapply(1) diff --git a/doc/git-sugpatch.1.txt b/doc/git-sugpatch.1.txt deleted file mode 100644 index c1513a4..0000000 --- a/doc/git-sugpatch.1.txt +++ /dev/null @@ -1,70 +0,0 @@ -git-sugpatch(1) -=============== - -NAME ----- -git-sugpatch - Show diffs for GitHub suggestions - -SYNOPSIS --------- -'git sugpatch' [options] ... - -DESCRIPTION ------------ -Show the diffs of the given GitHub suggestion references. - -A suggestion reference is either a URL to the comment, or its ID. - -OPTIONS -------- ---github-token=:: - A GitHub API token with the “repo” permission. This can also be set - with `githubSuggestion.githubToken` or the `GITHUB_TOKEN` - environment variable. - --h, --help:: - Print usage help. - ---remote=:: - The remote to use to fetch the suggestion from when passing a - suggestion ID. This can also be set with `githubSuggestion.remote`. - Defaults to `origin`. - --V, --version:: - Print the program version. - -CONFIGURATION -------------- -Configuration options can be specified either as command line options, -or in the Git config. Command line options take precedence. - -githubSuggestion.githubToken:: - A GitHub API token with the “repo” permission. This will override - the `GITHUB_TOKEN` environment variable. - -githubSuggestion.remote:: - The remote to use to fetch the suggestion from when passing a - suggestion ID. Defaults to `origin`. - -ENVIRONMENT VARIABLES ---------------------- -GITHUB_TOKEN:: - A GitHub API token with the “repo” permission. - -EXAMPLES --------- -Suggestion references can be specified either as URLs: - - $ git sugpatch https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 - -or as comment IDs: - - $ git sugpatch 459691747 - -They can also be mixed: - - $ git sugpatch 459692838 https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 - -SEE ALSO --------- -git-sugapply(1) 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] ...", + "usage: git sugdiff [options] ...", ) { 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 . - - -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] ...", - ) { - 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); - }, - ); -} -- cgit v1.2.3