azdo-cli 0.2.0-develop.65 → 0.2.0-develop.71

package/README.md

@@ -53,7 +53,7 @@ azdo set-state 12345 "Active"
 
 | Command | Purpose | Common Flags |
 | --- | --- | --- |
-| `azdo get-item <id>` | Read a work item | `--short`, `--fields`, `--org`, `--project` |
+| `azdo get-item <id>` | Read a work item | `--short`, `--fields`, `--markdown`, `--org`, `--project` |
 | `azdo set-state <id> <state>` | Change work item state | `--json`, `--org`, `--project` |
 | `azdo assign <id> [name]` | Assign or unassign owner | `--unassign`, `--json`, `--org`, `--project` |
 | `azdo set-field <id> <field> <value>` | Update any field | `--json`, `--org`, `--project` |
@@ -75,6 +75,12 @@ azdo get-item 12345 --short
 
 # Include extra fields for this call
 azdo get-item 12345 --fields "System.Tags,Microsoft.VSTS.Common.Priority"
+
+# Convert rich text fields to markdown
+azdo get-item 12345 --markdown
+
+# Disable markdown even if config is on
+azdo get-item 12345 --no-markdown
 ```
 
 ```bash
@@ -89,6 +95,14 @@ azdo assign 12345 --unassign
 azdo set-field 12345 System.Title "Updated title"
 ```
 
+### Markdown Display
+
+The `get-item` command can convert HTML rich-text fields to readable markdown. Resolution order:
+
+1. `--markdown` / `--no-markdown` flag (highest priority)
+2. Config setting: `azdo config set markdown true`
+3. Default: off (HTML stripped to plain text)
+
 ### Markdown Field Commands
 
 ```bash
@@ -114,6 +128,9 @@ azdo config list
 # Interactive setup
 azdo config wizard
 
+# Enable markdown display for all get-item calls
+azdo config set markdown true
+
 # Set/get/unset values
 azdo config set fields "System.Tags,Custom.Priority"
 azdo config get fields

package/dist/index.js

@@ -336,6 +336,13 @@ var SETTINGS = [
     type: "string[]",
     example: "System.Tags,Custom.Priority",
     required: false
+  },
+  {
+    key: "markdown",
+    description: "Convert rich text fields to markdown on display",
+    type: "boolean",
+    example: "true",
+    required: false
   }
 ];
 var VALID_KEYS = SETTINGS.map((s) => s.key);
