azdo-cli 0.22.0-develop.868 → 0.22.0-develop.875

package/README.md

@@ -45,6 +45,7 @@ azdo config set credentialStore dpapi --copy-credentials
 
 # Read a work item
 azdo get-item 12345
+azdo get-item 12345 --json   # machine-readable: identities, tags and all relations incl. pull requests
 
 # Download images embedded in a work item's rich-text fields (opt-in)
 azdo get-item 12345 --download-images                       # saved to the system temp dir

package/dist/index.js

@@ -475,6 +475,9 @@ var DEFAULT_FIELDS = [
   "System.State",
   "System.WorkItemType",
   "System.AssignedTo",
+  "System.CreatedBy",
+  "System.CreatedDate",
+  "System.Tags",
   "System.Description",
   "Microsoft.VSTS.Common.AcceptanceCriteria",
   "Microsoft.VSTS.TCM.ReproSteps",
@@ -809,6 +812,30 @@ async function getOrgFieldNames(context, cred) {
   const data = await response.json();
   return (data.value ?? []).map((f) => f.referenceName);
 }
+function toIdentity(ref) {
+  if (!ref) return null;
+  return {
+    displayName: ref.displayName ?? null,
+    uniqueName: ref.uniqueName ?? null,
+    id: ref.id ?? null
+  };
+}
+var PULL_REQUEST_ARTIFACT = /^vstfs:\/\/\/Git\/PullRequestId\/(.+)$/i;
+function mapRelations(relations) {
+  return (relations ?? []).map((r) => {
+    const entry = { rel: r.rel, name: r.attributes?.name ?? null, url: r.url };
+    const workItemMatch = /\/workItems\/(\d+)$/i.exec(r.url);
+    if (workItemMatch) entry.workItemId = Number(workItemMatch[1]);
+    const prMatch = PULL_REQUEST_ARTIFACT.exec(r.url);
+    if (prMatch) {
+      const [projectId, repositoryId, prId] = prMatch[1].split(/%2F|\//i);
+      if (projectId && repositoryId && /^\d+$/.test(prId ?? "")) {
+        entry.pullRequest = { id: Number(prId), repositoryId, projectId };
+      }
+    }
+    return entry;
+  });
+}
 function buildCombinedDescription(fields) {
   const parts = [];
   if (fields["System.Description"]) {
@@ -864,6 +891,11 @@ async function getWorkItem(context, id, cred, extraFields) {
     state: data.fields["System.State"],
     type: data.fields["System.WorkItemType"],
     assignedTo: data.fields["System.AssignedTo"]?.displayName ?? null,
+    assignedToIdentity: toIdentity(data.fields["System.AssignedTo"]),
+    createdBy: toIdentity(data.fields["System.CreatedBy"]),
+    createdDate: data.fields["System.CreatedDate"] ?? null,
+    tags: parseTags(data.fields["System.Tags"]),
+    relations: mapRelations(relationsData.relations),
     description: buildCombinedDescription(data.fields),
     areaPath: data.fields["System.AreaPath"],
     iterationPath: data.fields["System.IterationPath"],
@@ -2007,6 +2039,20 @@ function convertRichText(html, markdown) {
   if (!html) return "";
   return markdown ? toMarkdown(html) : stripHtml(html);
 }
+function toJsonDocument(workItem) {
+  return {
+    id: workItem.id,
+    title: workItem.title,
+    description: workItem.description ? toMarkdown(workItem.description) : "",
+    state: workItem.state,
+    tags: workItem.tags ?? [],
+    assignedTo: workItem.assignedToIdentity ?? null,
+    createdBy: workItem.createdBy ?? null,
+    createdDate: workItem.createdDate ?? null,
+    url: workItem.url,
+    relations: workItem.relations ?? []
+  };
+}
 function formatMarkdownField(fieldLabel, value) {
   if (value.includes("\n")) {
     return `${fieldLabel}:
@@ -2084,13 +2130,17 @@ function formatWorkItem(workItem, short, markdown = false) {
 }
 function createGetItemCommand() {
   const command = new Command("get-item");
-  command.description("Retrieve an Azure DevOps work item by ID").argument("<id>", "work item ID").option("--org <org>", "Azure DevOps organization").option("--project <project>", "Azure DevOps project").option("--short", "show abbreviated output").option("--fields <fields>", "comma-separated additional field reference names").option("--markdown", "convert rich text fields to markdown");
+  command.description("Retrieve an Azure DevOps work item by ID").argument("<id>", "work item ID").option("--org <org>", "Azure DevOps organization").option("--project <project>", "Azure DevOps project").option("--short", "show abbreviated output").option("--fields <fields>", "comma-separated additional field reference names").option("--markdown", "convert rich text fields to markdown").option("--json", "output { id, title, description (markdown), state, tags, assignedTo, createdBy, createdDate, url, relations } (assignedTo/createdBy: { displayName, uniqueName, id }; relations include pull requests)");
   addImageDownloadOptions(command);
   command.action(
     async (idStr, options) => {
       const id = parseWorkItemId(idStr);
       validateOrgProjectPair(options);
       const imageOptions = resolveImageDownloadOptionsOrExit(options);
+      if (options.json && (imageOptions.enabled || options.downloadImages || options.resizeImages !== void 0 || options.imagesPath !== void 0)) {
+        process.stderr.write("Error: --json cannot be combined with image download options.\n");
+        process.exit(1);
+      }
       let context;
       try {
         context = resolveContext(options);
@@ -2098,6 +2148,10 @@ function createGetItemCommand() {
         const scopedCfg = resolveScopedConfig(context.org);
         const fieldsList = options.fields === void 0 ? parseRequestedFields(scopedCfg.fields) : parseRequestedFields(options.fields);
         const workItem = await getWorkItem(context, id, credential, fieldsList);
+        if (options.json) {
+          process.stdout.write(JSON.stringify(toJsonDocument(workItem)) + "\n");
+          return;
+        }
         const markdownEnabled = options.markdown ?? scopedCfg.markdown ?? false;
         const output = formatWorkItem(workItem, options.short ?? false, markdownEnabled);
         process.stdout.write(output + "\n");

package/package.json

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