@finos/legend-lego 1.2.72 → 2.0.0

package/src/code-editor/CodeEditorUtils.ts

@@ -1,336 +0,0 @@
-/**
- * Copyright (c) 2020-present, Goldman Sachs
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import {
-  APPLICATION_EVENT,
-  DEFAULT_MONOSPACED_FONT_FAMILY,
-  type GenericLegendApplicationStore,
-} from '@finos/legend-application';
-import { LogEvent } from '@finos/legend-shared';
-import {
-  editor as monacoEditorAPI,
-  KeyCode,
-  KeyMod,
-  MarkerSeverity,
-} from 'monaco-editor';
-import {
-  CODE_EDITOR_THEME,
-  DEFAULT_DARK_THEME,
-  GITHUB_DARK_DIMMED_THEME,
-  GITHUB_DARK_THEME,
-  GITHUB_LIGHT_THEME,
-  MATERIAL_DARKER_THEME,
-  MATERIAL_DEFAULT_THEME,
-  ONE_DARK_PRO_DARKER_THEME,
-  ONE_DARK_PRO_THEME,
-  SOLARIZED_DARK_THEME,
-} from './CodeEditorTheme.js';
-
-export type CodeEditorPosition = {
-  lineNumber: number;
-  column: number;
-};
-
-/**
- * Normally `monaco-editor` worker disposes after 5 minutes staying idle, but we fasten
- * this pace just in case the usage of the editor causes memory-leak somehow
- */
-export const disposeCodeEditor = (
-  editor: monacoEditorAPI.IStandaloneCodeEditor,
-): void => {
-  editor.dispose();
-  // NOTE: just to be sure, we dispose the model after disposing the editor
-  editor.getModel()?.dispose();
-};
-
-export const disposeDiffCodeEditor = (
-  editor: monacoEditorAPI.IStandaloneDiffEditor,
-): void => {
-  editor.dispose();
-  editor.getOriginalEditor().getModel()?.dispose();
-  editor.getModifiedEditor().getModel()?.dispose();
-};
-
-/**
- * Get the text value with LF line ending.
- * This is needed since if there are CR `\r` characters in the text input
- * (e.g. users of Windows doing copy/paste)
- * the default mode of `monaco-editor` is `TextDefined` which means if the text
- * contains CR character(s), it will automatically be treated as CRLF. As such, we want
- * an utility method to extract the text value with line ending option LF
- * to force omission of CR characters
- * See https://github.com/finos/legend-studio/issues/608
- */
-export const getCodeEditorValue = (
-  editor: monacoEditorAPI.IStandaloneCodeEditor,
-): string =>
-  editor.getModel()?.getValue(monacoEditorAPI.EndOfLinePreference.LF) ?? '';
-
-export const getBaseCodeEditorOptions =
-  (): monacoEditorAPI.IStandaloneEditorConstructionOptions =>
-    ({
-      contextmenu: false,
-      copyWithSyntaxHighlighting: false,
-      // NOTE: These following font options are needed (and CSS font-size option `.monaco-editor * { font-size: ... }` as well)
-      // in order to make the editor appear properly on multiple platform, the ligatures option is needed for Mac to display properly
-      // otherwise the cursor position relatively to text would be off
-      // Another potential cause for this misaligment is that the fonts are being lazy-loaded and made available after `monaco-editor`
-      // calculated the font-width, for this, we can use `remeasureFonts`, but our case here, `fontLigatures: true` seems
-      // to do the trick
-      // See https://github.com/microsoft/monaco-editor/issues/392
-      fontSize: 14,
-      // Enforce a fixed font-family to make cross platform display consistent (i.e. Mac defaults to use `Menlo` which is bigger than
-      // `Consolas` on Windows, etc.)
-      fontFamily: 'Roboto Mono',
-      // Enable font ligature: glyphs which combine the shapes of certain sequences of characters into a new form that makes for
-      //  a more harmonious reading experience.
-      fontLigatures: true,
-      // Make sure hover or widget shown near boundary are not truncated by setting their position to `fixed`
-      fixedOverflowWidgets: true,
-      detectIndentation: false, // i.e. so we can force tab-size
-      tabSize: 2,
-      // The typing is currently not correct for `bracketPairColorization`, until this is fixed, we will remove the cast
-      // See https://github.com/microsoft/monaco-editor/issues/3013
-      'bracketPairColorization.enabled': false,
-      automaticLayout: true,
-    }) as monacoEditorAPI.IStandaloneEditorConstructionOptions;
-
-export const getBaseConsoleOptions =
-  (): monacoEditorAPI.IStandaloneEditorConstructionOptions => ({
-    ...getBaseCodeEditorOptions(),
-    fontSize: 12,
-    extraEditorClassName: 'monaco-editor--small-font',
-    readOnly: true,
-    glyphMargin: false,
-    folding: false,
-    lineNumbers: 'off',
-    lineDecorationsWidth: 10,
-    lineNumbersMinChars: 0,
-    minimap: {
-      enabled: false,
-    },
-    guides: {
-      bracketPairs: false,
-      bracketPairsHorizontal: false,
-      highlightActiveBracketPair: false,
-      indentation: false,
-      highlightActiveIndentation: false,
-    },
-    renderLineHighlight: 'none',
-  });
-
-export const moveCursorToPosition = (
-  editor: monacoEditorAPI.ICodeEditor,
-  position: CodeEditorPosition,
-): void => {
-  if (!editor.hasTextFocus()) {
-    editor.focus();
-  } // focus the editor first so that it can shows the cursor
-  editor.revealPositionInCenter(position, 0);
-  editor.setPosition(position);
-};
-
-const INTERNAL__DUMMY_PROBLEM_MARKER_OWNER = 'dummy_problem_marker_owner';
-
-export const setErrorMarkers = (
-  editorModel: monacoEditorAPI.ITextModel,
-  errors: {
-    message: string;
-    startLineNumber: number;
-    startColumn: number;
-    endLineNumber: number;
-    endColumn: number;
-  }[],
-  ownerId?: string,
-): void => {
-  monacoEditorAPI.setModelMarkers(
-    editorModel,
-    ownerId ?? INTERNAL__DUMMY_PROBLEM_MARKER_OWNER,
-    errors.map((error) => ({
-      startLineNumber: error.startLineNumber,
-      startColumn: error.startColumn,
-      endLineNumber: error.endLineNumber,
-      endColumn: error.endColumn + 1, // add a 1 to endColumn as monaco editor range is not inclusive
-      // NOTE: when the message is empty, no error tooltip is shown, we want to avoid this
-      message: error.message === '' ? '(no error message)' : error.message,
-      severity: MarkerSeverity.Error,
-    })),
-  );
-};
-
-export const setWarningMarkers = (
-  editorModel: monacoEditorAPI.ITextModel,
-  warnings: {
-    message: string;
-    startLineNumber: number;
-    startColumn: number;
-    endLineNumber: number;
-    endColumn: number;
-  }[],
-  ownerId?: string,
-): void => {
-  monacoEditorAPI.setModelMarkers(
-    editorModel,
-    ownerId ?? INTERNAL__DUMMY_PROBLEM_MARKER_OWNER,
-    warnings.map((warning) => ({
-      startLineNumber: warning.startLineNumber,
-      startColumn: warning.startColumn,
-      endColumn: warning.endColumn,
-      endLineNumber: warning.endLineNumber,
-      message:
-        warning.message === '' ? '(no warning message)' : warning.message,
-      severity: MarkerSeverity.Warning,
-    })),
-  );
-};
-
-export const clearMarkers = (ownerId?: string): void => {
-  monacoEditorAPI.removeAllMarkers(
-    ownerId ?? INTERNAL__DUMMY_PROBLEM_MARKER_OWNER,
-  );
-};
-
-/**
- * This method eliminates CR '\r' character(s) in the provided text value.
- */
-export const normalizeLineEnding = (val: string): string =>
-  val.replace(/\r/g, '');
-
-// We need to dynamically adjust the width of the line number gutter, otherwise as the document gets
-// larger, the left margin will start to shrink
-// See https://github.com/microsoft/monaco-editor/issues/2206
-export const resetLineNumberGutterWidth = (
-  editor: monacoEditorAPI.ICodeEditor,
-): void => {
-  const currentValue = editor.getValue();
-  editor.updateOptions({
-    lineNumbersMinChars: Math.max(
-      Math.floor(Math.log10(currentValue.split(/\r\n|\r|\n/g).length)) + 3,
-      5,
-    ),
-  });
-};
-
-export const configureCodeEditorComponent = async (
-  applicationStore: GenericLegendApplicationStore,
-): Promise<void> => {
-  /**
-   * Since we use a custom fonts for text-editor, we want to make sure the font is loaded before any text-editor is opened
-   * this is to ensure
-   */
-  const fontLoadFailureErrorMessage = `Monospaced font '${DEFAULT_MONOSPACED_FONT_FAMILY}' has not been loaded properly, code editor might not display properly`;
-  await Promise.all(
-    [400, 700].map((weight) =>
-      document.fonts.load(`${weight} 1em ${DEFAULT_MONOSPACED_FONT_FAMILY}`),
-    ),
-  )
-    .then(() => {
-      if (document.fonts.check(`1em ${DEFAULT_MONOSPACED_FONT_FAMILY}`)) {
-        monacoEditorAPI.remeasureFonts();
-      } else {
-        applicationStore.logService.error(
-          LogEvent.create(APPLICATION_EVENT.APPLICATION_SETUP__FAILURE),
-          fontLoadFailureErrorMessage,
-        );
-      }
-    })
-    .catch(() =>
-      applicationStore.logService.error(
-        LogEvent.create(APPLICATION_EVENT.APPLICATION_SETUP__FAILURE),
-        fontLoadFailureErrorMessage,
-      ),
-    );
-
-  // override native hotkeys supported by monaco-editor
-  // here we map these keys to a dummy command that would just dispatch the key combination
-  // to the application keyboard shortcut service, effectively bypassing the command associated
-  // with the native keybinding
-  const OVERRIDE_DEFAULT_KEYBINDING_COMMAND =
-    'legend.code-editor.override-default-keybinding';
-  monacoEditorAPI.registerCommand(
-    OVERRIDE_DEFAULT_KEYBINDING_COMMAND,
-    (accessor, ...args) => {
-      applicationStore.keyboardShortcutsService.dispatch(args[0]);
-    },
-  );
-  const hotkeyMapping: [number, string][] = [
-    [KeyCode.F1, 'F1'], // show command center
-    [KeyCode.F8, 'F8'], // show error
-    [KeyCode.F9, 'F9'], // toggle debugger breakpoint
-    [KeyMod.WinCtrl | KeyCode.KeyG, 'Control+KeyG'], // go-to line command
-    [KeyMod.WinCtrl | KeyCode.KeyB, 'Control+KeyB'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyO, 'Control+KeyO'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyD, 'Control+KeyD'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyP, 'Control+KeyP'], // cursor move (core command)
-    [KeyMod.Shift | KeyCode.F10, 'Shift+F10'], // show editor context menu
-    [KeyMod.WinCtrl | KeyCode.F2, 'Control+F2'], // change all instances
-    [KeyMod.WinCtrl | KeyCode.F12, 'Control+F12'], // go-to definition
-  ];
-  monacoEditorAPI.addKeybindingRules(
-    hotkeyMapping.map(([nativeCodeEditorKeyBinding, keyCombination]) => ({
-      keybinding: nativeCodeEditorKeyBinding,
-      command: OVERRIDE_DEFAULT_KEYBINDING_COMMAND,
-      commandArgs: keyCombination,
-    })),
-  );
-
-  // themes
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.DEFAULT_DARK,
-    DEFAULT_DARK_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.SOLARIZED_DARK,
-    SOLARIZED_DARK_THEME,
-  );
-  monacoEditorAPI.defineTheme(CODE_EDITOR_THEME.GITHUB_DARK, GITHUB_DARK_THEME);
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.GITHUB_DARK_DIMMED,
-    GITHUB_DARK_DIMMED_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.GITHUB_LIGHT,
-    GITHUB_LIGHT_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.MATERIAL_DEFAULT,
-    MATERIAL_DEFAULT_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.MATERIAL_DARKER,
-    MATERIAL_DARKER_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.ONE_DARK_PRO,
-    ONE_DARK_PRO_THEME,
-  );
-  monacoEditorAPI.defineTheme(
-    CODE_EDITOR_THEME.ONE_DARK_PRO_DARKER,
-    ONE_DARK_PRO_DARKER_THEME,
-  );
-};
-
-export enum CODE_EDITOR_LANGUAGE {
-  TEXT = 'plaintext',
-  PURE = 'pure',
-  JSON = 'json',
-  JAVA = 'java',
-  MARKDOWN = 'markdown',
-  SQL = 'sql',
-  XML = 'xml',
-  YAML = 'yaml',
-  GRAPHQL = 'graphql',
-}

package/src/code-editor/PureLanguage.ts

@@ -1,42 +0,0 @@
-/**
- * Copyright (c) 2020-present, Goldman Sachs
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-export enum PURE_GRAMMAR_TOKEN {
-  WHITESPACE = '',
-
-  KEYWORD = 'keyword',
-  IDENTIFIER = 'identifier',
-  OPERATOR = 'operator',
-  DELIMITER = 'delimiter',
-
-  PARSER = 'parser',
-  NUMBER = 'number',
-  DATE = 'date',
-  COLOR = 'color',
-  PACKAGE = 'package',
-  STRING = 'string',
-  COMMENT = 'comment',
-
-  LANGUAGE_STRUCT = 'language-struct',
-  MULTIPLICITY = 'multiplicity',
-  GENERICS = 'generics',
-  PROPERTY = 'property',
-  PARAMETER = 'parameter',
-  VARIABLE = 'variable',
-  TYPE = 'type',
-
-  INVALID = 'invalid',
-}