Skip to content

feat: add pr edit command #52

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

Merged
hex2dec merged 1 commit into from
Mar 24, 2026
Merged

feat: add pr edit command #52

Show file tree
Hide file tree
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
197 changes: 194 additions & 3 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::issue::{
IssueStateFilter, IssueViewRequest,
};
use crate::pr::{
PrCheckoutRequest, PrCommentRequest, PrCreateRequest, PrListRequest, PrService,
PrCheckoutRequest, PrCommentRequest, PrCreateRequest, PrEditRequest, PrListRequest, PrService,
PrStatusRequest, PrTextSource, PrViewRequest,
};
use crate::repo::{CloneTransport, RepoCloneRequest, RepoService, RepoViewRequest};
Expand Down Expand Up @@ -101,6 +101,7 @@ fn run_pr(args: &[String]) -> Result<CommandOutcome, CommandError> {
"checkout" => execute_parsed(parse_pr_checkout_args(rest), |request| pr.checkout(request)),
"comment" => execute_parsed(parse_pr_comment_args(rest), |request| pr.comment(request)),
"create" => execute_parsed(parse_pr_create_args(rest), |request| pr.create(request)),
"edit" => execute_parsed(parse_pr_edit_args(rest), |request| pr.edit(request)),
"list" => execute_parsed(parse_pr_list_args(rest), |request| pr.list(request)),
"status" => execute_parsed(parse_pr_status_args(rest), |request| pr.status(request)),
"view" => execute_parsed(parse_pr_view_args(rest), |request| pr.view(request)),
Expand Down Expand Up @@ -206,6 +207,10 @@ fn resolve_help_topic(path: &[String]) -> Option<HelpTopic> {
text_command: pr_create_command,
json: pr_create_help_json,
}),
["pr", "edit"] => Some(HelpTopic {
text_command: pr_edit_command,
json: pr_edit_help_json,
}),
["pr", "list"] => Some(HelpTopic {
text_command: pr_list_command,
json: pr_list_help_json,
Expand Down Expand Up @@ -636,6 +641,83 @@ fn parse_pr_create_args(args: &[String]) -> Result<ParseOutcome<PrCreateRequest>
})
}

fn parse_pr_edit_args(args: &[String]) -> Result<ParseOutcome<PrEditRequest>, CommandError> {
map_parsed(parse_matches(pr_edit_command(), args), |matches| {
let output = output_format(&matches);
let repo = last_value(&matches, "repo");
let title = last_value(&matches, "title");
let state = match last_value(&matches, "state") {
Some(value) => Some(parse_pr_edit_state(&value)?),
None => None,
};
let draft_count = flag_count(&matches, "draft");
let ready_count = flag_count(&matches, "ready");
let body_values = values(&matches, "body");
let body_file_values = values(&matches, "body_file");
let positionals = values(&matches, "positionals");

let Some(number) = positionals.first() else {
return Err(CommandError::usage(
"pr edit requires a pull request number",
));
};

if positionals.len() > 1 {
return Err(CommandError::usage(
"pr edit accepts exactly one pull request number",
));
}

if body_values.len() + body_file_values.len() > 1 {
return Err(CommandError::usage(
"provide only one of --body or --body-file",
));
}

if draft_count + ready_count > 1 {
return Err(CommandError::usage(
"provide only one of --draft or --ready",
));
}

let body = body_values
.last()
.map(|value| PrTextSource::Inline(value.clone()))
.or_else(|| {
body_file_values
.last()
.map(|value| PrTextSource::File(value.clone()))
});
let draft = if draft_count == 1 {
Some(true)
} else if ready_count == 1 {
Some(false)
} else {
None
};

if title.is_none() && body.is_none() && state.is_none() && draft.is_none() {
return Err(CommandError::usage(
"pr edit requires at least one of --title, --body, --body-file, --state, --draft, or --ready",
));
}

let number = number.parse::<u64>().map_err(|_| {
CommandError::usage("invalid pull request number: expected a positive integer")
})?;

Ok(PrEditRequest {
output,
repo,
number,
title,
body,
state,
draft,
})
})
}

