The getEnvKeystrokeText utility breaks for certain combos starting in v26

[jzempel]

📝 Provide detailed reproduction steps (if any)

import { getEnvKeystrokeText } from '@ckeditor/ckeditor5-utils/src/keyboard';

getEnvKeystrokeText('CTRL+[');
getEnvKeystrokeText('CTRL+]');

Prevents Zendesk Garden from updating the demo Editor.

✔️ Expected result

Successfully parse this common keystroke for indent/outdent. This used to work in v25.

❌ Actual result

Unexpected error while loading ./stories/index.stories.js: CKEditorError: keyboard-unknown-key {"key":"["}

❓ Possible solution

Debug changes made in v25.0.0...v26.0.0#diff-8a8feb9905511e353215fac103af1ff8dbf4ed40e7e24d3994c63e28f1a8f756.

📃 Other details

• Browser: any
• OS: any
• First affected CKEditor version: v26
• Installed CKEditor plugins: not relevant

Possibly related to #9412

---

If you'd like to see this fixed sooner, add a 👍 reaction to this post.

[Mgsy]

Hi! Thanks for the report. It seems that [ and ] characters are not supported, so the editor doesn't know how to translate them to key codes. 

For now, you can add it on your own by adding them manually to the generateKnownKeyCodes() function:

keyCodes[ '[' ] = 219;
keyCodes[ ']' ] = 221;

Successfully parse this common keystroke for indent/outdent. This used to work in v25.

I've checked it at versions < 26.0.0 and it seems to behave the same, so it doesn't seem to be a regression.

[jzempel]

@Mgsy that seems to patch the runtime parsing error. However EditingKeystrokeHandler still seems to be affected as setting the corresponding UI shortcuts results in undefined.

[jzempel]

I've checked it at versions < 26.0.0 and it seems to behave the same, so it doesn't seem to be a regression.

• Please see the successful deployment connected with the zendeskgarden/ckeditor@8bfbc52 bump to v25. As you can see, existing square bracket key strokes work as expected.
• Now see the follow-on deployment on that same branch with the zendeskgarden/ckeditor@b365b8c bump to v26. Open the browser dev console to see the runtime error when attempting to parse the same lines.

This history is documented in zendeskgarden/ckeditor#17. What am I missing?

[Mgsy]

Thanks for the details! I've checked it once again and indeed, getEnvKeystrokeText was working properly with [ and ] characters before version 26.0.0. It looks like this is a regression introduced by this commit - 5c2a69a.

[Reinmar]

We can go in two directions:

• Somehow revert the change that we made so keys that our tool does not recognize ([ and ] would not work when e.g. trying to set such a keystroke – they only worked in getEnvKeystrokeText()).
• Add more keys to the list of known keys.

I'm for the latter to be consistent. If we went with the first option, getEnvKeystrokeText() would work, but parseKeystroke() e.g. wouldn't. It makes no sense.

So the characters to add, at least looking at my keyboard layout: `-=[];',./\ 

I simply went through all the special characters on my keyboard. We should also scan 2-3 other common keyboard layouts.

Question: How to support characters that require Shift? E.g. {} on my keyboard at least. Can they be used for keystrokes? What about other keyboard layouts?

[Reinmar]

BTW, @jzempel, are you sure that you want to override Cmd+[? This keystroke is used by some people to navigate back/forth in the browser history.

[Reinmar]

I simply went through all the special characters on my keyboard. We should also scan 2-3 other common keyboard layouts.

Question: How to support characters that require Shift? E.g. {} on my keyboard at least. Can they be used for keystrokes? What about other keyboard layouts?

Since this is the first issue in this category for a long time, let's ignore these doubts for now. Let's:

•  add the aforementioned characters to the list
  • don't forget about updating export const keyCodes documentation,
• make sure that the utils in keyboard.js throw a meaningful error when passed an unknown key