azdo-cli 0.22.0-develop.807 → 0.22.0-develop.823

package/README.md

@@ -105,6 +105,7 @@ git log -1 --format=%B | azdo pr comments add --file - --pr-number 64      # "-"
 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
+azdo pr open --title "Fix the thing" --target master --source feature/x --draft --work-item 1234 --label bug   # --work-item/--label repeat; --json adds top-level id and url
 # 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.
 

package/dist/index.js

@@ -4130,43 +4130,26 @@ function formatContributions(composed) {
 function describeDescriptionBudget(composed) {
   return `description: ${composed.providedChars} provided + ${composed.separatorChars} separator + ${composed.templateChars} template = ${composed.totalChars} characters (client limit ${MAX_PR_DESCRIPTION_CHARS})`;
 }
-async function openPullRequest(context, repo, cred, sourceBranch, title, description) {
-  const existing = await listPullRequests(context, repo, cred, sourceBranch, {
-    status: "active",
-    targetBranch: "develop"
-  });
-  if (existing.length === 1) {
-    return {
-      branch: sourceBranch,
-      targetBranch: "develop",
-      created: false,
-      pullRequest: existing[0]
-    };
-  }
-  if (existing.length > 1) {
-    throw new Error(`AMBIGUOUS_PRS:${existing.map((pullRequest) => pullRequest.id).join(",")}`);
-  }
-  const repository = await getRepository(context, repo, cred);
-  const defaultBranch = repository.defaultBranch ? repository.defaultBranch.replace(/^refs\/heads\//, "") : "develop";
-  const template = await resolvePullRequestTemplate(context, repo, cred, defaultBranch, "develop");
-  const composed = composeDescription(description, template);
-  if (composed === null) {
-    throw new Error("DESCRIPTION_REQUIRED");
-  }
-  if (composed.totalChars > MAX_PR_DESCRIPTION_CHARS) {
-    throw new Error(`DESCRIPTION_TOO_LONG: ${formatDescriptionOverflow(composed)}`);
-  }
+function buildOpenPayload(sourceBranch, targetBranch, title, description, options) {
   const payload = {
     sourceRefName: `refs/heads/${sourceBranch}`,
-    targetRefName: "refs/heads/develop",
+    targetRefName: `refs/heads/${targetBranch}`,
     title,
-    description: composed.text
+    description
   };
+  if (options.isDraft) {
+    payload.isDraft = true;
+  }
+  if (options.labels && options.labels.length > 0) {
+    payload.labels = options.labels.map((name) => ({ name }));
+  }
+  return payload;
+}
+async function createPullRequest(context, repo, cred, payload, composed) {
   const url = new URL(
     `https://dev.azure.com/${encodeURIComponent(context.org)}/${encodeURIComponent(context.project)}/_apis/git/repositories/${encodeURIComponent(repo)}/pullrequests`
   );
   url.searchParams.set("api-version", "7.1");
-  let data;
   try {
     const response = await fetchWithErrors(url.toString(), {
       method: "POST",
@@ -4176,19 +4159,69 @@ async function openPullRequest(context, repo, cred, sourceBranch, title, descrip
       },
       body: JSON.stringify(payload)
     });
-    data = await readJsonResponse(response);
+    return await readJsonResponse(response);
   } catch (err) {
     if (err instanceof Error && err.message.startsWith("HTTP_400")) {
       throw new Error(`${err.message} | ${describeDescriptionBudget(composed)}`, { cause: err });
     }
     throw err;
   }
-  return {
+}
+function linkWorkItems(context, repo, cred, prId, workItemIds) {
+  return Promise.all(
+    workItemIds.map(
+      (id) => linkWorkItemToPullRequest(context, repo, cred, prId, id).then(
+        () => ({ id, linked: true }),
+        (err) => ({ id, linked: false, error: err instanceof Error ? err.message : String(err) })
+      )
+    )
+  );
+}
+async function openPullRequest(context, repo, cred, sourceBranch, title, description, options = {}) {
+  const targetBranch = options.targetBranch ?? "develop";
+  const existing = await listPullRequests(context, repo, cred, sourceBranch, {
+    status: "active",
+    targetBranch
+  });
+  if (existing.length === 1) {
+    return {
+      branch: sourceBranch,
+      targetBranch,
+      created: false,
+      pullRequest: existing[0]
+    };
+  }
+  if (existing.length > 1) {
+    throw new Error(`AMBIGUOUS_PRS:${existing.map((pullRequest2) => pullRequest2.id).join(",")}`);
+  }
+  const repository = await getRepository(context, repo, cred);
+  const defaultBranch = repository.defaultBranch ? repository.defaultBranch.replace(/^refs\/heads\//, "") : "develop";
+  const template = await resolvePullRequestTemplate(context, repo, cred, defaultBranch, targetBranch);
+  const composed = composeDescription(description, template);
+  if (composed === null) {
+    throw new Error("DESCRIPTION_REQUIRED");
+  }
+  if (composed.totalChars > MAX_PR_DESCRIPTION_CHARS) {
+    throw new Error(`DESCRIPTION_TOO_LONG: ${formatDescriptionOverflow(composed)}`);
+  }
+  const data = await createPullRequest(
+    context,
+    repo,
+    cred,
+    buildOpenPayload(sourceBranch, targetBranch, title, composed.text, options),
+    composed
+  );
+  const pullRequest = mapPullRequest(context, repo, data);
+  const result = {
     branch: sourceBranch,
-    targetBranch: "develop",
+    targetBranch,
     created: true,
-    pullRequest: mapPullRequest(context, repo, data)
+    pullRequest
   };
+  if (options.workItemIds && options.workItemIds.length > 0) {
+    result.workItems = await linkWorkItems(context, repo, cred, pullRequest.id, options.workItemIds);
+  }
+  return result;
 }
 async function updatePullRequest(context, repo, cred, prId, fields) {
   if (fields.description !== void 0 && fields.description.length > MAX_PR_DESCRIPTION_CHARS) {
@@ -4970,11 +5003,11 @@ function createPrStatusCommand() {
   });
   return command;
 }
-function handlePrOpenError(err, context) {
+function handlePrOpenError(err, context, targetBranch = "develop") {
   const message = err instanceof Error ? err.message : "";
   if (message.startsWith("AMBIGUOUS_PRS:")) {
     const ids = message.replace("AMBIGUOUS_PRS:", "").split(",").map((id) => `#${id}`).join(", ");
-    writeError(`Multiple active pull requests already exist for this branch targeting develop: ${ids}. Use pr status to review them.`);
+    writeError(`Multiple active pull requests already exist for this branch targeting ${targetBranch}: ${ids}. Use pr status to review them.`);
     return;
   }
   if (message === "DESCRIPTION_REQUIRED") {
@@ -4987,6 +5020,47 @@ function handlePrOpenError(err, context) {
   }
   handlePrCommandError(err, context, "write");
 }
+function collectOption(value, previous) {
+  return [...previous, value];
+}
+function stripHeadsPrefix(branch) {
+  return branch.trim().replace(/^refs\/heads\//, "");
+}
+function resolveOpenOptions(options) {
+  const targetBranch = options.target === void 0 ? "develop" : stripHeadsPrefix(options.target);
+  const source = options.source === void 0 ? void 0 : stripHeadsPrefix(options.source);
+  if (!targetBranch) {
+    writeError("--target must not be empty.");
+    return null;
+  }
+  if (source !== void 0 && !source) {
+    writeError("--source must not be empty.");
+    return null;
+  }
+  const workItemIds = [];
+  for (const raw of options.workItem ?? []) {
+    const id = Number(raw.trim());
+    if (!/^\d+$/.test(raw.trim()) || !Number.isSafeInteger(id) || id <= 0) {
+      writeError(`--work-item must be a positive integer, got "${raw}".`);
+      return null;
+    }
+    if (!workItemIds.includes(id)) {
+      workItemIds.push(id);
+    }
+  }
+  const labels = [];
+  for (const raw of options.label ?? []) {
+    const name = raw.trim();
+    if (!name) {
+      writeError("--label must not be empty.");
+      return null;
+    }
+    if (!labels.includes(name)) {
+      labels.push(name);
+    }
+  }
+  return { targetBranch, source, isDraft: options.draft === true, labels, workItemIds };
+}
 function resolveOpenDescription(inline, file) {
   if (inline !== void 0 && file !== void 0) {
     writeError("Cannot specify both --description and --description-file.");
@@ -5012,13 +5086,18 @@ function resolveOpenDescription(inline, file) {
 }
 function createPrOpenCommand() {
   const command = new Command13("open");
-  withCommonPrOptions(command).description("Open a pull request from the current branch to develop").option("--title <title>", "pull request title").option(
+  withCommonPrOptions(command).description("Open a pull request (default: 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) => {
+  ).option("--target <branch>", "target branch (default: develop); refs/heads/ prefix accepted").option("--source <branch>", "source branch (default: the current branch); no local checkout needed").option("--draft", "open the pull request as a draft").option(
+    "--work-item <id>",
+    "link a work item to the pull request (positive integer; repeatable)",
+    collectOption,
+    []
+  ).option("--label <label>", "add a label to the pull request (repeatable)", collectOption, []).option("--json", "output JSON; adds top-level id and url next to pullRequest").action(async (options) => {
     validateOrgProjectPair(options);
     const title = options.title?.trim();
     if (!title) {
@@ -5029,45 +5108,71 @@ function createPrOpenCommand() {
     if (description === null) {
       return;
     }
+    const openOptions = resolveOpenOptions(options);
+    if (openOptions === null) {
+      return;
+    }
     let context;
     try {
-      const resolved = await resolvePrCommandContext(options);
-      context = resolved.context;
-      if (resolved.branch === "develop") {
-        writeError("Pull request creation requires a source branch other than develop.");
+      const openBranch = openOptions.source ?? getCurrentBranch();
+      const target = openOptions.targetBranch;
+      if (openBranch === target) {
+        writeError(
+          target === "develop" ? "Pull request creation requires a source branch other than develop." : `Pull request creation requires a source branch other than the target branch (${target}).`
+        );
         return;
       }
-      const openBranch = resolved.branch;
+      const resolved = await resolvePrCommandContext(options, { requireBranch: false });
+      context = resolved.context;
       const result = await openPullRequest(
         resolved.context,
         resolved.repo,
         resolved.pat,
         openBranch,
         title,
-        description
+        description,
+        openOptions
       );
       if (options.json) {
-        process.stdout.write(`${JSON.stringify(result, null, 2)}
+        const output = { ...result, id: result.pullRequest.id, url: result.pullRequest.url };
+        process.stdout.write(`${JSON.stringify(output, null, 2)}
 `);
+        reportWorkItemLinkFailures(result);
         return;
       }
       if (result.created) {
         process.stdout.write(`Created pull request #${result.pullRequest.id}: ${result.pullRequest.title}
 ${result.pullRequest.url ?? "\u2014"}
 `);
+        reportWorkItemLinkFailures(result);
         return;
       }
       process.stdout.write(
-        `Active pull request already exists for ${resolved.branch} -> develop: #${result.pullRequest.id}
+        `Active pull request already exists for ${openBranch} -> ${result.targetBranch}: #${result.pullRequest.id}
 ${result.pullRequest.url ?? "\u2014"}
 `
       );
+      if (openOptions.isDraft || openOptions.labels?.length || openOptions.workItemIds?.length) {
+        const hint = openOptions.workItemIds?.length ? " Use pr work-items link to link a work item." : "";
+        process.stdout.write(
+          `--draft, --label and --work-item were not applied; the existing pull request was left unchanged.${hint}
+`
+        );
+      }
     } catch (err) {
-      handlePrOpenError(err, context);
+      handlePrOpenError(err, context, openOptions.targetBranch);
     }
   });
   return command;
 }
+function reportWorkItemLinkFailures(result) {
+  const failed = (result.workItems ?? []).filter((item) => !item.linked);
+  if (failed.length === 0) return;
+  const detail = failed.map((item) => `#${item.id} (${item.error ?? "unknown error"})`).join(", ");
+  writeError(
+    `Pull request #${result.pullRequest.id} was created but could not be linked to work item ${detail}. Retry with: azdo pr work-items link <id> --pr-number ${result.pullRequest.id}`
+  );
+}
 function handlePrUpdateError(err, context) {
   const message = err instanceof Error ? err.message : "";
   if (message.startsWith("DESCRIPTION_TOO_LONG: ")) {
@@ -6669,6 +6774,26 @@ async function listBuildArtifacts(context, cred, buildId) {
     };
   });
 }
+var INITIAL_BUFFER_BYTES = 8 * 1024 * 1024;
+async function collectBody(body, declared, onProgress, initialBytes = INITIAL_BUFFER_BYTES) {
+  const hint = Number.isSafeInteger(declared) && declared > 0 ? declared : Infinity;
+  let buffer = new Uint8Array(Math.min(hint, initialBytes));
+  let received = 0;
+  for await (const chunk of body) {
+    const needed = received + chunk.length;
+    if (needed > buffer.length) {
+      let capacity = Math.max(buffer.length * 2, needed);
+      if (hint >= needed) capacity = Math.min(capacity, hint);
+      const grown = new Uint8Array(capacity);
+      grown.set(buffer.subarray(0, received));
+      buffer = grown;
+    }
+    buffer.set(chunk, received);
+    received = needed;
+    onProgress?.(received);
+  }
+  return buffer.subarray(0, received);
+}
 async function downloadArtifactZip(cred, artifact, onProgress) {
   if (!artifact.downloadUrl) {
     throw new Error(`Artifact "${artifact.name}" (${artifact.type ?? "unknown type"}) has no download URL.`);
@@ -6682,14 +6807,8 @@ async function downloadArtifactZip(cred, artifact, onProgress) {
   if (!response.body) {
     return new Uint8Array(await response.arrayBuffer());
   }
-  const chunks = [];
-  let received = 0;
-  for await (const chunk of response.body) {
-    chunks.push(chunk);
-    received += chunk.length;
-    onProgress?.(received);
-  }
-  return Buffer.concat(chunks);
+  const declared = Number.parseInt(response.headers.get("content-length") ?? "", 10);
+  return collectBody(response.body, declared, onProgress);
 }
 
 // src/services/artifact-extract.ts
@@ -7142,10 +7261,18 @@ function grepWithContext(lines, grep, context) {
   }
   return selected;
 }
+var PROGRESS_BAR = /(?<![\d.])\d+(?:\.\d+)? [KMGT]?i?B \/ \d+(?:\.\d+)? [KMGT]?i?B \[/g;
+var LOG_TIMESTAMP = /^\d{4}-\d{2}-\d{2}T[\d:.]+Z /;
+function collapseGluedBars(line) {
+  const starts = [...line.matchAll(PROGRESS_BAR)].map((m) => m.index ?? 0);
+  if (starts.length < 2) return line;
+  const prefix = LOG_TIMESTAMP.exec(line)?.[0] ?? "";
+  return prefix + line.slice(starts.at(-1));
+}
 function collapseProgress(line) {
   let end = line.length;
   while (end > 0 && line[end - 1] === "\r") end--;
-  return line.slice(line.lastIndexOf("\r", end - 1) + 1, end);
+  return collapseGluedBars(line.slice(line.lastIndexOf("\r", end - 1) + 1, end));
 }
 function filterLogLines(content, filters) {
   const { grep, tail, head, contextLines: context } = filters;
@@ -7255,7 +7382,7 @@ function printSingleLog(content, filters) {
 }
 function createPipelineLogsCommand() {
   const command = new Command14("logs");
-  command.description("List a pipeline run's logs, or print a specific log with --log-id").argument("<run_id>", "pipeline run id").option("--org <org>", "Azure DevOps organization").option("--project <project>", "Azure DevOps project").option("--log-id <id>", "print the content of this log id").option("--step <name>", "print the log of the step/job matching this name (case-insensitive substring)").option("--tail <n>", "with --log-id/--step, print only the last N lines").option("--head <n>", "with --log-id/--step, print only the first N lines").option("--grep <pattern>", "with --log-id/--step, print only lines matching this regular expression").option("--context <n>", "with --grep, also print N lines around each match (grep -C)").option("--no-progress", "with --log-id/--step, collapse carriage-return progress redraws to their final state").option("--json", "output JSON").action(async (runIdRaw, options) => {
+  command.description("List a pipeline run's logs, or print a specific log with --log-id").argument("<run_id>", "pipeline run id").option("--org <org>", "Azure DevOps organization").option("--project <project>", "Azure DevOps project").option("--log-id <id>", "print the content of this log id").option("--step <name>", "print the log of the step/job matching this name (case-insensitive substring)").option("--tail <n>", "with --log-id/--step, print only the last N lines").option("--head <n>", "with --log-id/--step, print only the first N lines").option("--grep <pattern>", "with --log-id/--step, print only lines matching this regular expression").option("--context <n>", "with --grep, also print N lines around each match (grep -C)").option("--no-progress", "with --log-id/--step, collapse progress-bar redraws (carriage-return or glued into one line) to their final state").option("--json", "output JSON").action(async (runIdRaw, options) => {
     validateOrgProjectPair(options);
     const runId = parsePositiveId(runIdRaw);
     if (runId === null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azdo-cli",
-  "version": "0.22.0-develop.807",
+  "version": "0.22.0-develop.823",
   "description": "Azure DevOps CLI tool",
   "type": "module",
   "bin": {