misc_pterodactyl-panel/resources/scripts/components/elements/editor/Editor.tsx
2023-01-12 12:08:11 -07:00

233 lines
6.3 KiB
TypeScript

import { autocompletion, completionKeymap, closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
import {
defaultHighlightStyle,
syntaxHighlighting,
indentOnInput,
bracketMatching,
foldGutter,
foldKeymap,
indentUnit,
LanguageDescription,
LanguageSupport,
} from '@codemirror/language';
import { languages } from '@codemirror/language-data';
import { lintKeymap } from '@codemirror/lint';
import { searchKeymap, highlightSelectionMatches } from '@codemirror/search';
import type { Extension } from '@codemirror/state';
import { EditorState, Compartment } from '@codemirror/state';
import {
keymap,
highlightSpecialChars,
drawSelection,
highlightActiveLine,
dropCursor,
rectangularSelection,
crosshairCursor,
lineNumbers,
highlightActiveLineGutter,
EditorView,
} from '@codemirror/view';
import type { CSSProperties } from 'react';
import { useEffect, useRef, useState } from 'react';
import type { TwStyle } from 'twin.macro';
import tw, { styled } from 'twin.macro';
import { ayuMirageHighlightStyle, ayuMirageTheme } from './theme';
function findLanguageByFilename(filename: string): LanguageDescription | undefined {
const language = LanguageDescription.matchFilename(languages, filename);
if (language !== null) {
return language;
}
return undefined;
}
const defaultExtensions: Extension = [
// Ayu Mirage
ayuMirageTheme,
syntaxHighlighting(ayuMirageHighlightStyle),
lineNumbers(),
highlightActiveLineGutter(),
highlightSpecialChars(),
history(),
foldGutter(),
drawSelection(),
dropCursor(),
EditorState.allowMultipleSelections.of(true),
indentOnInput(),
syntaxHighlighting(defaultHighlightStyle, { fallback: true }),
bracketMatching(),
closeBrackets(),
autocompletion(),
rectangularSelection(),
crosshairCursor(),
highlightActiveLine(),
highlightSelectionMatches(),
keymap.of([
...closeBracketsKeymap,
...defaultKeymap,
...searchKeymap,
...historyKeymap,
...foldKeymap,
...completionKeymap,
...lintKeymap,
indentWithTab,
]),
EditorState.tabSize.of(4),
indentUnit.of('\t'),
];
const EditorContainer = styled.div<{ overrides?: TwStyle }>`
//min-height: 12rem;
${tw`relative`};
& > div {
${props => props.overrides};
&.cm-focused {
outline: none;
}
}
`;
export interface EditorProps {
// DOM
className?: string;
style?: CSSProperties;
childClassName?: TwStyle;
// CodeMirror Config
extensions?: Extension[];
language?: LanguageDescription;
// Options
filename?: string;
initialContent?: string;
// ?
fetchContent?: (callback: () => Promise<string>) => void;
// Events
onContentSaved?: () => void;
onLanguageChanged?: (language: LanguageDescription | undefined) => void;
}
export function Editor(props: EditorProps) {
const ref = useRef<HTMLDivElement>(null);
const [view, setView] = useState<EditorView>();
// eslint-disable-next-line react/hook-use-state
const [languageConfig] = useState(new Compartment());
// eslint-disable-next-line react/hook-use-state
const [keybindings] = useState(new Compartment());
const [languageSupport, setLanguageSupport] = useState<LanguageSupport>();
const createEditorState = () =>
EditorState.create({
doc: props.initialContent,
extensions: [
defaultExtensions,
props.extensions === undefined ? [] : props.extensions,
languageConfig.of(languageSupport ?? []),
keybindings.of([]),
],
});
useEffect(() => {
if (ref.current === null) {
return;
}
if (view === undefined) {
setView(
new EditorView({
state: createEditorState(),
parent: ref.current,
}),
);
} else {
// Fully replace the state whenever the initial content changes, this prevents any unrelated
// history (for undo and redo) from being tracked.
view.setState(createEditorState());
}
return () => {
if (view === undefined) {
return;
}
view.destroy();
setView(undefined);
};
}, [ref, view, props.initialContent]);
useEffect(() => {
if (view === undefined) {
return;
}
const language = props.language ?? findLanguageByFilename(props.filename ?? '');
if (language === undefined) {
return;
}
void language.load().then(support => {
setLanguageSupport(support);
});
if (props.onLanguageChanged !== undefined) {
props.onLanguageChanged(language);
}
}, [view, props.filename, props.language]);
useEffect(() => {
if (languageSupport === undefined || view === undefined) {
return;
}
view.dispatch({
effects: languageConfig.reconfigure(languageSupport),
});
}, [view, languageSupport]);
useEffect(() => {
if (props.fetchContent === undefined) {
return;
}
if (!view) {
props.fetchContent(async () => {
throw new Error('no editor session has been configured');
});
return;
}
const { onContentSaved } = props;
if (onContentSaved !== undefined) {
view.dispatch({
effects: keybindings.reconfigure(
keymap.of([
{
key: 'Mod-s',
run() {
onContentSaved();
return true;
},
},
]),
),
});
}
props.fetchContent(async () => view.state.doc.toJSON().join('\n'));
}, [view, props.fetchContent, props.onContentSaved]);
return (
<EditorContainer ref={ref} className={props.className} style={props.style} overrides={props.childClassName} />
);
}