Feature - Line highlighting within code block #2469

[duartefrazao]

Description

This PR solves the #2469 issue, it allows the user to highlight lines of code within a snippet of code by clicking on the line number. This highlight is not temporary, it persists when exiting Boostnote. Used CodeMirror built-in functionality to do this.

To use this feature you just need to click the line number of the respective line you want to highlight.

Before

After

Issue fixed

Issue #2469 Line highlighting within code block

Type of changes

• 🔘 Bug fix (Change that fixed an issue)
• ⚪ : Breaking change (Change that can cause existing functionality to change)
• 🔘 Improvement (Change that improves the code. Maybe performance or development improvement)
• 🔘 Feature (Change that adds new functionality)
• ⚪ Documentation change (Change that modifies documentation. Maybe typo fixes)

Checklist:

• 🔘 My code follows the project code style
• ⚪ I have written test for my code and it has been tested
• 🔘 All existing tests have been passed
• 🔘 I have attached a screenshot/video to visualize my change if possible

[ZeroX-DG]

Can you provide some info on how to use this feature?

[ZeroX-DG]

Hmm...That's strange, I can't highlight the line by clicking on the gutter. Can you check it?

[ZeroX-DG]

Please fix your eslint error

[ZeroX-DG]

Also I discover that when my snippet doesn't contain linesHighlighted then the feature won't work at all. You should fallback linesHighlighted to [] if it not existed. Also, can you apply this feature to markdown note too?

[duartefrazao]

Fixed the issues you pointed.
Will replicate the feature to markdown note.

[ZeroX-DG]

I can still reproduce the old bug. You should fallback linesHighlighted to [] if it is null instead of stopping the whole process.

[duartefrazao]

Could you please tell me how to reproduce that bug?
Is it a default note, an old note pre pull request or a note that you changed?

[ZeroX-DG]

It's an old default snippet note generated by Boostnote.

[duartefrazao]

I've been trying to replicate this old bug but with no sucess.
I've tried to delete everyting Boostone related and download a past version and then open with my version of the pull request and it still works...
Could you detail the steps you took as well as operating system you're using?

[duartefrazao]

I've tested in several computers and I can't replicate the bug anymore, please give me detailed instructions to replicate your bug.

[duartefrazao]

I've also added this functionality to markdown notes.

[ZeroX-DG]

I have to manually added linesHighlighted to the first note and leave the second note alone (the default note of Boostnote).

[duartefrazao]

I've made the necessary corrections to fix the bug.
By adding the functionality you asked a similar bug also appeared with the Markdown notes too, which is also fixed.
To easily test this bugs and ask others for help testing I made a simple script that makes it easy to replicate this situation. If you want to take a look or use it's here

[duartefrazao]

I've been testing more the pr and I found another bug that I will try to solve by tomorrow.

[duartefrazao]

This new commit contains two main parts:

• Included the data structure holding past values of the lines highlighted for each note/snippet saved in the create and update snippet/note tests
• Made the feature robust to the following variables when editing the note/snippet:
  • Type of action (delete, input, paste, undo and insert)
  • How many lines affected (e.g. be it a single line delete or multi-line)
  • Where the action starts and ends (e.g. if you end a delete on the middle of a line the highlight should be kept but if you end on the begging of the line the highlight should be removed)

[duartefrazao]

@ZeroX-DG I'm also part of the same class that has recently contributed to Boostnote. As some of them mentioned It would really help my group's grade if we knew if the pull request is going to be accepted. Thank you very much!

[ZeroX-DG]

Everything works fine now, please change your code before I can approve the PR.

[duartefrazao]

Made the changes you asked, @ZeroX-DG . Thank you for explaining 😃

[ZeroX-DG]

LGTM 🎉 Thank you for your contribution and good luck with your course!

[duartefrazao]

Thank you very much, and thank you for guiding us on submitting our pull request! Hope our work benefits Boostnote 😃