@aaronshaf/plane 0.1.2 → 0.1.3

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "CLI for the Plane project management API",
   "keywords": [
     "plane",

package/scripts/check-coverage.ts

@@ -3,8 +3,8 @@
 import { execSync } from "child_process"
 
 const THRESHOLDS = {
-  lines: 90,
-  functions: 90,
+  lines: 98,
+  functions: 98,
 }
 
 console.log("Running tests with coverage...\n")

package/src/bin.ts

@@ -51,9 +51,10 @@ ALL SUBCOMMANDS
   labels list         List labels for a project
   members list        List members of a project
 
-FOR AI AGENTS
-  - All list commands output one record per line, tab-separated
-  - 'plane issue get PROJ-N' outputs full JSON — pipe to jq for field extraction
+FOR AI AGENTS / BOTS
+  - Add --json to any list command for JSON output (array of objects)
+  - Add --xml to any list command for XML output
+  - 'plane issue get PROJ-N' always outputs full JSON
   - Use PLANE_API_TOKEN / PLANE_HOST / PLANE_WORKSPACE env vars to avoid 'plane init'
   - Full Plane REST API reference (180+ endpoints):
     https://developers.plane.so/api-reference/introduction`,

package/src/commands/cycles.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { CyclesResponseSchema, CycleIssuesResponseSchema } from "../config.js"
 import { resolveProject, parseIssueRef, findIssueBySeq } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -19,6 +20,8 @@ export const cyclesList = Command.make("list", { project: projectArg }, ({ proje
     const { id } = yield* resolveProject(project)
     const raw = yield* api.get(`projects/${id}/cycles/`)
     const { results } = yield* decodeOrFail(CyclesResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No cycles found")
       return
@@ -47,6 +50,8 @@ export const cycleIssuesList = Command.make(
       const { key, id } = yield* resolveProject(project)
       const raw = yield* api.get(`projects/${id}/cycles/${cycleId}/cycle-issues/`)
       const { results } = yield* decodeOrFail(CycleIssuesResponseSchema, raw)
+      if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+      if (xmlMode) { yield* Console.log(toXml(results)); return }
       if (results.length === 0) {
         yield* Console.log("No issues in cycle")
         return

package/src/commands/intake.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { IntakeIssuesResponseSchema } from "../config.js"
 import { resolveProject } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -24,6 +25,8 @@ export const intakeList = Command.make("list", { project: projectArg }, ({ proje
     const { id } = yield* resolveProject(project)
     const raw = yield* api.get(`projects/${id}/intake-issues/`)
     const { results } = yield* decodeOrFail(IntakeIssuesResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No intake issues")
       return

package/src/commands/issue.ts

@@ -11,6 +11,7 @@ import {
   WorklogSchema,
 } from "../config.js"
 import { parseIssueRef, findIssueBySeq, getStateId, resolveProject } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const refArg = Args.text({ name: "ref" }).pipe(
   Args.withDescription("Issue reference, e.g. PROJ-29"),
@@ -142,6 +143,8 @@ export const issueActivity = Command.make("activity", { ref: refArg }, ({ ref })
     const issue = yield* findIssueBySeq(projectId, seq)
     const raw = yield* api.get(`projects/${projectId}/issues/${issue.id}/activities/`)
     const { results } = yield* decodeOrFail(ActivitiesResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No activity found")
       return
@@ -172,6 +175,8 @@ export const issueLinkList = Command.make("list", { ref: refArg }, ({ ref }) =>
     const issue = yield* findIssueBySeq(projectId, seq)
     const raw = yield* api.get(`projects/${projectId}/issues/${issue.id}/issue-links/`)
     const { results } = yield* decodeOrFail(IssueLinksResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No links")
       return
@@ -245,6 +250,8 @@ export const issueCommentsList = Command.make("list", { ref: refArg }, ({ ref })
     const issue = yield* findIssueBySeq(projectId, seq)
     const raw = yield* api.get(`projects/${projectId}/issues/${issue.id}/comments/`)
     const { results } = yield* decodeOrFail(CommentsResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No comments")
       return
@@ -320,6 +327,8 @@ export const issueWorklogsList = Command.make("list", { ref: refArg }, ({ ref })
     const issue = yield* findIssueBySeq(projectId, seq)
     const raw = yield* api.get(`projects/${projectId}/issues/${issue.id}/worklogs/`)
     const { results } = yield* decodeOrFail(WorklogsResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No worklogs")
       return

package/src/commands/issues.ts

@@ -5,6 +5,7 @@ import { IssuesResponseSchema } from "../config.js"
 import { formatIssue } from "../format.js"
 import { resolveProject } from "../resolve.js"
 import type { State } from "../config.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier — see 'plane projects list' for available identifiers"),
@@ -35,6 +36,8 @@ export const issuesList = Command.make(
             })
           : results
 
+      if (jsonMode) { yield* Console.log(JSON.stringify(filtered, null, 2)); return }
+      if (xmlMode) { yield* Console.log(toXml(filtered)); return }
       yield* Console.log(filtered.map((i) => formatIssue(i, key)).join("\n"))
     }),
 ).pipe(

package/src/commands/labels.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { LabelsResponseSchema, LabelSchema } from "../config.js"
 import { resolveProject } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -15,6 +16,8 @@ export const labelsList = Command.make("list", { project: projectArg }, ({ proje
     const { id } = yield* resolveProject(project)
     const raw = yield* api.get(`projects/${id}/labels/`)
     const { results } = yield* decodeOrFail(LabelsResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No labels found")
       return

package/src/commands/members.ts

@@ -2,11 +2,14 @@ import { Command } from "@effect/cli"
 import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { MembersResponseSchema } from "../config.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 export const membersList = Command.make("list", {}, () =>
   Effect.gen(function* () {
     const raw = yield* api.get("members/")
     const results = yield* decodeOrFail(MembersResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     const lines = results.map((m) => {
       const email = m.email ? `  <${m.email}>` : ""
       return `${m.display_name.padEnd(24)}${email}`

package/src/commands/modules.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { ModulesResponseSchema, ModuleIssuesResponseSchema } from "../config.js"
 import { resolveProject, parseIssueRef, findIssueBySeq } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -19,6 +20,8 @@ export const modulesList = Command.make("list", { project: projectArg }, ({ proj
     const { id } = yield* resolveProject(project)
     const raw = yield* api.get(`projects/${id}/modules/`)
     const { results } = yield* decodeOrFail(ModulesResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No modules found")
       return
@@ -45,6 +48,8 @@ export const moduleIssuesList = Command.make(
       const { key, id } = yield* resolveProject(project)
       const raw = yield* api.get(`projects/${id}/modules/${moduleId}/module-issues/`)
       const { results } = yield* decodeOrFail(ModuleIssuesResponseSchema, raw)
+      if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+      if (xmlMode) { yield* Console.log(toXml(results)); return }
       if (results.length === 0) {
         yield* Console.log("No issues in module")
         return

package/src/commands/pages.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { PagesResponseSchema, PageSchema } from "../config.js"
 import { resolveProject } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -15,6 +16,8 @@ export const pagesList = Command.make("list", { project: projectArg }, ({ projec
     const { id } = yield* resolveProject(project)
     const raw = yield* api.get(`projects/${id}/pages/`)
     const { results } = yield* decodeOrFail(PagesResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     if (results.length === 0) {
       yield* Console.log("No pages")
       return

package/src/commands/projects.ts

@@ -2,11 +2,14 @@ import { Command } from "@effect/cli"
 import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { ProjectsResponseSchema } from "../config.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 export const projectsList = Command.make("list", {}, () =>
   Effect.gen(function* () {
     const raw = yield* api.get("projects/")
     const { results } = yield* decodeOrFail(ProjectsResponseSchema, raw)
+    if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+    if (xmlMode) { yield* Console.log(toXml(results)); return }
     const lines = results.map(
       (p) => `${p.identifier.padEnd(6)}  ${p.id}  ${p.name}`,
     )

package/src/commands/states.ts

@@ -3,6 +3,7 @@ import { Console, Effect } from "effect"
 import { api, decodeOrFail } from "../api.js"
 import { StatesResponseSchema } from "../config.js"
 import { resolveProject } from "../resolve.js"
+import { jsonMode, xmlMode, toXml } from "../output.js"
 
 const projectArg = Args.text({ name: "project" }).pipe(
   Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
@@ -16,6 +17,8 @@ export const statesList = Command.make(
       const { id } = yield* resolveProject(project)
       const raw = yield* api.get(`projects/${id}/states/`)
       const { results } = yield* decodeOrFail(StatesResponseSchema, raw)
+      if (jsonMode) { yield* Console.log(JSON.stringify(results, null, 2)); return }
+      if (xmlMode) { yield* Console.log(toXml(results)); return }
       const lines = results.map(
         (s) => `${s.id}  ${s.group.padEnd(12)}  ${s.name}`,
       )

package/src/output.ts

@@ -0,0 +1,39 @@
+const jsonIdx = process.argv.indexOf("--json")
+const xmlIdx = process.argv.indexOf("--xml")
+
+export const jsonMode = jsonIdx !== -1
+export const xmlMode = xmlIdx !== -1
+
+if (jsonIdx !== -1) process.argv.splice(jsonIdx, 1)
+if (xmlIdx !== -1) process.argv.splice(xmlIdx, 1)
+
+function escapeXml(val: unknown): string {
+  return String(val ?? "")
+    .replace(/&/g, "&")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+}
+
+function toXmlItem(obj: unknown, tag = "item"): string {
+  if (obj === null || typeof obj !== "object") {
+    return `<${tag}>${escapeXml(obj)}</${tag}>`
+  }
+  const attrs = Object.entries(obj as Record<string, unknown>)
+    .filter(([, v]) => v === null || typeof v !== "object")
+    .map(([k, v]) => `${k}="${escapeXml(v)}"`)
+    .join(" ")
+  const children = Object.entries(obj as Record<string, unknown>)
+    .filter(([, v]) => v !== null && typeof v === "object")
+    .map(([k, v]) =>
+      Array.isArray(v)
+        ? `<${k}>${v.map((i) => toXmlItem(i)).join("")}</${k}>`
+        : toXmlItem(v, k),
+    )
+    .join("")
+  return `<${tag}${attrs ? " " + attrs : ""}>${children}</${tag}>`
+}
+
+export function toXml(results: readonly unknown[]): string {
+  return `<results>\n${results.map((r) => "  " + toXmlItem(r)).join("\n")}\n</results>`
+}

package/tests/output.test.ts

@@ -0,0 +1,78 @@
+import { describe, expect, it, beforeEach, afterEach } from "bun:test"
+import { toXml } from "@/output"
+
+describe("toXml", () => {
+  it("wraps results in <results> root element", () => {
+    const out = toXml([{ id: "1", name: "Foo" }])
+    expect(out).toStartWith("<results>")
+    expect(out).toEndWith("</results>")
+  })
+
+  it("renders each item as an <item> element with attributes", () => {
+    const out = toXml([{ id: "abc", name: "My Project" }])
+    expect(out).toContain('<item id="abc" name="My Project">')
+  })
+
+  it("renders an empty <results> for empty array", () => {
+    const out = toXml([])
+    expect(out).toBe("<results>\n\n</results>")
+  })
+
+  it("renders multiple items", () => {
+    const out = toXml([
+      { id: "1", name: "A" },
+      { id: "2", name: "B" },
+    ])
+    expect(out).toContain('id="1"')
+    expect(out).toContain('id="2"')
+  })
+
+  it("escapes & in attribute values", () => {
+    const out = toXml([{ name: "Canvas & Codegen" }])
+    expect(out).toContain("Canvas &amp; Codegen")
+    expect(out).not.toContain("Canvas & Codegen")
+  })
+
+  it("escapes < and > in attribute values", () => {
+    const out = toXml([{ name: "<tag>" }])
+    expect(out).toContain("&lt;tag&gt;")
+  })
+
+  it("escapes quotes in attribute values", () => {
+    const out = toXml([{ name: 'say "hi"' }])
+    expect(out).toContain("&quot;hi&quot;")
+  })
+
+  it("renders nested objects as child elements", () => {
+    const out = toXml([{ id: "1", state: { name: "Todo", group: "unstarted" } }])
+    expect(out).toContain("<state")
+    expect(out).toContain('name="Todo"')
+    expect(out).toContain('group="unstarted"')
+  })
+
+  it("renders nested arrays as child elements", () => {
+    const out = toXml([{ id: "1", tags: ["a", "b"] }])
+    expect(out).toContain("<tags>")
+    expect(out).toContain("</tags>")
+  })
+
+  it("handles null values as empty string in attributes", () => {
+    const out = toXml([{ id: "1", color: null }])
+    expect(out).toContain('color=""')
+  })
+})
+
+describe("argv stripping", () => {
+  it("removes --json from process.argv when present", async () => {
+    process.argv.push("--json-test-flag-xyz")
+    // The module is already loaded; test that toXml is a function (module loaded ok)
+    expect(typeof toXml).toBe("function")
+    process.argv.pop()
+  })
+
+  it("jsonMode and xmlMode are booleans", async () => {
+    const { jsonMode, xmlMode } = await import("@/output")
+    expect(typeof jsonMode).toBe("boolean")
+    expect(typeof xmlMode).toBe("boolean")
+  })
+})