[#291] Convert Jira markup to markdown

bitcrowd / tickety-tick

A browser extension that helps you name branches and write better commit messages

MIT License

57 stars 10 forks source link

[#291] Convert Jira markup to markdown #326

Closed pmeinhardt closed 2 years ago

pmeinhardt commented 2 years ago

This needs a bit more testing. We should try a development build with Jira tickets we have in the wild.

The Jira API is queried in a different way. We should possibly check what this means in terms of compatibility, esp. with regard to on-premise Jira installations (which could be older?).

Closes #291.

pmeinhardt commented 2 years ago

There's already a good improvement on the output.

Some weirdness I saw when trying it on tickets though:

Messages include   in different places (which is just a "space" as far as I can tell)
Escaped : on a URL from an inlineCard ADF node:https\://bitcrowd.atlassian.net/browse
Backslashes in different places:
- on line endings generated from an ADF hardBreak node
- before dots in text nodes, e.g. 2\. double check…
Maybe we can improve rendering of media elements which currently output . I wonder whether we can derive their URL somehow

pmeinhardt commented 2 years ago

Status update: This is currently being tested internally at bitcrowd. 🧪

klappradla commented 2 years ago

Testing 🥼

~auto-format for the description (wrapping at 80 chars) does not work ❌~
pasted links are rendered as <https://...> but work great (did not know this) ✅

(Just collecting some of my findings with the internal build here)

klappradla commented 2 years ago

Quick rebase 🏓

klappradla commented 2 years ago

Just to confirm: played around a bit with the auto-formatting of the description and it - of course - works like charm 💯

(It also shouldn't really be affected by this change right here)

Will do another round of test driving and then probably merge 🚢