Skip to content

jtk comments add: newlines in --body rendered as literal \\n #167

@piekstra

Description

@piekstra

Bug

When adding a comment with jtk comments add, newline characters (\n) in the --body string are double-escaped and rendered as literal \n text in the Jira comment instead of being converted to actual line breaks in ADF (Atlassian Document Format).

Steps to Reproduce

jtk comments add PROJ-123 --body "Line one\nLine two\n- bullet one\n- bullet two"

Expected

The comment should render with actual line breaks:

Line one
Line two
- bullet one
- bullet two

i.e., \n should produce separate paragraph nodes in ADF, and markdown-style - item should ideally produce bulletList nodes.

Actual

The comment renders as a single paragraph with literal \n characters visible in the text:

Line one\nLine two\n- bullet one\n- bullet two

In the ADF body, the content shows \\n (escaped backslash + n) inside text nodes rather than being split into separate paragraph/list nodes.

Root Cause Guess

The --body string is likely being passed directly into a single ADF text node without parsing newlines into separate ADF paragraph nodes. The markdown-to-ADF conversion (if any) isn't handling \n from CLI args.

Environment

  • jtk: latest (installed via Homebrew from open-cli-collective/tap)
  • Jira Cloud

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions