azdo-cli 0.19.0-feature-037-api-error-surfacing.701 → 0.19.0-feature-038-pr-update.706

package/README.md

@@ -15,7 +15,8 @@ Azure DevOps CLI focused on work item read/write workflows.
 - Attach a local file to a work item, or remove a named attachment (`add-attachment`, `delete-attachment`)
 - Read/write rich-text fields as markdown (`get-md-field`, `set-md-field`)
 - Download images embedded in rich-text fields, optionally resized for LLM use (`get-item`/`get-md-field` `--download-images`, `--resize-images`)
-- Check branch pull request status, open PRs to `develop` (optionally pre-filled from a repository-defined template), list PR comment threads for any PR (`--pr-number`), resolve/reopen threads, link/unlink work items, and add/remove required or optional reviewers — all from the CLI (`pr`)
+- Check branch pull request status, open PRs to `develop` (optionally pre-filled from a repository-defined template), update an existing PR's title or description (`pr update`), list PR comment threads for any PR (`--pr-number`), resolve/reopen threads, link/unlink work items, and add/remove required or optional reviewers — all from the CLI (`pr`)
+- Feed long PR titles, descriptions and comment bodies from a file or a pipe instead of the shell (`--title-file`, `--description-file`, `--file`; `-` reads standard input)
 - Persist org/project/default fields in local config (`config`)
 - List all fields of a work item (`list-fields`)
 - Authenticate per Azure DevOps organization with `azdo auth login` — OAuth (Microsoft Entra) by default, or a Personal Access Token via `--use-pat` (or the `AZDO_PAT` env var). Credentials are stored in the OS credential store. Inspect with `azdo auth status`, remove with `azdo auth logout`. Diagnose auth problems with `azdo auth diagnose`. See [docs/authentication.md](docs/authentication.md).
@@ -85,13 +86,22 @@ azdo pr comments edit 148 --file plan.md --pr-number 64        # rewrite it in p
 azdo pr comments reply 148 "Great suggestion, I'll address it."          # human-readable output
 azdo pr comments reply 148 "Done." --pr-number 64 --json                 # JSON: { pullRequestId, threadId, commentId, content }
 azdo pr comment-reply 148 "Done."  --pr-number 64                        # flat alias, identical behaviour
+git log -1 --format=%B | azdo pr comments add --file - --pr-number 64      # "-" reads standard input
 
 # Open a pull request — description from a repo template when you don't pass one
 azdo pr open --title "Fix the thing" --description "Because X was broken"
 azdo pr open --title "Fix the thing"   # uses docs/pull_request_template[/branches/<branch>].md if present
+azdo pr open --title "Fix the thing" --description-file body.md   # or --description-file - to pipe it in
 # The description plus the template must stay within Azure DevOps' 4000-character cap; over it,
 # the command says by how much and creates nothing. See docs/commands.md.
 
+# Fix a title or description after the fact — a PR is no longer write-once
+azdo pr update --pr-number 64 --title "A real title"        # description untouched
+azdo pr update --pr-number 64 --description-file body.md    # replaces literally; no template is prepended
+cat body.md | azdo pr edit --pr-number 64 --description-file -   # "edit" is an alias for "update"
+azdo pr update --pr-number 64 --title "A real title" --json  # { pullRequestId, title, description, url, noop, updatedFields }
+# Re-running with the values it already has writes nothing and reports "noop": true.
+
 # Link/unlink a work item, add/remove reviewers
 azdo pr work-items link 1234 --pr-number 64
 azdo pr work-items unlink 1234 --pr-number 64

package/dist/index.js

@@ -3750,6 +3750,28 @@ async function openPullRequest(context, repo, cred, sourceBranch, title, descrip
     pullRequest: mapPullRequest(context, repo, data)
   };
 }
