Skip to content

Visualize Your Ideas With Code

feat(docs): import folding (#706)

Jacobbdb035f045f9
diff --git a/packages/docs/src/components/Fiddle/folding.ts b/packages/docs/src/components/Fiddle/folding.ts
new file mode 100644
index 00000000..a764a103
--- /dev/null
+++ b/packages/docs/src/components/Fiddle/folding.ts
@@ -0,0 +1,99 @@
+import {EditorState, Extension} from '@codemirror/state';
+import {
+ foldService,
+ syntaxTree,
+ foldEffect,
+ foldState,
+} from '@codemirror/language';
+import {EditorView} from '@codemirror/view';
+
+const FoldOffset = 'import '.length;
+
+/**
+ * Find a range that encompasses all import statements in the source code.
+ *
+ * @param state - The editor state.
+ * @param range - An optional range to check if the imports are within.
+ */
+export function findImportRange(
+ state: EditorState,
+ range?: {from: number; to: number},
+) {
+ const tree = syntaxTree(state);
+ let currentNode = tree.topNode.firstChild;
+ let firstImport: typeof currentNode = null;
+ while (currentNode) {
+ if (currentNode.type.is('ImportDeclaration')) {
+ firstImport = currentNode;
+ break;
+ }
+ currentNode = currentNode.nextSibling;
+ }
+
+ if (!firstImport) {
+ return null;
+ }
+
+ if (range) {
+ const line = state.doc.lineAt(firstImport.from);
+ if (line.from > range.to || line.to < range.from) {
+ return null;
+ }
+ }
+
+ let lastImport = firstImport;
+ while (lastImport) {
+ const nextNode = lastImport.nextSibling;
+ if (!nextNode.type.is('ImportDeclaration')) {
+ break;
+ }
+ lastImport = nextNode;
+ }
+
+ return {
+ from: firstImport.from + FoldOffset,
+ to: lastImport.to,
+ };
+}
+
+/**
+ * Create a CodeMirror extension that folds all import statements in the source
+ * code.
+ */
+export function folding(): Extension {
+ return foldService.of((state, from, to) => {
+ return findImportRange(state, {from, to});
+ });
+}
+
+/**
+ * Fold import statements in the editor.
+ *
+ * @param view - The editor view.
+ */
+export function foldImports(view: EditorView) {
+ const {state} = view;
+
+ const range = findImportRange(state);
+ if (range) {
+ view.dispatch({
+ effects: [foldEffect.of(range)],
+ });
+ }
+}
+
+/**
+ * Check if the imports are folded.
+ *
+ * @param state - The editor state.
+ */
+export function areImportsFolded(state: EditorState) {
+ const range = findImportRange(state);
+ let folded = false;
+ state.field(foldState, false).between(range.from, range.to, () => {
+ folded = true;
+ return false;
+ });
+
+ return folded;
+}
diff --git a/packages/docs/src/components/Fiddle/index.tsx b/packages/docs/src/components/Fiddle/index.tsx
index 7a2442e9..d52c0242 100644
--- a/packages/docs/src/components/Fiddle/index.tsx
+++ b/packages/docs/src/components/Fiddle/index.tsx
@@ -33,6 +33,12 @@ import {
import {parseFiddle} from '@site/src/components/Fiddle/parseFiddle';
import Dropdown from '@site/src/components/Dropdown';
import clsx from 'clsx';
+import {
+ areImportsFolded,
+ findImportRange,
+ foldImports,
+ folding,
+} from '@site/src/components/Fiddle/folding';
export interface FiddleProps {
className?: string;
@@ -99,6 +105,16 @@ export default function Fiddle({
}
};
+ const switchState = (id: number) => {
+ setSnippetId(id);
+ const isFolded = areImportsFolded(editorView.current.state);
+ editorView.current.setState(snippets[id].state);
+ update(snippets[id].state.doc);
+ if (isFolded) {
+ foldImports(editorView.current);
+ }
+ };
+
const [snippetId, setSnippetId] = useState(0);
const snippets = useMemo(
() =>
@@ -121,9 +137,12 @@ export default function Fiddle({
]),
EditorView.updateListener.of(update => {
setDoc(update.state.doc);
- setError(null);
+ if (update.docChanged) {
+ setError(null);
+ }
}),
autocomplete(),
+ folding(),
javascript({
jsx: true,
typescript: true,
@@ -141,6 +160,8 @@ export default function Fiddle({
parent: editorRef.current,
state: snippets[snippetId].state,
});
+ foldImports(editorView.current);
+
const borrowed = tryBorrowPlayer(
setPlayer,
previewRef.current,
@@ -159,6 +180,17 @@ export default function Fiddle({
};
}, []);
+ // Ghost code is displayed before the editor is initialized.
+ const ghostCode = useMemo(() => {
+ const initialState = snippets[0].state;
+ const range = findImportRange(initialState);
+ let text = initialState.doc;
+ if (range) {
+ text = text.replace(range.from, range.to, Text.of(['...']));
+ }
+ return text.toString() + '\n';
+ }, [snippets]);
+
const hasChangedSinceLastUpdate = lastDoc && doc && !doc.eq(lastDoc);
const hasChanged =
(doc && !doc.eq(snippets[snippetId].state.doc)) ||
@@ -259,15 +291,8 @@ export default function Fiddle({
</button>
</div>
<div className={styles.section}>
- {snippets.length === 0 && hasChanged && (
- <button
- className={styles.button}
- onClick={() => {
- editorView.current.setState(snippets[snippetId].state);
- update(snippets[snippetId].state.doc);
- setDoc(snippets[snippetId].state.doc);
- }}
- >
+ {snippets.length === 1 && hasChanged && (
+ <button className={styles.button} onClick={() => switchState(0)}>
<small>Reset example</small>
</button>
)}
@@ -275,11 +300,7 @@ export default function Fiddle({
<Dropdown
className={styles.picker}
value={hasChanged ? -1 : snippetId}
- onChange={id => {
- setSnippetId(id);
- editorView.current.setState(snippets[id].state);
- update(snippets[id].state.doc);
- }}
+ onChange={switchState}
options={snippets
.map((snippet, index) => ({
value: index,
@@ -293,7 +314,9 @@ export default function Fiddle({
{error && <pre className={styles.error}>{error.message}</pre>}
<div className={styles.editor} ref={editorRef}>
<CodeBlock className={styles.source} language="tsx">
- {snippets[0].state.doc.toString() + (mode === 'code' ? '' : '\n')}
+ {mode === 'code'
+ ? snippets[snippetId].state.doc.toString()
+ : ghostCode}
</CodeBlock>
</div>
</div>
diff --git a/packages/docs/src/components/Fiddle/styles.module.css b/packages/docs/src/components/Fiddle/styles.module.css
index fdf6e254..708dfcb4 100644
--- a/packages/docs/src/components/Fiddle/styles.module.css
+++ b/packages/docs/src/components/Fiddle/styles.module.css
@@ -98,6 +98,7 @@
margin: 0;
border-top: 1px solid var(--ifm-color-danger-dark);
border-bottom: 1px solid var(--ifm-color-danger-dark);
+ white-space: pre-wrap;
}
.editor {