fn parse_pr_checkout_args(
args: &[String],
) -> Result<ParseOutcome<PrCheckoutRequest>, CommandError> {
Expand Down Expand Up @@ -825,10 +907,11 @@ fn issue_help_command() -> Command {

fn pr_help_command() -> Command {
base_command("pr", "gitee pr")
.about("View, create, comment on, and check out pull requests")
.about("View, create, edit, comment on, and check out pull requests")
.subcommand(pr_checkout_command())
.subcommand(pr_comment_command())
.subcommand(pr_create_command())
.subcommand(pr_edit_command())
.subcommand(pr_list_command())
.subcommand(pr_status_command())
.subcommand(pr_view_command())
Expand Down Expand Up @@ -1099,6 +1182,48 @@ fn pr_create_command() -> Command {
))
}

fn pr_edit_command() -> Command {
base_command("edit", "gitee pr edit")
.about("Edit an existing pull request")
.arg(json_flag())
.arg(repo_option())
.arg(string_option(
"title",
"title",
"TITLE",
"Replace the pull request title",
))
.arg(string_option(
"body",
"body",
"BODY",
"Replace the pull request body text",
))
.arg(string_option(
"body_file",
"body-file",
"PATH",
"Read the pull request body text from a file",
))
.arg(string_option(
"state",
"state",
"STATE",
"Change pull request state: open or closed",
))
.arg(count_flag(
"draft",
"draft",
"Mark the pull request as draft",
))
.arg(count_flag(
"ready",
"ready",
"Mark the pull request as ready",
))
.arg(positionals_arg("positionals", "PR", "Pull request number"))
}

fn pr_checkout_command() -> Command {
base_command("checkout", "gitee pr checkout")
.about("Fetch and check out a pull request head branch")
Expand Down Expand Up @@ -1510,12 +1635,13 @@ fn pr_help_json() -> serde_json::Value {
help_group_json(
"pr",
"pr",
"View, create, comment on, and check out pull requests",
"View, create, edit, comment on, and check out pull requests",
"gh pr",
vec![
pr_checkout_help_json(),
pr_comment_help_json(),
pr_create_help_json(),
pr_edit_help_json(),
pr_list_help_json(),
pr_status_help_json(),
pr_view_help_json(),
Expand Down Expand Up @@ -1634,6 +1760,62 @@ fn pr_create_help_json() -> serde_json::Value {
)
}

fn pr_edit_help_json() -> serde_json::Value {
help_command_json(
"edit",
"pr edit",
"Edit an existing pull request",
"gh pr edit",
true,
"required",
true,
true,
false,
vec![
help_option_json("--json", None, "Output machine-readable JSON", false),
repo_option_json(),
help_option_json(
"--title",
Some("TITLE"),
"Replace the pull request title",
false,
),
help_option_json(
"--body",
Some("BODY"),
"Replace the pull request body text",
false,
),
help_option_json(
"--body-file",
Some("PATH"),
"Read the pull request body text from a file",
false,
),
help_option_json(
"--state",
Some("STATE"),
"Change pull request state: open or closed",
false,
),
help_option_json("--draft", None, "Mark the pull request as draft", false),
help_option_json("--ready", None, "Mark the pull request as ready", false),
],
vec![help_argument_json("pr", "PR", "Pull request number", true)],
vec!["--body", "--body-file"],
vec![
"gitee pr edit 42 --repo octo/demo --title \"Updated title\" --json",
"gitee pr edit 42 --body-file ./body.md --state open --ready --json",
],
vec![
"Provide at least one of --title, --body, --body-file, --state, --draft, or --ready.",
"Provide at most one of --body or --body-file.",
"Provide at most one of --draft or --ready.",
"When --repo is omitted, the command can infer the repository from local git context.",
],
)
}

fn pr_list_help_json() -> serde_json::Value {
help_command_json(
"list",
Expand Down Expand Up @@ -1941,6 +2123,15 @@ fn parse_pr_state(value: &str) -> Result<String, CommandError> {
}
}

fn parse_pr_edit_state(value: &str) -> Result<String, CommandError> {
match value {
"open" | "closed" => Ok(value.to_string()),
_ => Err(CommandError::usage(
"invalid value for --state: expected open or closed",
)),
}
}

fn parse_limit(value: &str) -> Result<usize, CommandError> {
let parsed = value.parse::<usize>().map_err(|_| {
CommandError::usage("invalid value for --limit: expected a positive integer")
Expand Down
71 changes: 71 additions & 0 deletions src/gitee_api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ pub struct CreatePullRequest<'a> {
pub body: Option<&'a str>,
}

pub struct UpdatePullRequest<'a> {
pub title: Option<&'a str>,
pub body: Option<&'a str>,
pub state: Option<&'a str>,
pub draft: Option<bool>,
}

#[derive(Serialize)]
struct CreatePullRequestPayload<'a> {
access_token: &'a str,
Expand Down Expand Up @@ -547,6 +554,70 @@ impl GiteeClient {

Err(PullRequestError::UnexpectedStatus(status))
}

pub fn update_pull_request(
&self,
owner: &str,
repo: &str,
number: u64,
token: &str,
request: &UpdatePullRequest<'_>,
) -> Result<PullRequest, PullRequestError> {
let mut form = vec![("access_token", token.to_string())];

if let Some(title) = request.title {
form.push(("title", title.to_string()));
}

if let Some(body) = request.body {
form.push(("body", body.to_string()));
}

if let Some(state) = request.state {
form.push(("state", state.to_string()));
}

if let Some(draft) = request.draft {
form.push(("draft", draft.to_string()));
}

let response = self
.client
.patch(format!(
"{}/v5/repos/{owner}/{repo}/pulls/{number}",
self.base_url
))
.query(&[("access_token", token)])
.form(&form)
.send()
.map_err(PullRequestError::Transport)?;

if response.status().is_success() {
let pull_request = response
.json::<PullRequestResponse>()
.map_err(PullRequestError::Transport)?;
return Ok(pull_request.into_pull_request(owner, repo));
}

let status = response.status().as_u16();
let error_message = parse_api_error_message(response);

if status == 401 {
return Err(PullRequestError::InvalidToken);
}

if status == 404 {
return Err(PullRequestError::NotFound);
}

if let Some(message) = error_message {
return Err(PullRequestError::UnexpectedStatusWithMessage(
status, message,
));
}

Err(PullRequestError::UnexpectedStatus(status))
}
}

fn resolve_base_url(value: Option<String>) -> String {
Expand Down
Loading