forked from usebruno/bruno
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Bruno language parser to support multiline text blocks (useb…
…runo#2086) * Refactor Bruno language parser to support multiline text blocks * Refactor SingleLineEditor component to allow newlines and adjust height dynamically * Refactor SingleLineEditor component to fix overflow issue * Fix overflow issue in SingleLineEditor component * Refactor SingleLineEditor and MultiLineEditor components to fix overflow issues and allow newlines * Fix overflow and scrolling issues in MultiLineEditor component --------- Co-authored-by: Sanjai Kumar <sk@sk.local>
- Loading branch information
Showing
8 changed files
with
289 additions
and
28 deletions.
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
packages/bruno-app/src/components/MultiLineEditor/StyledWrapper.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import styled from 'styled-components'; | ||
|
|
||
| const StyledWrapper = styled.div` | ||
| width: 100%; | ||
| height: fit-content; | ||
| max-height: 200px; | ||
| overflow: auto; | ||
| .CodeMirror { | ||
| background: transparent; | ||
| height: fit-content; | ||
| font-size: 14px; | ||
| line-height: 30px; | ||
| overflow: hidden; | ||
| .CodeMirror-scroll { | ||
| overflow: hidden !important; | ||
| ${'' /* padding-bottom: 50px !important; */} | ||
| position: relative; | ||
| display: contents; | ||
| margin: 0px; | ||
| padding: 0px; | ||
| } | ||
| .CodeMirror-vscrollbar, | ||
| .CodeMirror-hscrollbar, | ||
| .CodeMirror-scrollbar-filler { | ||
| display: none; | ||
| } | ||
| .CodeMirror-lines { | ||
| padding: 0; | ||
| } | ||
| .CodeMirror-cursor { | ||
| height: 20px !important; | ||
| margin-top: 5px !important; | ||
| border-left: 1px solid ${(props) => props.theme.text} !important; | ||
| } | ||
| pre { | ||
| font-family: Inter, sans-serif !important; | ||
| font-weight: 400; | ||
| } | ||
| .CodeMirror-line { | ||
| color: ${(props) => props.theme.text}; | ||
| padding: 0; | ||
| } | ||
| .CodeMirror-selected { | ||
| background-color: rgba(212, 125, 59, 0.3); | ||
| } | ||
| } | ||
| `; | ||
|
|
||
| export default StyledWrapper; |
174 changes: 174 additions & 0 deletions
174
packages/bruno-app/src/components/MultiLineEditor/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| import React, { Component } from 'react'; | ||
| import isEqual from 'lodash/isEqual'; | ||
| import { getAllVariables } from 'utils/collections'; | ||
| import { defineCodeMirrorBrunoVariablesMode } from 'utils/common/codemirror'; | ||
| import StyledWrapper from './StyledWrapper'; | ||
|
|
||
| let CodeMirror; | ||
| const SERVER_RENDERED = typeof navigator === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true; | ||
|
|
||
| if (!SERVER_RENDERED) { | ||
| CodeMirror = require('codemirror'); | ||
| CodeMirror.registerHelper('hint', 'anyword', (editor, options) => { | ||
| const word = /[\w$-]+/; | ||
| const wordlist = (options && options.autocomplete) || []; | ||
| let cur = editor.getCursor(), | ||
| curLine = editor.getLine(cur.line); | ||
| let end = cur.ch, | ||
| start = end; | ||
| while (start && word.test(curLine.charAt(start - 1))) --start; | ||
| let curWord = start != end && curLine.slice(start, end); | ||
|
|
||
| // Check if curWord is a valid string before proceeding | ||
| if (typeof curWord !== 'string' || curWord.length < 3) { | ||
| return null; // Abort the hint | ||
| } | ||
|
|
||
| const list = (options && options.list) || []; | ||
| const re = new RegExp(word.source, 'g'); | ||
| for (let dir = -1; dir <= 1; dir += 2) { | ||
| let line = cur.line, | ||
| endLine = Math.min(Math.max(line + dir * 500, editor.firstLine()), editor.lastLine()) + dir; | ||
| for (; line != endLine; line += dir) { | ||
| let text = editor.getLine(line), | ||
| m; | ||
| while ((m = re.exec(text))) { | ||
| if (line == cur.line && curWord.length < 3) continue; | ||
| list.push(...wordlist.filter((el) => el.toLowerCase().startsWith(curWord.toLowerCase()))); | ||
| } | ||
| } | ||
| } | ||
| return { list: [...new Set(list)], from: CodeMirror.Pos(cur.line, start), to: CodeMirror.Pos(cur.line, end) }; | ||
| }); | ||
| CodeMirror.commands.autocomplete = (cm, hint, options) => { | ||
| cm.showHint({ hint, ...options }); | ||
| }; | ||
| } | ||
|
|
||
| class MultiLineEditor extends Component { | ||
| constructor(props) { | ||
| super(props); | ||
| // Keep a cached version of the value, this cache will be updated when the | ||
| // editor is updated, which can later be used to protect the editor from | ||
| // unnecessary updates during the update lifecycle. | ||
| this.cachedValue = props.value || ''; | ||
| this.editorRef = React.createRef(); | ||
| this.variables = {}; | ||
| } | ||
| componentDidMount() { | ||
| // Initialize CodeMirror as a single line editor | ||
| /** @type {import("codemirror").Editor} */ | ||
| this.editor = CodeMirror(this.editorRef.current, { | ||
| lineWrapping: false, | ||
| lineNumbers: false, | ||
| theme: this.props.theme === 'dark' ? 'monokai' : 'default', | ||
| mode: 'brunovariables', | ||
| brunoVarInfo: { | ||
| variables: getAllVariables(this.props.collection) | ||
| }, | ||
| scrollbarStyle: null, | ||
| tabindex: 0, | ||
| extraKeys: { | ||
| Enter: () => { | ||
| if (this.props.onRun) { | ||
| this.props.onRun(); | ||
| } | ||
| }, | ||
| 'Ctrl-Enter': () => { | ||
| if (this.props.onRun) { | ||
| this.props.onRun(); | ||
| } | ||
| }, | ||
| 'Cmd-Enter': () => { | ||
| if (this.props.onRun) { | ||
| this.props.onRun(); | ||
| } | ||
| }, | ||
| 'Alt-Enter': () => { | ||
| this.editor.setValue(this.editor.getValue() + '\n'); | ||
| this.editor.setCursor({ line: this.editor.lineCount(), ch: 0 }); | ||
| }, | ||
| 'Shift-Enter': () => { | ||
| this.editor.setValue(this.editor.getValue() + '\n'); | ||
| this.editor.setCursor({ line: this.editor.lineCount(), ch: 0 }); | ||
| }, | ||
| 'Cmd-S': () => { | ||
| if (this.props.onSave) { | ||
| this.props.onSave(); | ||
| } | ||
| }, | ||
| 'Ctrl-S': () => { | ||
| if (this.props.onSave) { | ||
| this.props.onSave(); | ||
| } | ||
| }, | ||
| 'Cmd-F': () => {}, | ||
| 'Ctrl-F': () => {}, | ||
| // Tabbing disabled to make tabindex work | ||
| Tab: false, | ||
| 'Shift-Tab': false | ||
| } | ||
| }); | ||
| if (this.props.autocomplete) { | ||
| this.editor.on('keyup', (cm, event) => { | ||
| if (!cm.state.completionActive /*Enables keyboard navigation in autocomplete list*/ && event.keyCode != 13) { | ||
| /*Enter - do not open autocomplete list just after item has been selected in it*/ | ||
| CodeMirror.commands.autocomplete(cm, CodeMirror.hint.anyword, { autocomplete: this.props.autocomplete }); | ||
| } | ||
| }); | ||
| } | ||
| this.editor.setValue(String(this.props.value) || ''); | ||
| this.editor.on('change', this._onEdit); | ||
| this.addOverlay(); | ||
| } | ||
|
|
||
| _onEdit = () => { | ||
| if (!this.ignoreChangeEvent && this.editor) { | ||
| this.cachedValue = this.editor.getValue(); | ||
| if (this.props.onChange) { | ||
| this.props.onChange(this.cachedValue); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| componentDidUpdate(prevProps) { | ||
| // Ensure the changes caused by this update are not interpreted as | ||
| // user-input changes which could otherwise result in an infinite | ||
| // event loop. | ||
| this.ignoreChangeEvent = true; | ||
|
|
||
| let variables = getAllVariables(this.props.collection); | ||
| if (!isEqual(variables, this.variables)) { | ||
| this.editor.options.brunoVarInfo.variables = variables; | ||
| this.addOverlay(); | ||
| } | ||
| if (this.props.theme !== prevProps.theme && this.editor) { | ||
| this.editor.setOption('theme', this.props.theme === 'dark' ? 'monokai' : 'default'); | ||
| } | ||
| if (this.props.value !== prevProps.value && this.props.value !== this.cachedValue && this.editor) { | ||
| this.cachedValue = String(this.props.value); | ||
| this.editor.setValue(String(this.props.value) || ''); | ||
| } | ||
| if (this.editorRef?.current) { | ||
| this.editorRef.current.scrollTo(0, 10000); | ||
| } | ||
| this.ignoreChangeEvent = false; | ||
| } | ||
|
|
||
| componentWillUnmount() { | ||
| this.editor.getWrapperElement().remove(); | ||
| } | ||
|
|
||
| addOverlay = () => { | ||
| let variables = getAllVariables(this.props.collection); | ||
| this.variables = variables; | ||
|
|
||
| defineCodeMirrorBrunoVariablesMode(variables, 'text/plain'); | ||
| this.editor.setOption('mode', 'brunovariables'); | ||
| }; | ||
|
|
||
| render() { | ||
| return <StyledWrapper ref={this.editorRef} className="single-line-editor"></StyledWrapper>; | ||
| } | ||
| } | ||
| export default MultiLineEditor; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.