Make alt+click behavior configurable

[awmottaz]

Adds a new Boolean option altClickMovesCursor which enables/disables the alt+click behavior that moves the prompt cursor to the location of the mouse.

Closes #3145

[awmottaz]

Just a note: I am working on adding a couple of tests:

• alt+click moves the cursor when option is enabled
• alt+click does not move cursor when option is disabled
• option is enabled by default

But I thought I would push up the PR with the implementation right away to get feedback on that.

[awmottaz]

I am struggling with writing tests for this. It appears that interaction with the DOM is explicitly disabled in the TestSelectionService. Adding it back in causes lots of issues. Any advice for how to write these tests? Or would you consider this contribution without tests?

[matthias-ccri]

Just wondering if we want to make this a breaking change. Before, the alt-click behavior was enabled by default. With this change it's disabled by default and must be enabled.

It may be that we should disable it; I don't know, but I thought I'd ask.

[awmottaz]

Just wondering if we want to make this a breaking change. Before, the alt-click behavior was enabled by default. With this change it's disabled by default and must be enabled.

I meant for this not to be a breaking change. I set the default value to true. Is there more I need to do to ensure it's enabled by default?

https://github.com/xtermjs/xterm.js/pull/3181/files#diff-d156a9a2b47b63f41faf54f727fc23ffd0ee8fa672cbfe8b77ce20dffa846082R53

[mofux]

Thanks for the contribution! Looks good so far, IMO no additional tests for this feature are required. There are still some missing bits though:

Please add the new option here:

xterm.js/src/browser/public/Terminal.ts

Line 173 in 84fa6be

public getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'disableStdin' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'visualBell'): boolean;

and here:

xterm.js/src/browser/public/Terminal.ts

Line 185 in 84fa6be

public setOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'disableStdin' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'visualBell', value: boolean): void;

and here:

xterm.js/src/common/services/Services.ts

Line 186 in 84fa6be

export interface IPartialTerminalOptions {

[mofux]

I think the check for this option should be moved up to the parent if statement:

xterm.js/src/browser/services/SelectionService.ts

Line 670 in 04e2bdd

if (this.selectionText.length <= 1 && timeElapsed < ALT_CLICK_MOVE_CURSOR_TIME && event.altKey) {

[awmottaz]

Thanks @mofux, I made all of your requested changes

[matthias-ccri]

@awmottaz I see, my mistake!
Thanks for the contribution.

[Tyriar]

Thanks @awmottaz 🙂