Method openHelpForSelection

src/helpViewer/index.ts:424–467

(
        preserveFocus: boolean = false,
    )

    // quickly open help for selection
    public async openHelpForSelection(
        preserveFocus: boolean = false,
    ): Promise<boolean> {
        // only use if we failed to show help page:
        let errMsg = '';

        const editor = vscode.window.activeTextEditor;
        if (editor) {
            // the text to show help for:
            let txt = '';
            if (editor.selection.isEmpty) {
                // no text selected -> find word at current cursor position
                // use regex including ":" to capture package/namespace (e.g. base::print)
                const re = /([a-zA-Z0-9._:])+/;
                const range = editor.document.getWordRangeAtPosition(
                    editor.selection.start,
                    re,
                );
                // check if the cursor is at a word (else: whitespace -> ignore)
                if (range) {
                    txt = editor.document.getText(range);
                }
            } else {
                // use selected text
                txt = editor.document.getText(editor.selection);
            }
            txt = txt.trim();
            if (txt) {
                const success = await this.openHelpByAlias(txt, preserveFocus);
                if (!success) {
                    errMsg = `Failed to open help for "${txt}"!`;
                }
            } else {
                errMsg = 'Cannot show help: No valid text selected!';
            }
        } else {
            errMsg = 'No editor active!';
        }
        if (errMsg) {
            void vscode.window.showErrorMessage(errMsg);
            return false;
        }
        return true;
    }

    // quickly open help page by alias
    public async openHelpByAlias(