Use CodeMirror 6 in REPL #3014
There are no files selected for viewing
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 |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| export { basicSetup } from "codemirror"; | ||
| export { oneDark } from "@codemirror/theme-one-dark"; | ||
| export { javascriptLanguage, tsxLanguage } from "@codemirror/lang-javascript"; | ||
| export { EditorState, Compartment } from "@codemirror/state"; | ||
| export { EditorView, placeholder } from "@codemirror/view"; |
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 |
|---|---|---|
| @@ -1,138 +1,134 @@ | ||
| 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 { injectGlobal } from "@emotion/css"; | ||
| import { preferDarkColorScheme } from "./Utils"; | ||
| import React, { useRef, useEffect } from "react"; | ||
|
|
||
| type Props = { | ||
| onChange: (value: string) => void | null; | ||
| options: { | ||
| lineWrapping: boolean; | ||
| readOnly: boolean; | ||
| }; | ||
| placeholder?: string; | ||
| value: string | undefined | null; | ||
| preserveScrollPosition: boolean; | ||
| }; | ||
|
|
||
| export default function ReactCodeMirror({ | ||
| value, | ||
| onChange, | ||
| options, | ||
| placeholder, | ||
| preserveScrollPosition, | ||
| }: Props) { | ||
| const parentRef = useRef<HTMLDivElement>(null); | ||
| const viewRef = useRef<EditorViewType>(null); | ||
| const lineWrappingCompartment = 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), | ||
| lineWrappingCompartment.of([]), | ||
| onChange && | ||
| EditorView.updateListener.of((update: ViewUpdate) => { | ||
| if (update.docChanged) { | ||
| onChange(update.state.doc.toString()); | ||
| } | ||
| }), | ||
| EditorView.theme({ | ||
| "&": { | ||
| height: "100%", | ||
| maxHeight: "100%", | ||
| }, | ||
| }), | ||
| ].filter(Boolean), | ||
| }); | ||
|
|
||
| viewRef.current ??= new EditorView({ | ||
| state: editorState, | ||
| parent: parentRef.current, | ||
| }); | ||
|
|
||
| return () => { | ||
| if (viewRef.current) { | ||
| viewRef.current.destroy(); | ||
| viewRef.current = null; | ||
| } | ||
| }; | ||
| }, []); | ||
|
|
||
| // handle value prop updates | ||
| useEffect(() => { | ||
| if (value == null) { | ||
| return; | ||
| } | ||
| 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), | ||
| }); | ||
| } | ||
| }, [value]); | ||
|
|
||
| // handle lineWrapping updates | ||
| useEffect(() => { | ||
| if (viewRef.current) { | ||
| // todo: investigate why the dispatch does not work and remove the DOM manipulations below | ||
| // viewRef.current.dispatch({ | ||
| // effects: lineWrappingCompartment.reconfigure( | ||
| // options.lineWrapping ? EditorView.lineWrapping : [] | ||
| // ), | ||
| // }); | ||
| if (options.lineWrapping) { | ||
| parentRef.current | ||
| .querySelector(".cm-content") | ||
| .classList.add("cm-lineWrapping"); | ||
| } else { | ||
| parentRef.current | ||
| .querySelector(".cm-content") | ||
| .classList.remove("cm-lineWrapping"); | ||
| } | ||
|
There was a problem hiding this comment. I have to resort to DOM manipulations as the compartment update approach does not work, though it works for simple cases: https://codesandbox.io/p/sandbox/codemirror-6-demo-pl8dc Helps are welcomed. |
||
| } | ||
| }, [options.lineWrapping]); | ||
|
|
||
| return <div ref={parentRef} className="CodeMirror" />; | ||
| } | ||
|
|
||
| injectGlobal({ | ||
| ".CodeMirror": { | ||
| height: "100% !important", | ||
|
There was a problem hiding this comment. This CSS property is long obsolete. |
||
| background: "#fff", | ||
| }, | ||
| }); | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -571,29 +571,9 @@ | |
| </nav> | ||
| <div class="navPusher"> | ||
| <div> | ||
| <div id="root"> | ||
| <noscript>You need to enable JavaScript to run this app.</noscript> | ||
| </div> | ||
| <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> | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,7 +45,6 @@ const config = { | |
| }), | ||
| ], | ||
| externals: { | ||
| "lz-string": "LZString", | ||
| }, | ||
| performance: { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
autoFocusprop is removed because we are not using this prop.