/** * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ import styles from "./monaco-editor.module.scss"; import React from "react"; import { observer } from "mobx-react"; import type { IComputedValue } from "mobx"; import { action, computed, makeObservable, observable, reaction } from "mobx"; import { editor, Uri } from "monaco-editor"; import type { MonacoTheme } from "./monaco-themes"; import { type MonacoValidator, monacoValidators } from "./monaco-validators"; import { debounce, merge } from "lodash"; import { autoBind, cssNames, disposer } from "../../utils"; import type { UserStore } from "../../../common/user-store"; import type { LensTheme } from "../../themes/lens-theme"; import { withInjectables } from "@ogre-tools/injectable-react"; import userStoreInjectable from "../../../common/user-store/user-store.injectable"; import activeThemeInjectable from "../../themes/active.injectable"; import getEditorHeightFromLinesCountInjectable from "./get-editor-height-from-lines-number.injectable"; import type { Logger } from "../../../common/logger"; import loggerInjectable from "../../../common/logger.injectable"; export type MonacoEditorId = string; export interface MonacoEditorProps { id?: MonacoEditorId; // associating editor's ID with created model.uri className?: string; style?: React.CSSProperties; autoFocus?: boolean; readOnly?: boolean; theme?: MonacoTheme; language?: "yaml" | "json"; // supported list of languages, configure in `webpack.renderer.ts` options?: Partial; // customize editor's initialization options value: string; onChange?(value: string, evt: editor.IModelContentChangedEvent): void; // catch latest value updates onError?(error: unknown): void; // provide syntax validation error, etc. onDidLayoutChange?(info: editor.EditorLayoutInfo): void; onDidContentSizeChange?(evt: editor.IContentSizeChangedEvent): void; onModelChange?(model: editor.ITextModel, prev?: editor.ITextModel): void; innerRef?: React.ForwardedRef; setInitialHeight?: boolean; } interface Dependencies { userStore: UserStore; activeTheme: IComputedValue; getEditorHeightFromLinesCount: (linesCount: number) => number; logger: Logger; } export function createMonacoUri(id: MonacoEditorId): Uri { return Uri.file(`/monaco-editor/${id}`); } const monacoViewStates = new WeakMap(); export interface MonacoEditorRef { focus(): void; } @observer class NonInjectedMonacoEditor extends React.Component { static defaultProps = { language: "yaml" as const, }; private staticId = `editor-id#${Math.round(1e7 * Math.random())}`; private dispose = disposer(); @observable.ref containerElem: HTMLDivElement | null = null; @observable.ref editor!: editor.IStandaloneCodeEditor; @observable readonly dimensions: { width?: number; height?: number } = {}; @observable unmounting = false; // TODO: investigate how to replace with "common/logger" // currently leads for stucking UI forever & infinite loop. // e.g. happens on tab change/create, maybe some other cases too. private logger = console; constructor(props: MonacoEditorProps & Dependencies) { super(props); makeObservable(this); autoBind(this); } @computed get id(): MonacoEditorId { return this.props.id ?? this.staticId; } @computed get theme() { return this.props.theme ?? this.props.activeTheme.get().monacoTheme; } @computed get model(): editor.ITextModel { const uri = createMonacoUri(this.id); const model = editor.getModel(uri); if (model) { return model; // already exists } const { language, value: rawValue } = this.props; const value = typeof rawValue === "string" ? rawValue : ""; if (typeof rawValue !== "string") { this.props.logger.error(`[MONACO-EDITOR]: Passed a non-string default value`, { rawValue }); } return editor.createModel(value, language, uri); } @computed get options(): editor.IStandaloneEditorConstructionOptions { return merge({}, this.props.userStore.editorConfiguration, this.props.options, ); } @computed private get logMetadata() { return { editorId: this.id, model: this.model, }; } /** * Monitor editor's dom container element box-size and sync with monaco's dimensions * @private */ private bindResizeObserver() { const resizeObserver = new ResizeObserver(entries => { for (const entry of entries) { const { width, height } = entry.contentRect; this.setDimensions(width, height); } }); const containerElem = this.editor.getContainerDomNode(); resizeObserver.observe(containerElem); return () => resizeObserver.unobserve(containerElem); } protected onModelChange(model: editor.ITextModel, oldModel?: editor.ITextModel) { this.logger.info("[MONACO]: model change", { model, oldModel }, this.logMetadata); if (oldModel) { this.saveViewState(oldModel); } this.editor.setModel(model); this.restoreViewState(model); this.editor.layout(); this.editor.focus(); // keep focus in editor, e.g. when clicking between dock-tabs this.props.onModelChange?.(model, oldModel); this.validateLazy(); } /** * Save current view-model state in the editor. * This will allow restore cursor position, selected text, etc. */ protected saveViewState(model: editor.ITextModel) { const viewState = this.editor?.saveViewState(); if (viewState) { monacoViewStates.set(model.uri, viewState); } } protected restoreViewState(model: editor.ITextModel) { const viewState = monacoViewStates.get(model.uri); if (viewState) { this.editor?.restoreViewState(viewState); } } componentDidMount() { try { this.createEditor(); this.logger.info(`[MONACO]: editor did mount`, this.logMetadata); } catch (error) { this.logger.error(`[MONACO]: mounting failed: ${error}`, this.logMetadata); } } componentWillUnmount() { this.unmounting = true; this.saveViewState(this.model); if (this.editor) { this.dispose(); this.editor.dispose(); } } protected createEditor() { if (!this.containerElem || this.editor || this.unmounting) { return; } const { language, readOnly, value: defaultValue } = this.props; const { theme } = this; this.editor = editor.create(this.containerElem, { model: this.model, detectIndentation: false, // allow `option.tabSize` to use custom number of spaces for [Tab] value: defaultValue, language, theme, readOnly, ...this.options, }); this.logger.info(`[MONACO]: editor created for language=${language}, theme=${theme}`, this.logMetadata); this.validateLazy(); // validate initial value this.restoreViewState(this.model); // restore previous state if any if (this.props.autoFocus) { this.editor.focus(); } const onDidLayoutChangeDisposer = this.editor.onDidLayoutChange(layoutInfo => { this.props.onDidLayoutChange?.(layoutInfo); }); const onValueChangeDisposer = this.editor.onDidChangeModelContent(event => { const value = this.editor.getValue(); this.props.onChange?.(value, event); this.validateLazy(value); }); const onContentSizeChangeDisposer = this.editor.onDidContentSizeChange((params) => { this.props.onDidContentSizeChange?.(params); }); this.dispose.push( reaction(() => this.model, this.onModelChange), reaction(() => this.theme, theme => { if (theme) { editor.setTheme(theme); } }), reaction(() => this.props.value, value => this.setValue(value)), reaction(() => this.options, opts => this.editor.updateOptions(opts)), () => onDidLayoutChangeDisposer.dispose(), () => onValueChangeDisposer.dispose(), () => onContentSizeChangeDisposer.dispose(), this.bindResizeObserver(), ); } @action setDimensions(width: number, height: number) { this.dimensions.width = width; this.dimensions.height = height; this.editor?.layout({ width, height }); } setValue(value = ""): void { if (value == this.getValue()) return; this.editor.setValue(value); this.validate(value); } getValue(opts?: { preserveBOM: boolean; lineEnding: string }): string { return this.editor?.getValue(opts) ?? ""; } focus() { this.editor?.focus(); } @action validate(value = this.getValue()) { const validators: MonacoValidator[] = [ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion monacoValidators[this.props.language!], // parsing syntax check ].filter(Boolean); for (const validate of validators) { try { validate(value); } catch (error) { this.props.onError?.(error); // emit error outside } } } // avoid excessive validations during typing validateLazy = debounce(this.validate, 250); get initialHeight() { return this.props.getEditorHeightFromLinesCount(this.model.getLineCount()); } render() { const { className, style } = this.props; const css: React.CSSProperties = { ...style, height: style?.height ?? this.initialHeight, }; return (
this.containerElem = elem} /> ); } } export const MonacoEditor = withInjectables( React.forwardRef((props, ref) => ), { getProps: (di, props) => ({ ...props, userStore: di.inject(userStoreInjectable), activeTheme: di.inject(activeThemeInjectable), getEditorHeightFromLinesCount: di.inject(getEditorHeightFromLinesCountInjectable), logger: di.inject(loggerInjectable), }), }, );