Vscode-markdown: Backspace and enter lag (conflicts with Spell Check)

[gusbemacbe]

What is the problem?

In reference to several issues, prinicipally https://github.com/yzhang-gh/vscode-markdown/issues/17, I still am experiencing this problem. The backspace and enter bug is still not solved.

Therefore, I had to remove some keyboard shortcuts of your extension, but it still did not work yet, then I had to use @VictorioBerra's tricks, it almost worked, but later it stopped of working.

How can I reproduce it?

Still the same problem that the other users have experienced.

Is there any error message in the console?

No

I am using Manjaro Linux KDE and VSCode Insiders 1.34.

---

Workaround

If you do not need the "list continuation" feature, you can delete some key bindings (e.g. onEnterKey, onBackspaceKey). See instructions at https://github.com/yzhang-gh/vscode-markdown/issues/88#issuecomment-364628067.

If you want to investigate more, you can check¹ these extensions first, which are reported (probably) conflicting with Markdown-All-in-One:

• Spell Right
• Bracket Pair Colorizer 2

^{1. disable it and see whether the issue is gone}
edited by @yzhang-gh

[yzhang-gh]

Could you confirm whether you have tried these steps?

For the problem like "command '...' not found", please try to

1. wait for a few seconds after you open a Markdown file for the first time
2. doesn't work? -> update vscode
3. doesn't work? -> reinstall this extension
4. still doesn't work? 😵 -> please open the developer tools to see whether there is any error message,
   and then paste it below.
   (menubar>help>toggle dev tools)

[gusbemacbe]

@yzhang-gh !

I did not receive any "command '...' not found". No error. Only backspace and enter glitch.

But as enabling your extension, it prevents me from using backspace and enter. It also prevents me from pressing backspace and enter in the command palette sometimes.

I still can not capture and reproduce the glitch. It will take a time to capture the glitch.

When I capture the glitch, I will record and send it to you.

Besides, when I press Ctrl + Shift + P, the behaviour is strange, because when I type in the command palette and press backspace, it deletes in the text and not in the command palette.

[yzhang-gh]

It looks a performance issue.
You can see some instructions from vscode team.
Especially, "profile the running extensions" might help.
Looking forward to what you can find.

[gusbemacbe]

It looks a performance issue.
You can see some instructions from vscode team.
Especially, "profile the running extensions" might help.
Looking forward to what you can find.

