@aaronshaf/plane 0.1.3 → 0.1.5

package/src/commands/pages.ts

@@ -1,66 +1,75 @@
-import { Command, Args } from "@effect/cli"
-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"
+import { Command, Args } from "@effect/cli";
+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)"),
-)
+	Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
+);
 
 // --- pages list ---
 
-export const pagesList = Command.make("list", { project: projectArg }, ({ project }) =>
-  Effect.gen(function* () {
-    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
-    }
-    const lines = results.map((p) => {
-      const updated = (p.updated_at ?? p.created_at).slice(0, 10)
-      return `${p.id}  ${updated}  ${p.name}`
-    })
-    yield* Console.log(lines.join("\n"))
-  }),
+export const pagesList = Command.make(
+	"list",
+	{ project: projectArg },
+	({ project }) =>
+		Effect.gen(function* () {
+			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;
+			}
+			const lines = results.map((p) => {
+				const updated = (p.updated_at ?? p.created_at).slice(0, 10);
+				return `${p.id}  ${updated}  ${p.name}`;
+			});
+			yield* Console.log(lines.join("\n"));
+		}),
 ).pipe(
-  Command.withDescription(
-    "List pages for a project. Shows page UUID, last updated date, and title.\n\nExample:\n  plane pages list PROJ",
-  ),
-)
+	Command.withDescription(
+		"List pages for a project. Shows page UUID, last updated date, and title.\n\nExample:\n  plane pages list PROJ",
+	),
+);
 
 // --- pages get ---
 
 const pageIdArg = Args.text({ name: "page-id" }).pipe(
-  Args.withDescription("Page UUID (from 'plane pages list')"),
-)
+	Args.withDescription("Page UUID (from 'plane pages list')"),
+);
 
 export const pagesGet = Command.make(
-  "get",
-  { project: projectArg, pageId: pageIdArg },
-  ({ project, pageId }) =>
-    Effect.gen(function* () {
-      const { id } = yield* resolveProject(project)
-      const raw = yield* api.get(`projects/${id}/pages/${pageId}/`)
-      const page = yield* decodeOrFail(PageSchema, raw)
-      yield* Console.log(JSON.stringify(page, null, 2))
-    }),
+	"get",
+	{ project: projectArg, pageId: pageIdArg },
+	({ project, pageId }) =>
+		Effect.gen(function* () {
+			const { id } = yield* resolveProject(project);
+			const raw = yield* api.get(`projects/${id}/pages/${pageId}/`);
+			const page = yield* decodeOrFail(PageSchema, raw);
+			yield* Console.log(JSON.stringify(page, null, 2));
+		}),
 ).pipe(
-  Command.withDescription(
-    "Print full JSON for a page including description_html.\n\nExample:\n  plane pages get PROJ <page-id>",
-  ),
-)
+	Command.withDescription(
+		"Print full JSON for a page including description_html.\n\nExample:\n  plane pages get PROJ <page-id>",
+	),
+);
 
 // --- pages (parent) ---
 
 export const pages = Command.make("pages").pipe(
-  Command.withDescription(
-    "Manage project pages (documentation). Subcommands: list, get\n\nExamples:\n  plane pages list PROJ\n  plane pages get PROJ <page-id>",
-  ),
-  Command.withSubcommands([pagesList, pagesGet]),
-)
+	Command.withDescription(
+		"Manage project pages (documentation). Subcommands: list, get\n\nExamples:\n  plane pages list PROJ\n  plane pages get PROJ <page-id>",
+	),
+	Command.withSubcommands([pagesList, pagesGet]),
+);

package/src/commands/projects.ts

@@ -1,27 +1,33 @@
-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"
+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}`,
-    )
-    yield* Console.log(lines.join("\n"))
-  }),
+	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}`,
+		);
+		yield* Console.log(lines.join("\n"));
+	}),
 ).pipe(
-  Command.withDescription(
-    "List all projects in the workspace. The IDENTIFIER column is what you pass to other commands (e.g. 'plane issues list PROJ').",
-  ),
-)
+	Command.withDescription(
+		"List all projects in the workspace. The IDENTIFIER column is what you pass to other commands (e.g. 'plane issues list PROJ').",
+	),
+);
 
 export const projects = Command.make("projects").pipe(
-  Command.withDescription("Manage projects."),
-  Command.withSubcommands([projectsList]),
-)
+	Command.withDescription("Manage projects."),
+	Command.withSubcommands([projectsList]),
+);

package/src/commands/states.ts