+async function updatePullRequest(context, repo, cred, prId, fields) {
+  if (fields.description !== void 0 && fields.description.length > MAX_PR_DESCRIPTION_CHARS) {
+    const overflow = fields.description.length - MAX_PR_DESCRIPTION_CHARS;
+    throw new Error(
+      `DESCRIPTION_TOO_LONG: description is ${fields.description.length} characters, exceeding the Azure DevOps limit of ${MAX_PR_DESCRIPTION_CHARS} characters. Shorten the description by at least ${overflow} characters.`
+    );
+  }
+  const url = new URL(
+    `https://dev.azure.com/${encodeURIComponent(context.org)}/${encodeURIComponent(context.project)}/_apis/git/repositories/${encodeURIComponent(repo)}/pullrequests/${prId}`
+  );
+  url.searchParams.set("api-version", "7.1");
+  const response = await fetchWithErrors(url.toString(), {
+    method: "PATCH",
+    headers: {
+      ...authHeaders(cred),
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify(fields)
+  });
+  const data = await readJsonResponse(response);
+  return mapPullRequest(context, repo, data);
+}
 async function getPullRequestThreads(context, repo, cred, prId) {
   const url = new URL(
     `https://dev.azure.com/${encodeURIComponent(context.org)}/${encodeURIComponent(context.project)}/_apis/git/repositories/${encodeURIComponent(repo)}/pullRequests/${prId}/threads`
@@ -4107,6 +4129,27 @@ function writeContractError(line) {
   process.exitCode = 1;
 }
 var EMPTY_BODY_ERROR = "Comment text must not be empty. Pass the text inline or use --file <path>.";
+var STDIN_PATH = "-";
+function readTextSource(file) {
+  if (file === STDIN_PATH) {
+    try {
+      return readFileSync5(0, "utf-8");
+    } catch {
+      writeError("Cannot read standard input.");
+      return null;
+    }
+  }
+  if (!existsSync5(file)) {
+    writeError(`File not found: ${file}`);
+    return null;
+  }
+  try {
+    return readFileSync5(file, "utf-8");
+  } catch {
+    writeError(`Cannot read file: ${file}`);
+    return null;
+  }
+}
 function resolveCommentBody(inline, file, emptyMessage = EMPTY_BODY_ERROR) {
   if (inline !== void 0 && file !== void 0) {
     writeError("Cannot specify both inline text and --file.");
@@ -4114,16 +4157,11 @@ function resolveCommentBody(inline, file, emptyMessage = EMPTY_BODY_ERROR) {
   }
   let body;
   if (file !== void 0) {
-    if (!existsSync5(file)) {
-      writeError(`File not found: ${file}`);
-      return null;
-    }
-    try {
-      body = readFileSync5(file, "utf-8");
-    } catch {
-      writeError(`Cannot read file: ${file}`);
+    const read = readTextSource(file);
+    if (read === null) {
       return null;
     }
+    body = read;
   } else if (inline !== void 0) {
     body = inline;
   } else {
@@ -4137,6 +4175,33 @@ function resolveCommentBody(inline, file, emptyMessage = EMPTY_BODY_ERROR) {
   }
   return trimmed;
 }
+function resolveOptionalTextInput(inline, file, flag) {
+  if (inline !== void 0 && file !== void 0) {
+    writeError(`Cannot specify both --${flag} and --${flag}-file.`);
+    return null;
+  }
+  if (inline === void 0 && file === void 0) {
+    return void 0;
+  }
+  const label = flag === "title" ? "Title" : "Description";
+  const emptyMessage = `${label} must not be empty. Pass the text inline or use --${flag}-file <path>.`;
+  let value;
+  if (file !== void 0) {
+    const read = readTextSource(file);
+    if (read === null) {
+      return null;
+    }
+    value = read;
+  } else {
+    value = inline;
+  }
+  const trimmed = value.trim();
+  if (trimmed === "") {
+    writeError(emptyMessage);
+    return null;
+  }
+  return trimmed;
+}
 function parseNonNegativeInt(raw) {
   if (!/^\d+$/.test(raw)) {
     return null;
@@ -4392,11 +4457,34 @@ function handlePrOpenError(err, context) {
   }
   handlePrCommandError(err, context, "write");
 }
+function resolveOpenDescription(inline, file) {
+  if (inline !== void 0 && file !== void 0) {
+    writeError("Cannot specify both --description and --description-file.");
+    return null;
+  }
+  if (file !== void 0) {
+    const fromFile = readTextSource(file);
+    if (fromFile === null) {
+      return null;
+    }
+    const trimmed = fromFile.trim();
+    if (trimmed === "") {
+      writeError("Description must not be empty. Pass the text inline or use --description-file <path>.");
+      return null;
+    }
+    return trimmed;
+  }
+  const trimmedInline = inline?.trim();
+  return trimmedInline ? trimmedInline : void 0;
+}
 function createPrOpenCommand() {
   const command = new Command12("open");
   withCommonPrOptions(command).description("Open a pull request from the current branch to develop").option("--title <title>", "pull request title").option(
     "--description <description>",
     "pull request description; when omitted, a repository-defined pull request template is used if one exists (prepended by this text when both are present)"
+  ).option(
+    "--description-file <path>",
+    'read the description from a UTF-8 file instead of --description; "-" reads standard input'
   ).option("--json", "output JSON").action(async (options) => {
     validateOrgProjectPair(options);
     const title = options.title?.trim();
@@ -4404,8 +4492,10 @@ function createPrOpenCommand() {
       writeError("--title is required for pull request creation.");
       return;
     }
-    const trimmedDescription = options.description?.trim();
-    const description = trimmedDescription && trimmedDescription.length > 0 ? trimmedDescription : void 0;
+    const description = resolveOpenDescription(options.description, options.descriptionFile);
+    if (description === null) {
+      return;
+    }
     let context;
     try {
       const resolved = await resolvePrCommandContext(options);
@@ -4445,6 +4535,123 @@ ${result.pullRequest.url ?? "\u2014"}
   });
   return command;
 }
+function handlePrUpdateError(err, context) {
+  const message = err instanceof Error ? err.message : "";
+  if (message.startsWith("DESCRIPTION_TOO_LONG: ")) {
+    writeError(message.slice("DESCRIPTION_TOO_LONG: ".length));
+    return;
+  }
+  handlePrCommandError(err, context, "write");
+}
+function joinFieldNames(fields) {
+  return fields.join(" and ");
+}
+function resolveRequestedFields(options) {
+  if (options.titleFile === STDIN_PATH && options.descriptionFile === STDIN_PATH) {
+    writeError('Cannot read standard input twice; only one of --title-file and --description-file may be "-".');
+    return null;
+  }
+  const title = resolveOptionalTextInput(options.title, options.titleFile, "title");
+  if (title === null) {
+    return null;
+  }
+  const description = resolveOptionalTextInput(options.description, options.descriptionFile, "description");
+  if (description === null) {
+    return null;
+  }
+  if (title === void 0 && description === void 0) {
+    writeError("pr update requires at least one of --title, --title-file, --description or --description-file.");
+    return null;
+  }
+  return { title, description };
+}
+function diffRequestedFields(requested, current) {
+  const fields = {};
+  const updatedFields = [];
+  const requestedFields = [];
+  if (requested.title !== void 0) {
+    requestedFields.push("title");
+    if (requested.title !== current.title) {
+      fields.title = requested.title;
+      updatedFields.push("title");
+    }
+  }
+  if (requested.description !== void 0) {
+    requestedFields.push("description");
+    if (requested.description !== (current.description ?? "")) {
+      fields.description = requested.description;
+      updatedFields.push("description");
+    }
+  }
+  return { fields, updatedFields, requestedFields };
+}
+async function runPrUpdate(options) {
+  const requested = resolveRequestedFields(options);
+  if (requested === null) {
+    return;
+  }
+  let context;
+  try {
+    const target = await resolvePullRequestTarget(options);
+    if (target === null) {
+      return;
+    }
+    context = target.context;
+    const current = target.pullRequest;
+    const { fields, updatedFields, requestedFields } = diffRequestedFields(requested, current);
+    if (updatedFields.length === 0) {
+      const noopResult = {
+        pullRequestId: current.id,
+        title: current.title,
+        description: current.description ?? null,
+        url: current.url,
+        noop: true,
+        updatedFields: []
+      };
+      if (options.json) {
+        process.stdout.write(`${JSON.stringify(noopResult, null, 2)}
+`);
+        return;
+      }
+      process.stdout.write(
+        `Pull request #${current.id} already has the requested ${joinFieldNames(requestedFields)}; nothing to update.
+`
+      );
+      return;
+    }
+    const updated = await updatePullRequest(target.context, target.repo, target.pat, current.id, fields);
+    const result = {
+      pullRequestId: updated.id,
+      title: updated.title,
+      description: updated.description ?? null,
+      url: updated.url,
+      noop: false,
+      updatedFields
+    };
+    if (options.json) {
+      process.stdout.write(`${JSON.stringify(result, null, 2)}
+`);
+      return;
+    }
+    process.stdout.write(
+      `Updated pull request #${updated.id} (${updatedFields.join(", ")}).
+${updated.url ?? "\u2014"}
+`
+    );
+  } catch (err) {
+    handlePrUpdateError(err, context);
+  }
+}
+function createPrUpdateCommand() {
+  const command = new Command12("update");
+  withCommonPrOptions(configureUnwrappedHelp(command)).alias("edit").description("Update a pull request's title and/or description").option("--pr-number <N>", PR_NUMBER_HELP).option("--title <title>", "new pull request title").option("--title-file <path>", 'read the new title from a UTF-8 file; "-" reads standard input').option(
+    "--description <description>",
+    'new pull request description; REPLACES the existing description literally \u2014 no repository pull request template is looked up or prepended, unlike "azdo pr open"'
+  ).option("--description-file <path>", 'read the new description from a UTF-8 file; "-" reads standard input').option("--json", "output JSON").action(async (_options, command2) => {
+    await runPrUpdate(mergedPrOptions(command2));
+  });
+  return command;
+}
 function createPrCommentsCommand() {
   const command = new Command12("comments");
   withCommonPrOptions(configureUnwrappedHelp(command)).description("List pull request comment threads for the current branch").option("--pr-number <N>", PR_NUMBER_HELP).option("--hide-resolved", "hide threads whose status is resolved / won't fix / closed / by design").option("--exclude-resolved", "alias of --hide-resolved: exclude resolved / won't fix / closed / by design threads").option("--code-related-only", "show only threads anchored to a file/line; omit general discussion threads").option("--exclude-system", "omit Azure DevOps system comments (branch updates, reviewer votes, build events)").option("--max-chars <N>", "truncate each comment body to N characters (0 = no limit, the default)").option("--thread <id>", "show only the thread with this numeric id; fails when the pull request has no such thread").option("--contains <text>", "show only threads holding a comment that contains this literal, case-sensitive substring (matched before --max-chars truncates)").option("--json", "output JSON").action(async (options) => {
@@ -5224,6 +5431,7 @@ function createPrCommand() {
   command.addCommand(createPrListCommand());
   command.addCommand(createPrStatusCommand());
   command.addCommand(createPrOpenCommand());
+  command.addCommand(createPrUpdateCommand());
   command.addCommand(createPrCommentsCommand());
   command.addCommand(createPrCommentResolveCommand());
   command.addCommand(createPrCommentReopenCommand());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azdo-cli",
-  "version": "0.19.0-feature-037-api-error-surfacing.701",
+  "version": "0.19.0-feature-038-pr-update.706",
   "description": "Azure DevOps CLI tool",
   "type": "module",
   "bin": {