@@ -369,7 +376,7 @@ function saveConfig(config) {
 }
 function validateKey(key) {
   if (!VALID_KEYS.includes(key)) {
-    throw new Error(`Unknown setting key "${key}". Valid keys: org, project, fields`);
+    throw new Error(`Unknown setting key "${key}". Valid keys: ${VALID_KEYS.join(", ")}`);
   }
 }
 function getConfigValue(key) {
@@ -382,6 +389,11 @@ function setConfigValue(key, value) {
   const config = loadConfig();
   if (value === "") {
     delete config[key];
+  } else if (key === "markdown") {
+    if (value !== "true" && value !== "false") {
+      throw new Error(`Invalid value "${value}" for markdown. Must be "true" or "false".`);
+    }
+    config.markdown = value === "true";
   } else if (key === "fields") {
     config.fields = value.split(",").map((s) => s.trim());
   } else {
@@ -420,6 +432,61 @@ function resolveContext(options) {
   );
 }
 
+// src/services/md-convert.ts
+import { NodeHtmlMarkdown } from "node-html-markdown";
+
+// src/services/html-detect.ts
+var HTML_TAG_REGEX = /<\/?([a-z][a-z0-9]*)\b/gi;
+var HTML_TAGS = /* @__PURE__ */ new Set([
+  "p",
+  "br",
+  "div",
+  "span",
+  "strong",
+  "em",
+  "b",
+  "i",
+  "u",
+  "a",
+  "ul",
+  "ol",
+  "li",
+  "h1",
+  "h2",
+  "h3",
+  "h4",
+  "h5",
+  "h6",
+  "table",
+  "tr",
+  "td",
+  "th",
+  "img",
+  "pre",
+  "code"
+]);
+function isHtml(content) {
+  let match;
+  HTML_TAG_REGEX.lastIndex = 0;
+  while ((match = HTML_TAG_REGEX.exec(content)) !== null) {
+    if (HTML_TAGS.has(match[1].toLowerCase())) {
+      return true;
+    }
+  }
+  return false;
+}
+
+// src/services/md-convert.ts
+function htmlToMarkdown(html) {
+  return NodeHtmlMarkdown.translate(html);
+}
+function toMarkdown(content) {
+  if (isHtml(content)) {
+    return htmlToMarkdown(content);
+  }
+  return content;
+}
+
 // src/services/command-helpers.ts
 function parseWorkItemId(idStr) {
   const id = Number.parseInt(idStr, 10);
@@ -508,7 +575,24 @@ function stripHtml(html) {
   text = text.replace(/\n{3,}/g, "\n\n");
   return text.trim();
 }
-function formatWorkItem(workItem, short) {
+function convertRichText(html, markdown) {
+  if (!html) return "";
+  return markdown ? toMarkdown(html) : stripHtml(html);
+}
+function formatExtraFields(extraFields, markdown) {
+  return Object.entries(extraFields).map(([refName, value]) => {
+    const fieldLabel = refName.includes(".") ? refName.split(".").pop() : refName;
+    const displayValue = markdown ? toMarkdown(value) : value;
+    return `${fieldLabel.padEnd(13)}${displayValue}`;
+  });
+}
+function summarizeDescription(text, label) {
+  const descLines = text.split("\n").filter((l) => l.trim() !== "");
+  const firstThree = descLines.slice(0, 3);
+  const suffix = descLines.length > 3 ? "\n..." : "";
+  return [`${label("Description:")}${firstThree.join("\n")}${suffix}`];
+}
+function formatWorkItem(workItem, short, markdown = false) {
   const lines = [];
   const label = (name) => name.padEnd(13);
   lines.push(`${label("ID:")}${workItem.id}`);
@@ -522,19 +606,12 @@ function formatWorkItem(workItem, short) {
   }
   lines.push(`${label("URL:")}${workItem.url}`);
   if (workItem.extraFields) {
-    for (const [refName, value] of Object.entries(workItem.extraFields)) {
-      const fieldLabel = refName.includes(".") ? refName.split(".").pop() : refName;
-      lines.push(`${fieldLabel.padEnd(13)}${value}`);
-    }
+    lines.push(...formatExtraFields(workItem.extraFields, markdown));
   }
   lines.push("");
-  const descriptionText = workItem.description ? stripHtml(workItem.description) : "";
+  const descriptionText = convertRichText(workItem.description, markdown);
   if (short) {
-    const descLines = descriptionText.split("\n").filter((l) => l.trim() !== "");
-    const firstThree = descLines.slice(0, 3);
-    const truncated = descLines.length > 3;
-    const descSummary = firstThree.join("\n") + (truncated ? "\n..." : "");
-    lines.push(`${label("Description:")}${descSummary}`);
+    lines.push(...summarizeDescription(descriptionText, label));
   } else {
     lines.push("Description:");
     lines.push(descriptionText);
@@ -543,7 +620,7 @@ function formatWorkItem(workItem, short) {
 }
 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").action(
+  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").action(
     async (idStr, options) => {
       const id = parseWorkItemId(idStr);
       validateOrgProjectPair(options);
@@ -553,7 +630,8 @@ function createGetItemCommand() {
         const credential = await resolvePat();
         const fieldsList = options.fields !== void 0 ? parseRequestedFields(options.fields) : parseRequestedFields(loadConfig().fields);
         const workItem = await getWorkItem(context, id, credential.pat, fieldsList);
-        const output = formatWorkItem(workItem, options.short ?? false);
+        const markdownEnabled = options.markdown ?? loadConfig().markdown ?? false;
+        const output = formatWorkItem(workItem, options.short ?? false, markdownEnabled);
         process.stdout.write(output + "\n");
       } catch (err) {
         handleCommandError(err, id, context, "read", false);
@@ -857,63 +935,6 @@ function createSetFieldCommand() {
 
 // src/commands/get-md-field.ts
 import { Command as Command7 } from "commander";
-
-// src/services/md-convert.ts
-import { NodeHtmlMarkdown } from "node-html-markdown";
-
-// src/services/html-detect.ts
-var HTML_TAG_REGEX = /<\/?([a-z][a-z0-9]*)\b/gi;
-var HTML_TAGS = /* @__PURE__ */ new Set([
-  "p",
-  "br",
-  "div",
-  "span",
-  "strong",
-  "em",
-  "b",
-  "i",
-  "u",
-  "a",
-  "ul",
-  "ol",
-  "li",
-  "h1",
-  "h2",
-  "h3",
-  "h4",
-  "h5",
-  "h6",
-  "table",
-  "tr",
-  "td",
-  "th",
-  "img",
-  "pre",
-  "code"
-]);
-function isHtml(content) {
-  let match;
-  HTML_TAG_REGEX.lastIndex = 0;
-  while ((match = HTML_TAG_REGEX.exec(content)) !== null) {
-    if (HTML_TAGS.has(match[1].toLowerCase())) {
-      return true;
-    }
-  }
-  return false;
-}
-
-// src/services/md-convert.ts
-function htmlToMarkdown(html) {
-  return NodeHtmlMarkdown.translate(html);
-}
-function toMarkdown(content) {
-  if (isHtml(content)) {
-    return htmlToMarkdown(content);
-  }
-  return content;
-}
-
-// src/commands/get-md-field.ts
 function createGetMdFieldCommand() {
   const command = new Command7("get-md-field");
   command.description("Get a work item field value, converting HTML to markdown").argument("<id>", "work item ID").argument("<field>", "field reference name (e.g., System.Description)").option("--org <org>", "Azure DevOps organization").option("--project <project>", "Azure DevOps project").action(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azdo-cli",
-  "version": "0.2.0-develop.65",
+  "version": "0.2.0-develop.71",
   "description": "Azure DevOps CLI tool",
   "type": "module",
   "bin": {