baton-issue-tracker 1.4.0 → 1.6.0

package/source/commands/view.js

@@ -1,9 +1,10 @@
 // list.js
 // AI was consulted for some portions of this file.
 // view command which allows user to view all data fields for an issue 
-// Usage: baton view <id>>
+// Usage: baton view <id> [--json]
 
 import { getIssue } from '../services/issuesService.js';
+import { hasFlag, renderOutput, serializeIssue } from '../util.js';
 
 /**
  * Displays all issue fields for a given id #
@@ -11,12 +12,15 @@ import { getIssue } from '../services/issuesService.js';
  * @returns {Promise<number>} The exit code: 0 is success, 1 is error.
  */
 export async function run(args) {
+    const isJson = hasFlag(args, '--json');
+    const idArgs = args.filter((arg) => arg !== '--json');
+
     // checks if id # argument is empty
-    if (args.length == 0) {
+    if (idArgs.length == 0) {
         throw new Error(`Invalid input: Missing Issue ID.\nUsage: baton view <id>`);
     }
 
-    const id = args.join(' ');
+    const id = idArgs.join(' ');
 
     // checks if ID # argument isn't a number
     if (isNaN(id)) {
@@ -25,18 +29,24 @@ export async function run(args) {
 
     try {
         const issue = await getIssue(id);
-
-        if (!issue) {
-            console.log(`No issue with ID #"${issue}" was found.`);
-            return 0;
-        }
-
-        console.log("");
-        Object.entries(issue).forEach(([key, value]) => {
-            console.log(`${key}: ${value}`);
+        const envelope = {
+            status: 'success',
+            issue: issue ? serializeIssue(issue) : null,
+        };
+
+        renderOutput(isJson, envelope, () => {
+            if (!issue) {
+                console.log(`No issue with ID #"${issue}" was found.`);
+                return;
+            }
+
+            console.log('');
+            Object.entries(issue).forEach(([key, value]) => {
+                console.log(`${key}: ${value}`);
+            });
+            console.log('');
         });
 
-        console.log("");
         return 0;
     } catch (error) {
         console.error("Error: Failed to retrieve data.");

package/source/util.js

@@ -189,6 +189,67 @@ export function reportTrackerNotReady() {
   console.error('Run `baton init` first.');
 }
 
+/**
+ * Converts DB-style enum values to lowercase snake_case for JSON output.
+ * e.g. "In-Progress" → "in_progress"
+ * @param {string | null | undefined} value
+ * @returns {string | null}
+ */
+function toJsonEnum(value) {
+  return value?.toLowerCase().replace(/-/g, '_') ?? null;
+}
+
+/**
+ * Normalizes a DB row or Issue instance into a stable JSON-friendly shape.
+ * All commands should serialize through this before building their envelope.
+ * @param {object} issue
+ * @returns {object}
+ */
+export function serializeIssue(issue) {
+  return {
+    id: issue.id,
+    title: issue.title,
+    status: toJsonEnum(issue.status),
+    priority: toJsonEnum(issue.priority),
+    description: issue.description ?? null,
+    token_limit: issue.tokenLimit ?? issue.token_limit ?? null,
+    attempt_num: issue.attemptNum ?? issue.attempt_num ?? 0,
+    created_at: issue.createdAt ?? issue.created_at ?? null,
+    last_updated: issue.lastUpdated ?? issue.last_updated ?? null,
+    assignees: issue.assignees ?? null,
+  };
+}
+
+/**
+ * Centralized output renderer.
+ * If isJson is true, outputs the envelope as JSON.
+ * Otherwise, runs the human-readable callback.
+ * @param {boolean} isJson - Whether the user passed the --json flag
+ * @param {object} envelope - Structured response payload (e.g. { status, issues })
+ * @param {Function} humanOutput - Callback for human terminal styling
+ */
+export function renderOutput(isJson, envelope, humanOutput) {
+  if (isJson) {
+    console.log(JSON.stringify(envelope, null, 2));
+    return;
+  }
+  humanOutput(envelope);
+}
+
+/**
+ * Prints an error in JSON or plain text depending on output mode.
+ * @param {boolean} isJson
+ * @param {string} message
+ * @param {string} [code='ERROR']
+ */
+export function renderError(isJson, message, code = 'ERROR') {
+  if (isJson) {
+    console.error(JSON.stringify({ status: 'error', code, message }));
+    return;
+  }
+  console.error(`Error: ${message}`);
+}
+
 /**
  * Configuration for table column widths.
  */