[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 #292

Closed maltoe closed 3 years ago

maltoe commented 3 years ago

Fixes #291

pmeinhardt commented 3 years ago

Maybe it's worth testing this out with a local build for another week or so before we release? 🤔 I somehow expect the JIRA text to be a somewhat tricky format and would like to gain some confidence in the new package this PR introduces to make sure we don't unintentionally break Tickety-Tick for JIRA users.

What do you think @maltoe?

maltoe commented 3 years ago

a local build for another week or so

@pmeinhardt running a local build right now, can tell you in a week how it goes

maltoe commented 3 years ago

@pmeinhardt Found the first couple oddities:

If you have an apostrophe in your test (don't), Jira will turn it into an actual english apostrophe (don’t) which the converter lets through -> I guess from the converter perspective this is intended, but I'd like it if it converted them to simple quotes instead. Maybe that's not an issue with this PR though, but could be solved in a more general way?
I had a line Let’s unify them into one! in a ticket in Jira which came out as Let’s unify them into one\! 🤔
The converter turned {{assert_count_difference}} (monospace expression) into [backtick]assert*count*difference[backtick] (with [backtick] being actual backticks) :(

maltoe commented 3 years ago

Sometimes it also copies a whole bunch of bogus text with a lot of repetitions in it. Looks like jira2md is broken after all. :/

pmeinhardt commented 3 years ago

Added a few notes about potential alternative approaches to converting the Jira markup in a comment on the issue: https://github.com/bitcrowd/tickety-tick/issues/291#issuecomment-822767992

maltoe commented 3 years ago

@pmeinhardt I give up, have disabled the description in my config. It's entirely broken for any reasonable real-world description. The last point I mentioned with the repetitions is the worst, at times it generates so much garbage that it doesn't even fit the command line anymore.

pmeinhardt commented 3 years ago

@pmeinhardt I give up, have disabled the description in my config. It's entirely broken for any reasonable real-world description. The last point I mentioned with the repetitions is the worst, at times it generates so much garbage that it doesn't even fit the command line anymore.

Oh wow. I had a hunch that the Atlassian markup might become a challenge, but I wonder what's going on in the conversion package that makes it "generate so much garbage". 🤔

Maybe we can explore some of the other possible approaches in an upcoming hacknight. 👾