@@ -1,31 +1,37 @@
-import { Command, Options, Args } from "@effect/cli"
-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"
+import { Command, Options, Args } from "@effect/cli";
+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)"),
-)
+	Args.withDescription("Project identifier (e.g. PROJ, WEB, OPS)"),
+);
 
 export const statesList = Command.make(
-  "list",
-  { project: projectArg },
-  ({ project }) =>
-    Effect.gen(function* () {
-      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}`,
-      )
-      yield* Console.log(lines.join("\n"))
-    }),
-)
+	"list",
+	{ project: projectArg },
+	({ project }) =>
+		Effect.gen(function* () {
+			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}`,
+			);
+			yield* Console.log(lines.join("\n"));
+		}),
+);
 
 export const states = Command.make("states").pipe(
-  Command.withSubcommands([statesList]),
-)
+	Command.withSubcommands([statesList]),
+);

package/src/config.ts

@@ -1,217 +1,215 @@
-import { Schema } from "effect"
+import { Schema } from "effect";
 
 // --- Schemas ---
 
 export const StateSchema = Schema.Struct({
-  id: Schema.String,
-  name: Schema.String,
-  group: Schema.String,
-  color: Schema.optional(Schema.String),
-})
-export type State = typeof StateSchema.Type
+	id: Schema.String,
+	name: Schema.String,
+	group: Schema.String,
+	color: Schema.optional(Schema.String),
+});
+export type State = typeof StateSchema.Type;
 
 export const IssueSchema = Schema.Struct({
-  id: Schema.String,
-  sequence_id: Schema.Number,
-  name: Schema.String,
-  priority: Schema.String,
-  state: Schema.Union(Schema.String, StateSchema),
-  description_html: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Issue = typeof IssueSchema.Type
+	id: Schema.String,
+	sequence_id: Schema.Number,
+	name: Schema.String,
+	priority: Schema.String,
+	state: Schema.Union(Schema.String, StateSchema),
+	description_html: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Issue = typeof IssueSchema.Type;
 
 export const StatesResponseSchema = Schema.Struct({
-  results: Schema.Array(StateSchema),
-})
+	results: Schema.Array(StateSchema),
+});
 
 export const IssuesResponseSchema = Schema.Struct({
-  results: Schema.Array(IssueSchema),
-})
+	results: Schema.Array(IssueSchema),
+});
 
 export const LabelSchema = Schema.Struct({
-  id: Schema.String,
-  name: Schema.String,
-  color: Schema.optional(Schema.NullOr(Schema.String)),
-  parent: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Label = typeof LabelSchema.Type
+	id: Schema.String,
+	name: Schema.String,
+	color: Schema.optional(Schema.NullOr(Schema.String)),
+	parent: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Label = typeof LabelSchema.Type;
 
 export const LabelsResponseSchema = Schema.Struct({
-  results: Schema.Array(LabelSchema),
-})
+	results: Schema.Array(LabelSchema),
+});
 
 // Members endpoint returns a flat array (no results wrapper)
 export const MemberSchema = Schema.Struct({
-  id: Schema.String,
-  display_name: Schema.String,
-  email: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Member = typeof MemberSchema.Type
+	id: Schema.String,
+	display_name: Schema.String,
+	email: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Member = typeof MemberSchema.Type;
 
-export const MembersResponseSchema = Schema.Array(MemberSchema)
+export const MembersResponseSchema = Schema.Array(MemberSchema);
 
 export const CycleSchema = Schema.Struct({
-  id: Schema.String,
-  name: Schema.String,
-  status: Schema.optional(Schema.String),
-  start_date: Schema.optional(Schema.NullOr(Schema.String)),
-  end_date: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Cycle = typeof CycleSchema.Type
+	id: Schema.String,
+	name: Schema.String,
+	status: Schema.optional(Schema.String),
+	start_date: Schema.optional(Schema.NullOr(Schema.String)),
+	end_date: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Cycle = typeof CycleSchema.Type;
 
 export const CyclesResponseSchema = Schema.Struct({
-  results: Schema.Array(CycleSchema),
-})
+	results: Schema.Array(CycleSchema),
+});
 
 export const ProjectSchema = Schema.Struct({
-  id: Schema.String,
-  identifier: Schema.String,
-  name: Schema.String,
-  description: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Project = typeof ProjectSchema.Type
+	id: Schema.String,
+	identifier: Schema.String,
+	name: Schema.String,
+	description: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Project = typeof ProjectSchema.Type;
 
 export const ProjectsResponseSchema = Schema.Struct({
-  results: Schema.Array(ProjectSchema),
-})
+	results: Schema.Array(ProjectSchema),
+});
 
-export const ProjectsFlatResponseSchema = Schema.Array(ProjectSchema)
+export const ProjectsFlatResponseSchema = Schema.Array(ProjectSchema);
 
 export const ActivitySchema = Schema.Struct({
-  id: Schema.String,
-  actor_detail: Schema.optional(
-    Schema.Struct({
-      display_name: Schema.String,
-    }),
-  ),
-  field: Schema.optional(Schema.NullOr(Schema.String)),
-  old_value: Schema.optional(Schema.NullOr(Schema.String)),
-  new_value: Schema.optional(Schema.NullOr(Schema.String)),
-  verb: Schema.optional(Schema.String),
-  created_at: Schema.String,
-})
-export type Activity = typeof ActivitySchema.Type
+	id: Schema.String,
+	actor_detail: Schema.optional(
+		Schema.Struct({
+			display_name: Schema.String,
+		}),
+	),
+	field: Schema.optional(Schema.NullOr(Schema.String)),
+	old_value: Schema.optional(Schema.NullOr(Schema.String)),
+	new_value: Schema.optional(Schema.NullOr(Schema.String)),
+	verb: Schema.optional(Schema.String),
+	created_at: Schema.String,
+});
+export type Activity = typeof ActivitySchema.Type;
 
 export const ActivitiesResponseSchema = Schema.Struct({
-  results: Schema.Array(ActivitySchema),
-})
+	results: Schema.Array(ActivitySchema),
+});
 
 export const IssueLinkSchema = Schema.Struct({
-  id: Schema.String,
-  title: Schema.optional(Schema.NullOr(Schema.String)),
-  url: Schema.String,
-  created_at: Schema.String,
-})
-export type IssueLink = typeof IssueLinkSchema.Type
+	id: Schema.String,
+	title: Schema.optional(Schema.NullOr(Schema.String)),
+	url: Schema.String,
+	created_at: Schema.String,
+});
+export type IssueLink = typeof IssueLinkSchema.Type;
 
 export const IssueLinksResponseSchema = Schema.Struct({
-  results: Schema.Array(IssueLinkSchema),
-})
+	results: Schema.Array(IssueLinkSchema),
+});
 
 export const ModuleSchema = Schema.Struct({
-  id: Schema.String,
-  name: Schema.String,
-  status: Schema.optional(Schema.String),
-  description: Schema.optional(Schema.NullOr(Schema.String)),
-})
-export type Module = typeof ModuleSchema.Type
+	id: Schema.String,
+	name: Schema.String,
+	status: Schema.optional(Schema.String),
+	description: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export type Module = typeof ModuleSchema.Type;
 
 export const ModulesResponseSchema = Schema.Struct({
-  results: Schema.Array(ModuleSchema),
-})
+	results: Schema.Array(ModuleSchema),
+});
 
 export const ModuleIssueSchema = Schema.Struct({
-  id: Schema.String,
-  issue: Schema.String,
-  issue_detail: Schema.optional(
-    Schema.Struct({
-      id: Schema.String,
-      sequence_id: Schema.Number,
-      name: Schema.String,
-    }),
-  ),
-})
-export type ModuleIssue = typeof ModuleIssueSchema.Type
+	id: Schema.String,
+	issue: Schema.String,
+	issue_detail: Schema.optional(
+		Schema.Struct({
+			id: Schema.String,
+			sequence_id: Schema.Number,
+			name: Schema.String,
+		}),
+	),
+});
+export type ModuleIssue = typeof ModuleIssueSchema.Type;
 
 export const ModuleIssuesResponseSchema = Schema.Struct({
-  results: Schema.Array(ModuleIssueSchema),
-})
+	results: Schema.Array(ModuleIssueSchema),
+});
 
 export const WorklogSchema = Schema.Struct({
-  id: Schema.String,
-  description: Schema.optional(Schema.NullOr(Schema.String)),
-  duration: Schema.Number,
-  logged_by_detail: Schema.optional(
-    Schema.Struct({ display_name: Schema.String }),
-  ),
-  created_at: Schema.String,
-})
-export type Worklog = typeof WorklogSchema.Type
+	id: Schema.String,
+	description: Schema.optional(Schema.NullOr(Schema.String)),
+	duration: Schema.Number,
+	logged_by_detail: Schema.optional(
+		Schema.Struct({ display_name: Schema.String }),
+	),
+	created_at: Schema.String,
+});
+export type Worklog = typeof WorklogSchema.Type;
 
 export const WorklogsResponseSchema = Schema.Struct({
-  results: Schema.Array(WorklogSchema),
-})
+	results: Schema.Array(WorklogSchema),
+});
 
 export const IntakeIssueSchema = Schema.Struct({
-  id: Schema.String,
-  issue: Schema.optional(Schema.String),
-  issue_detail: Schema.optional(
-    Schema.Struct({
-      id: Schema.String,
-      sequence_id: Schema.Number,
-      name: Schema.String,
-      priority: Schema.String,
-    }),
-  ),
-  status: Schema.optional(Schema.Number),
-  created_at: Schema.String,
-})
-export type IntakeIssue = typeof IntakeIssueSchema.Type
+	id: Schema.String,
+	issue: Schema.optional(Schema.String),
+	issue_detail: Schema.optional(
+		Schema.Struct({
+			id: Schema.String,
+			sequence_id: Schema.Number,
+			name: Schema.String,
+			priority: Schema.String,
+		}),
+	),
+	status: Schema.optional(Schema.Number),
+	created_at: Schema.String,
+});
+export type IntakeIssue = typeof IntakeIssueSchema.Type;
 
 export const IntakeIssuesResponseSchema = Schema.Struct({
-  results: Schema.Array(IntakeIssueSchema),
-})
+	results: Schema.Array(IntakeIssueSchema),
+});
 
 export const PageSchema = Schema.Struct({
-  id: Schema.String,
-  name: Schema.String,
-  description_html: Schema.optional(Schema.NullOr(Schema.String)),
-  created_at: Schema.String,
-  updated_at: Schema.optional(Schema.String),
-})
-export type Page = typeof PageSchema.Type
+	id: Schema.String,
+	name: Schema.String,
+	description_html: Schema.optional(Schema.NullOr(Schema.String)),
+	created_at: Schema.String,
+	updated_at: Schema.optional(Schema.String),
+});
+export type Page = typeof PageSchema.Type;
 
 export const PagesResponseSchema = Schema.Struct({
-  results: Schema.Array(PageSchema),
-})
+	results: Schema.Array(PageSchema),
+});
 
 export const CommentSchema = Schema.Struct({
-  id: Schema.String,
-  comment_html: Schema.optional(Schema.String),
-  actor_detail: Schema.optional(
-    Schema.Struct({ display_name: Schema.String }),
-  ),
-  created_at: Schema.String,
-})
-export type Comment = typeof CommentSchema.Type
+	id: Schema.String,
+	comment_html: Schema.optional(Schema.String),
+	actor_detail: Schema.optional(Schema.Struct({ display_name: Schema.String })),
+	created_at: Schema.String,
+});
+export type Comment = typeof CommentSchema.Type;
 
 export const CommentsResponseSchema = Schema.Struct({
-  results: Schema.Array(CommentSchema),
-})
+	results: Schema.Array(CommentSchema),
+});
 
 export const CycleIssueSchema = Schema.Struct({
-  id: Schema.String,
-  issue: Schema.String,
-  issue_detail: Schema.optional(
-    Schema.Struct({
-      id: Schema.String,
-      sequence_id: Schema.Number,
-      name: Schema.String,
-    }),
-  ),
-})
-export type CycleIssue = typeof CycleIssueSchema.Type
+	id: Schema.String,
+	issue: Schema.String,
+	issue_detail: Schema.optional(
+		Schema.Struct({
+			id: Schema.String,
+			sequence_id: Schema.Number,
+			name: Schema.String,
+		}),
+	),
+});
+export type CycleIssue = typeof CycleIssueSchema.Type;
 
 export const CycleIssuesResponseSchema = Schema.Struct({
-  results: Schema.Array(CycleIssueSchema),
-})
+	results: Schema.Array(CycleIssueSchema),
+});