I have just tested. No error. Strange. But I forgot of telling that I did not use a native VSCode Insiders (in the ~/usr/share/code-insiders. I downloaded and run the bin shell of VSCode.

[yzhang-gh]

Let's be more specific. Could you check

1. disable all extensions except for this one, does your glitch still exist?
2. if it is, try "profiling the running extension" and upload the profile.txt so I can investigate.

[gusbemacbe]

1. disable all extensions except for this one, does your glitch still exist?

no, it will take a time to capture the glitch.

1. if it is, try "profiling the running extension" and upload the profile.txt so I can investigate.

In spite of being unable of capturing the glitch, here is the txt:

markdown-all-in-one.txt

[yzhang-gh]

Thanks.

The profile looks normal. So I cannot do anything for now. We can take a look when you have this issue again.

[gusbemacbe]

The glitch appeared! I hit a Pokéball and captured the glitch at the Pokemon style! But I am suspecting that your extension is in conflict with @bartosz-antosik's vscode-spellright due to perfomance fail of backspace and enter.

Here is the GIF:

And here is the text;

markdown-all-one.txt

And I leave the extension txt to @bartosz-antosik:

spellright.txt

[gusbemacbe]

More another glitch's Pokéball:

Second txt: markdown-all-one2.txt
Second txt for @bartosz-antosik: spellright2.txt

[gusbemacbe]

I have just captured the error message:

[yzhang-gh]

Thank you Pokémon trainer. Then it is much clear. Looks like the spell checker causes the lag

You might need to report it to the spell checker author. I guess you have some custom settings for spell checking. Also telling him about that might help.

[ChristopherEeles]

Work around: Open key bindings and delete the offending shortcut keys from markdown.extension.on'KEY'

[gusbemacbe]

Work around: Open key bindings and delete the offending shortcut keys from markdown.extension.on'KEY'

@ChristopherEeles , sorry, I did not understand. Are you suggesting me to do it or are you explaining the problem to him?

[fourpastmidnight]

I also have this issue, frequently. I'm on Windows, latest version of VS Code - Insiders (happens in regular VS Code, too). I'm also on Windows 10 1809. So it's not just one platform where this occurs.

When this happens, it makes this extension all but useless. Did I follow the author's suggested steps? Yes, up to the point of uninstalling/re-installing the extension, because that's not really the problem here. This problem happens intermittently, but frequently. Closing and re-opening the document "until it works" is how I resolve it. But this is slow and painful and not something a user should need to do.

Also, regarding suggestions that other extensions' performance is causing an issue with this extension--I would suggest that while other extensions may be slow to process, this extension should be graceful enough to handle some lag. Since this happens _so frequently_, it would seem that this extension is a bit too eager in the amount of time it wants to allow for an action to complete?

I love the feature set of this extension--when it works. But it causes so many productivity drags, that I simply cannot recommend this extension at this time to other users. This issue has been on-going for at least a year.

[yzhang-gh]

@fourpastmidnight Thanks for the feedback and your efforts on trying to figure it out.

Could you please do one more test? Disable all the other extensions and try again. (This can be easily done by the following step)

and then enable this extension.

---

If you still have the same issue, then we need to use the CPU profile.

if it is, try "profiling the running extension" and upload the profile.txt so I can investigate.

[fourpastmidnight]

@ChristopherEeles Removing the keybindings for Backspace and Enter works. Looking at the conditionals for the keybindings, I see that there were a whole lot of checks for various Vim "modes". I don't have the Vim keymap installed. Perhaps that's the issue? It's trying to figure out whether the keybinding should be utilized and, for some reason, the logic is not working properly, perhaps because I'm not using the Vim keymaps.

I also find it strange that this extension goes to such great lengths to test for various Vim keyboard mapping modes, but does not take into consideration other keyboard layouts, like Emacs, etc. The real question is, why bother at all? I don't see other extensions or built-in features using these conditions on keybindings.

[fourpastmidnight]

And no, it's not acceptable to ask me to disable all other extensions. That's not the answer. Fix up wiring your keybindings. Make sure they work, all the time, every time.

[yzhang-gh]

Well, you get me wrong... It is a test to find out the root cause. I don't ask you to disable them all the time.

(Removing the keybindings is fine if you don't need the list continuation feature.)

[fourpastmidnight]

The list continuation feature is nice. I wonder if there's something with the checking of the Vim modes? As I said, I don't have that keymap installed.

[ChristopherEeles]

Work around: Open key bindings and delete the offending shortcut keys from markdown.extension.on'KEY'

@ChristopherEeles , sorry, I did not understand. Are you suggesting me to do it or are you explaining the problem to him?

I am suggesting a workaround in lieu of the bug fix.

[fourpastmidnight]

Well, I just reinstated the keybindings, though editing the When condition to remove the checks for all the Vim modes. No effect, I still get the Command 'markdown.extension.on<KEY>' not found. error. Ugh.

[yzhang-gh]

I wonder if there's something with the checking of the Vim modes? As I said, I don't have that keymap installed.

I don't think so. The checking won't hurt the performance. I also don't have the Vim extension. Everything works fine for me.

And you can see from the previous posts, someone has a spellchecker extension and things break.
(Actually, I use the same spellchecker but with nothing wrong.)

What I suggested above is aimed to answer two questions:

1. Whether it is an internal issue of this extension
2. If it is, then the CPU profile will tell us all

[fourpastmidnight]

I did humor you and disable all extensions and re-enabled this one. Backspace and Enter do work. I have many extensions installed, but this extension _consistently_ gives me more trouble than _any other_ extension.

[yzhang-gh]

Thanks for the checking.

TBH, there may be a complex interaction between the extensions due to the vscode mechanism.
_You won't blame a spellchecker for the lag_... But the truth is somehow it may conflict with this extension (it is not this extension alone).

What we can do is to pinpoint which one breaks this extension. Could you do the last step to find the root cause? profiling the running extension

[fourpastmidnight]

Well, I re-enabled some extensions, and magically along the way, your extension stopped working again on Backspace/Enter. I'll try to find the exact extension.

[yzhang-gh]

A good way is "binary search".

• Start from all disabled
• Enable half of them, test
• Knowing which half to investigate more
• Enable/Disable a half of the remaining extensions (according to the previous results)
• ...

[fourpastmidnight]

OK, I owe you a _HUGE_ apology. I did find the offending extension: _Windows opacity_. I've seen problems with performance and this extension in the past--but it at some point got re-enabled in my VS Code instance.

So, if anyone else on this thread has this extension, disabling and reloading your VS Code window resolves this issue 100% for me.

I will edit my review at the Visual Studio Marketplace accordingly.

[yzhang-gh]

Glad to hear that 😉

[gusbemacbe]

But I do not have this extension. It is the spellright which causes conflict with this extension.

[fourpastmidnight]

Hmm, I once had Code Spell Checker installed, and it caused me huge performance issues, so much so that I uninstalled it. So, it seems as though there is some performance aspect with respect to this issue.

All I can say is that I re-enabled all my other extensions, except _Windows opacity_, and everything works just fine. So, there are probably some isolated, but poor performing extensions in the marketplace causing negative interactions with other extensions, such as this one.

[magic-lantern]

I'm also seeing this problem. If I just have this extension enabled, everything is ok. If I just have spellright enabled, everything is ok. When both are enabled, backspace and enter do not work.

If there is some additional logs or debugging that would help to address this issue, please let me know.

[yzhang-gh]

Thanks for the feedback. This is actually more of a Spell Right issue as we can see from the CPU profiles

— https://github.com/yzhang-gh/vscode-markdown/issues/423#issuecomment-485201169

(I have seen your comment in https://github.com/bartosz-antosik/vscode-spellright/issues/273. Let's wait for his reply.)

[gusbemacbe]

The spellright extension also causes any extension to break, not just Markdown All in One, and is openly hostile to every extension. I had to remove the spellright extension as the extension's author is not interested in fixing that.

[bartosz-antosik]

@gusbemacbe Excuse me, why do you think spellright is "openly hostile to every extension"? Also, why do you think I am not interested in fixing? I do not have much time recently to spare for the extension but once I am done with other things I will try to fix many things that I am aware of. Some of them are laborious, that's all.

[gusbemacbe]

When I open VSCode, I receive warning of extenstion errors, I open toggling tools, I saw it was another extension, I disabled it, but when I restarted, still the same error. I have checked the full list of console errors and saw that it is mostly spellright which caused @idleberg's vscode-emoji-code, @Pkief's vscode-material-icon-theme and many other extensions to break.

Because I had an impression that you believe it was not caused by your extension, but by these extensions.

[Jamf05]

There's a solution? I'm still having the same problem.

[gusbemacbe]

@Jamf05

English

This @yzhang-gh's extension's keyboard shortcuts have conflict with Mirosoft's native Markdown extension's. You have to remove the keyboard shortcuts from "Open Keyboard Shortcuts".

1. Press Ctrl + Shift + P;
2. Search "Preferences: Keyboard Shortcuts";
3. Type "markdown.extension.onEnterKey", "markdown.extension.onBackspaceKey" and "markdown.extension.onTabKey", and open the window pop-up. Remove keybinding.
   

Español

Los atajos de teclado de la extensión de @yzhang-gh tienen conflicto con aquellos de la extensión Markdown nativa de la Mirosoft. Debes eliminar los atajos de teclado de "Open Keyboard Shortcuts".

   1. Presiona Ctrl + Shift + P;
   2. Encunetra "Preferences: Keyboard Shortcuts";
   3. Escribe "markdown.extension.onEnterKey", "markdown.extension.onBackspaceKey" y "markdown.extension.onTabKey", y abre la ventana pop-up. Selecciona "Remove keybinding".

[yzhang-gh]

@gusbemacbe Thank you for the reply. Actually... most of the time this extension should work well with VSCode so you don't need to remove those keybindings.

@Jamf05 Please provide more information so I can know where it goes wrong.

• First, what exactly is your problem? Do you see "command onBackspaceKey not found"? or just lag on typing?
• If you open a Markdown file for the first time, please wait for a few seconds before typing. It is a mechanism of VSCode called "lazy loading". (You will see "activating extensions" message on the status bar.)
• Have you tried with other extensions disabled (see https://github.com/yzhang-gh/vscode-markdown/issues/423#issuecomment-500474889)? There may be some extensions conflicting with this one.
• If you still have the issue, please open the developer tools to see whether there is any error message, (menubar>help>toggle dev tools)

[henricazottes]

I had this problem in combination with SpellRight. I started to have lag when pressing backspace up till it wouldn't work at all. It seems to happen when the caret is on words with typos, ie when they are underlined in red by the other extension. There is an issue on the other repo but without answers for now: https://github.com/bartosz-antosik/vscode-spellright/issues/363.
For the moment I've used gusbemacbe quick fix and it seems to do the job.

[alternativedestiny]

In my test, An extension called Bracket Pair Colorizer 2 can cause same issue. But I don't know why.