kensam94 / joplin-plugin-simple-highlighter Goto Github PK

When we select a highlighted section like so (start and end of selection indicated with (|)):
|Test of a ==highlighted selection== and more|
and the highlight button is clicked I would expext to expand the highlighted section. Two more equal signs are added around the selection but the "nested" highlight equal signs are not removed. This breaks the highlight markdown.

Current Behaviour

When we select a highlighted section like so (start and end of selection indicated with (|)):
|Test of a ==highlighted selection== and more|
clicking the highlight button results in:
==Test of a ==highlighted selection== and more==|

Expected Behaviour

When we select a highlighted section like so (start and end of selection indicated with (|)):
|Test of a ==highlighted selection== and more|
clicking the highlight button should result in:
==Test of a highlighted selection and more==|
or as an intermediate step should remove all equal signs that are in pair of two inside of the selection:
Test of a highlighted selection and more|

How To

1. count equal signs in pair of two in selection (e.g.: with regex ={2}\b|\b={2})
2. if (count > 0): remove all pair of two in selection
3. do highlight as implemented

When the cursor (|) is behing a highlighted selection like so:
Test of a ==highlighted selection==|
and the highlight button is clicked the last two equal signs are removed. This removes the highlight but leaves the starting equal signs incorrectly. I guess this feature is by design.

Current Behaviour

If we have the following line with | indicating the cursor position:
Test of a ==highlighted selection==|
clicking the highlight button results in:
Test of a ==highlighted selection|

Expected Behaviour

If we have the following line with | indicating the cursor position:
Test of a ==highlighted selection==|
clicking the highlight button results in:
Test of a highlighted selection|

I like your plugin a lot!
To simplify highlighting even more I would like to highlight a complete row by simply clicking once.

Current Behaviour

If we have the following line with | indicating the cursor position:
Test of a |sentence
clicking the highlight button results in:
Test of a ====|sentence

Expected Behaviour

If we have the following line with | indicating the cursor position:
- Test of a |bullet point
clicking the highlight button should result in:
==Test of a |sentence==

How to

In order to implement this we would probably do sth along the following lines:
Adding highlight:

1. check for an empty selection
2. if empty:
3. (save the cursor position)
4. select the complete line
5. do highlight as implemented
6. (unselect and position cursor at original cursor position +2)

Removing highlight:
In order to remove the highlight correctly, the equal signs must can be part of the selection, so it's nearly the same as adding highlight:

1. check for an empty selection
2. if empty:
3. (save the cursor position)
4. select the complete line
5. do removal of highlight as implemented
6. (unselect and position cursor at original cursor position -2)

To prevent the breaking of markdown syntax highlight == must be positioned behind the #, - etc. of headings, bullet points etc.
To do so it should be enough to start the selection at the first letter of the line for adding of highlight or at the first equal sign for removal of highlight:
- Test of a |bullet point
clicking the highlight button should result in:
- ==Test of a |bullet point==
clicking the highlight button again results in:
- Test of a |bullet point

would be cool to have a keyboard shortcut for the highlighter