-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use CodeMirror 6 in REPL #3014
base: main
Are you sure you want to change the base?
Use CodeMirror 6 in REPL #3014
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
export { basicSetup, EditorView } from "codemirror"; | ||
export { basicSetup } from "codemirror"; | ||
export { oneDark } from "@codemirror/theme-one-dark"; | ||
export { javascriptLanguage } from "@codemirror/lang-javascript"; | ||
export { EditorState } from "@codemirror/state"; | ||
export { javascriptLanguage, tsxLanguage } from "@codemirror/lang-javascript"; | ||
export { EditorState, Compartment } from "@codemirror/state"; | ||
export { EditorView, placeholder } from "@codemirror/view"; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,138 +1,118 @@ | ||
import { injectGlobal, css } from "@emotion/css"; | ||
import CodeMirror from "codemirror"; | ||
import React from "react"; | ||
import { colors } from "./styles"; | ||
import { | ||
Compartment, | ||
EditorState, | ||
basicSetup, | ||
EditorView, | ||
placeholder as placeholderExtension, | ||
oneDark, | ||
tsxLanguage, | ||
} from "../cm6.mjs"; | ||
// Only use type imports for @codemirror/* so that CodeMirror.tsx can share | ||
// the cm6.mjs with the mini-repl.js component | ||
import { type EditorState as EditorStateType } from "@codemirror/state"; | ||
import { | ||
type ViewUpdate, | ||
type EditorView as EditorViewType, | ||
} from "@codemirror/view"; | ||
import { preferDarkColorScheme } from "./Utils"; | ||
|
||
const DEFAULT_CODE_MIRROR_OPTIONS = { | ||
autoCloseBrackets: true, | ||
keyMap: "sublime", | ||
lineNumbers: true, | ||
matchBrackets: true, | ||
mode: "text/jsx", | ||
showCursorWhenSelecting: true, | ||
styleActiveLine: true, | ||
tabWidth: 2, | ||
theme: preferDarkColorScheme() ? "darcula" : "default", | ||
}; | ||
import React, { useRef, useEffect } from "react"; | ||
|
||
type Props = { | ||
autoFocus: boolean; | ||
onChange: (value: string) => void; | ||
options: any; | ||
onChange: (value: string) => void | null; | ||
options: { | ||
lineWrapping: boolean; | ||
readOnly: boolean; | ||
}; | ||
parentRef: React.MutableRefObject<HTMLElement>; | ||
placeholder?: string; | ||
value: string | undefined | null; | ||
preserveScrollPosition: boolean; | ||
}; | ||
|
||
type State = { | ||
isFocused: boolean; | ||
}; | ||
|
||
export default class ReactCodeMirror extends React.Component<Props, State> { | ||
static defaultProps = { | ||
autoFocus: false, | ||
preserveScrollPosition: false, | ||
// eslint-disable-next-line no-unused-vars | ||
onChange: (value: string) => {}, | ||
}; | ||
|
||
state = { | ||
isFocused: false, | ||
}; | ||
|
||
_codeMirror: any; | ||
_textAreaRef: HTMLTextAreaElement | null; | ||
|
||
componentDidMount() { | ||
this._codeMirror = CodeMirror.fromTextArea(this._textAreaRef, { | ||
...DEFAULT_CODE_MIRROR_OPTIONS, | ||
...this.props.options, | ||
export default function ReactCodeMirror({ | ||
value, | ||
onChange, | ||
options, | ||
parentRef, | ||
placeholder, | ||
preserveScrollPosition, | ||
}: Props) { | ||
const viewRef = useRef<EditorViewType>(null); | ||
const lineWrappingCompartmentRef = useRef<Compartment>(new Compartment()); | ||
|
||
useEffect(() => { | ||
const editorState: EditorStateType = EditorState.create({ | ||
doc: value, | ||
extensions: [ | ||
basicSetup, | ||
tsxLanguage, | ||
preferDarkColorScheme() ? oneDark : false, | ||
// We don't use compartment here since readonly can not be changed from UI | ||
EditorView.editable.of(!options.readOnly), | ||
placeholderExtension(placeholder), | ||
lineWrappingCompartmentRef.current.of([]), | ||
onChange && | ||
EditorView.updateListener.of((update: ViewUpdate) => { | ||
if (update.docChanged) { | ||
onChange(update.state.doc.toString()); | ||
} | ||
}), | ||
EditorView.theme({ | ||
"&": { | ||
backgroundColor: "#fff", | ||
height: "100%", | ||
maxHeight: "100%", | ||
}, | ||
}), | ||
].filter(Boolean), | ||
}); | ||
this._codeMirror.on("change", this._onChange); | ||
this._codeMirror.setValue(this.props.value || ""); | ||
} | ||
|
||
componentWillUnmount() { | ||
// is there a lighter-weight way to remove the cm instance? | ||
if (this._codeMirror) { | ||
this._codeMirror.toTextArea(); | ||
} | ||
} | ||
|
||
UNSAFE_componentWillReceiveProps(nextProps: Props) { | ||
if ( | ||
nextProps.value && | ||
nextProps.value !== this.props.value && | ||
this._codeMirror.getValue() !== nextProps.value | ||
) { | ||
if (nextProps.preserveScrollPosition) { | ||
const prevScrollPosition = this._codeMirror.getScrollInfo(); | ||
this._codeMirror.setValue(nextProps.value); | ||
this._codeMirror.scrollTo( | ||
prevScrollPosition.left, | ||
prevScrollPosition.top | ||
); | ||
} else { | ||
this._codeMirror.setValue(nextProps.value); | ||
} | ||
} else if (!nextProps.value) { | ||
this._codeMirror.setValue(""); | ||
} | ||
viewRef.current ??= new EditorView({ | ||
state: editorState, | ||
parent: parentRef.current, | ||
}); | ||
|
||
if (typeof nextProps.options === "object") { | ||
for (const optionName in nextProps.options) { | ||
if (nextProps.options.hasOwnProperty(optionName)) { | ||
this._updateOption(optionName, nextProps.options[optionName]); | ||
} | ||
return () => { | ||
if (viewRef.current) { | ||
viewRef.current.destroy(); | ||
viewRef.current = null; | ||
} | ||
} | ||
} | ||
}; | ||
}, []); | ||
|
||
focus() { | ||
if (this._codeMirror) { | ||
this._codeMirror.focus(); | ||
// handle value prop updates | ||
useEffect(() => { | ||
if (value == null) { | ||
return; | ||
} | ||
} | ||
|
||
render() { | ||
return ( | ||
<textarea | ||
autoComplete="off" | ||
autoFocus={this.props.autoFocus} | ||
defaultValue={this.props.value} | ||
ref={this._setTextAreaRef} | ||
placeholder={this.props.placeholder} | ||
/> | ||
); | ||
} | ||
|
||
_updateOption(optionName: string, newValue: any) { | ||
const oldValue = this._codeMirror.getOption(optionName); | ||
|
||
if (oldValue !== newValue) { | ||
this._codeMirror.setOption(optionName, newValue); | ||
const currentValue = viewRef.current?.state.doc.toString(); | ||
if (viewRef.current && value !== currentValue) { | ||
viewRef.current.dispatch({ | ||
changes: { | ||
from: 0, | ||
to: currentValue.length, | ||
insert: value, | ||
}, | ||
effects: [ | ||
preserveScrollPosition && | ||
EditorView.scrollIntoView(0, { | ||
yMargin: -viewRef.current.scrollDOM.scrollTop, | ||
}), | ||
].filter(Boolean), | ||
}); | ||
} | ||
} | ||
|
||
_onChange = (doc: any, change: any) => { | ||
if (change.origin !== "setValue") { | ||
this.props.onChange(doc.getValue()); | ||
}, [value]); | ||
|
||
// handle lineWrapping updates | ||
useEffect(() => { | ||
if (viewRef.current) { | ||
viewRef.current.dispatch({ | ||
effects: lineWrappingCompartmentRef.current.reconfigure( | ||
options.lineWrapping ? EditorView.lineWrapping : [] | ||
), | ||
}); | ||
} | ||
}; | ||
}, [options.lineWrapping]); | ||
|
||
_setTextAreaRef = (ref: HTMLTextAreaElement | null) => { | ||
this._textAreaRef = ref; | ||
}; | ||
return <></>; | ||
} | ||
|
||
injectGlobal({ | ||
".CodeMirror": { | ||
height: "100% !important", | ||
width: "100% !important", | ||
WebkitOverflowScrolling: "touch", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This CSS property is long obsolete. |
||
}, | ||
".CodeMirror pre.CodeMirror-placeholder.CodeMirror-line-like": css({ | ||
color: colors.foregroundLight, | ||
}), | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
import { css, type Interpolation } from "@emotion/css"; | ||
import { css, type CSSInterpolation } from "@emotion/css"; | ||
import CodeMirror from "./CodeMirror"; | ||
import React from "react"; | ||
import React, { useRef } from "react"; | ||
import { colors } from "./styles"; | ||
|
||
type Props = { | ||
|
@@ -9,33 +9,40 @@ type Props = { | |
errorMessage: string | undefined | null; | ||
info?: string | null; | ||
onChange?: (value: string) => void; | ||
options: any; | ||
options: { | ||
fileSize: boolean; | ||
lineWrapping: boolean; | ||
}; | ||
placeholder?: string; | ||
fileSize: string; | ||
}; | ||
|
||
export default function CodeMirrorPanel(props: Props) { | ||
const cmParentRef = useRef<HTMLDivElement>(null); | ||
const { | ||
className = "", | ||
code, | ||
errorMessage, | ||
fileSize, | ||
info, | ||
onChange, | ||
options, | ||
placeholder, | ||
} = props; | ||
|
||
return ( | ||
<div className={`${styles.panel} ${className}`}> | ||
<div className={styles.codeMirror}> | ||
<div className={styles.codeMirror} ref={cmParentRef}> | ||
<CodeMirror | ||
onChange={onChange} | ||
options={{ | ||
...props.options, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
lineWrapping: options.lineWrapping, | ||
readOnly: onChange == null, | ||
}} | ||
placeholder={props.placeholder} | ||
parentRef={cmParentRef} | ||
placeholder={placeholder} | ||
preserveScrollPosition={onChange == null} | ||
value={props.code} | ||
value={code} | ||
/> | ||
{options.fileSize && <div className={styles.fileSize}>{fileSize}</div>} | ||
</div> | ||
|
@@ -45,7 +52,7 @@ export default function CodeMirrorPanel(props: Props) { | |
); | ||
} | ||
|
||
const sharedBoxStyles: Interpolation = { | ||
const sharedBoxStyles: CSSInterpolation = { | ||
flex: "0 0 auto", | ||
maxHeight: "33%", | ||
overflow: "auto", | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -571,29 +571,9 @@ | |
</nav> | ||
<div class="navPusher"> | ||
<div> | ||
<link | ||
rel="stylesheet" | ||
type="text/css" | ||
href="https://unpkg.com/[email protected]/lib/codemirror.css" | ||
/> | ||
<link | ||
rel="stylesheet" | ||
type="text/css" | ||
href="https://unpkg.com/[email protected]/theme/darcula.css" | ||
/> | ||
<div id="root"> | ||
<noscript>You need to enable JavaScript to run this app.</noscript> | ||
</div> | ||
<script src="https://unpkg.com/[email protected]/lib/codemirror.js"></script> | ||
<script src="https://unpkg.com/[email protected]/mode/javascript/javascript.js"></script> | ||
<script src="https://unpkg.com/[email protected]/mode/xml/xml.js"></script> | ||
<script src="https://unpkg.com/[email protected]/mode/jsx/jsx.js"></script> | ||
<script src="https://unpkg.com/[email protected]/keymap/sublime.js"></script> | ||
<script src="https://unpkg.com/[email protected]/addon/comment/comment.js"></script> | ||
<script src="https://unpkg.com/[email protected]/addon/display/placeholder.js"></script> | ||
<script src="https://unpkg.com/[email protected]/addon/edit/matchbrackets.js"></script> | ||
<script src="https://unpkg.com/[email protected]/addon/search/searchcursor.js"></script> | ||
<script src="https://unpkg.com/[email protected]/addon/selection/active-line.js"></script> | ||
<script src="https://unpkg.com/[email protected]/libs/base64-string.js"></script> | ||
<script src="https://unpkg.com/[email protected]/libs/lz-string.min.js"></script> | ||
</div> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
autoFocus
prop is removed because we are not using this prop.