package/src/format.ts

@@ -1,11 +1,18 @@
-import type { Issue, State } from "./config.js"
+import type { Issue, State } from "./config.js";
+
+export function escapeHtmlText(text: string): string {
+	return text
+		.replace(/&/g, "&")
+		.replace(/</g, "&lt;")
+		.replace(/>/g, "&gt;");
+}
 
 export function formatIssue(issue: Issue, projKey: string): string {
-  const state = issue.state as State | string
-  const stateName = typeof state === "object" ? state.name : "?"
-  const stateGroup = typeof state === "object" ? state.group : "?"
-  const seqPad = String(issue.sequence_id).padStart(3, " ")
-  const groupPad = stateGroup.padEnd(10, " ")
-  const namePad = stateName.padEnd(12, " ")
-  return `${projKey}-${seqPad}  [${groupPad}]  ${namePad}  ${issue.name}`
+	const state = issue.state as State | string;
+	const stateName = typeof state === "object" ? state.name : "?";
+	const stateGroup = typeof state === "object" ? state.group : "?";
+	const seqPad = String(issue.sequence_id).padStart(3, " ");
+	const groupPad = stateGroup.padEnd(10, " ");
+	const namePad = stateName.padEnd(12, " ");
+	return `${projKey}-${seqPad}  [${groupPad}]  ${namePad}  ${issue.name}`;
 }