Desktop: Unindent empty list markup on Enter

[sinkuu]

Fixes #2614

cc @Rishgod

[tessus]

The wrong issue is linked.

[tessus]

It works nicely with lists, but not with checkboxes. Any chance you could add that as well?

[sinkuu]

Added.

[tessus]

Perfect, thanks.

One last thing: When indented and hitting enter, the cursor should reset to column position 1. e.g.:

Current behavior:

- item
    - item
    - item (hit enter in this line)
    x   <---- cursor is here

But it should rather be like this:

- item
    - item
    - item (hit enter in this line)
x   <---- cursor is here

[sinkuu]

Another possibility is to unindent, which is adopted by Dropbox Paper and Evernote.

- item
    - item
    - item
- x  <---- cursor is here (hitting enter again removes `- `)

EDIT: As a reference point related to Joplin, TinyMCE uses this behavior too.

[tessus]

Another possibility is to unindent

Yes, this would also be a nice solution, but probably more complicated to implement.
Your latest fix was already great, so the PR looks ready to me.

But maybe Laurent does like your idea better, since people coming from Evernote certainly would feel right at home with that behavior. Let's wait for Laurent's input.

[miciasto]

Hi @sinkuu thanks for the changes. I deleted my comments immediately and was going to try again later, but it seems you saw them anyway!

[miciasto]

Another possibility is to unindent

and then clear after that.

[tessus]

@mic704b

and then clear after that.

I think in this case only after a second Enter, because you might want to continue the list....

[sinkuu]

Unindent on Enter (3204eb0):

Clear indentation on Enter (ce6355e):

[miciasto]

Looks good.

Does this have any effect when entering numbered lists? Have you tested mid-line multiline selections?

It's a shame we have no way to automated test this, to make sure no one breaks it in the future.

[sinkuu]

Does this have any effect when entering numbered lists?

It works the same for all Markdown list syntaxes (-, *, 1. etc.).

Have you tested mid-line multiline selections?

I added multiSelectAction: 'forEach':

[sinkuu]

@mic704b I made automated tests here: https://github.com/sinkuu/joplin-ace-indent-test/blob/master/spec/indentSpec.js I don't know how I can integrate this to Joplin (if that's a good idea) though. The tests require Ace's MockRenderer which is not included in published packages.

[tessus]

I think the behavior should be like the way you have alerady described:

- item
    - item
    - item
- x  <---- cursor is here (hitting enter again removes `- `)

This behavior makes the most sense. Then I think we are good to merge. Just waiting for Laurent's input.

[sinkuu]

Changed to unindenting behavior.

[tessus]

Great. This helps a lot with usability.

[miciasto]

I made automated tests here

@sinkuu that looks really good. Nice work.

I don't know how I can integrate this to Joplin (if that's a good idea) though

I think when it is testing behaviour implemented in Joplin then it makes a lot of sense. (Though it might even make sense when testing required behaviour of dependencies too). However let's see what Laurent thinks, when things calm down a bit.

[laurent22]

The test units you've created look good @sinkuu. Any chance you could add them to this pull request? You could put the test in CliClient/tests and feel free to add any required dependency to CliClient/package.json as dev dependency.

[sinkuu]

Done.

[PackElend]

ready to merge?

[laurent22]

Sorry for being late to review this @sinkuu, and unfortunately I see there are some conflicts, due to the recent refactoring of NoteText.jsx, please could you take a look at them?

I've moved the previous code from your pull request to a custom hook in AceEditor/utils/useListIdent.ts. I believe you might need to move some of your changes to this file, and the rest probably in AceEditor.tsx.

[tessus]

@sinkuu have you had the time to look into this? I was quite busy and unavailable the last 2 weeks, so I couldn't look into it myself.

[tessus]

I really would hate seeing this not merged. This made working with lists and checklists a lot easier and better.

[tessus]

Works perfectly! Thanks!

[tessus]

@laurent22 can I merge this?

[laurent22]

Yes, if it's working for you then let's merge. Thanks @sinkuu!