Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improvement(code): migrate to monaco editor #7365

Draft
wants to merge 16 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .bitmap
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,13 @@
"mainFile": "index.ts",
"rootDir": "scopes/code/ui/code-compare"
},
"ui/code-editor": {
"scope": "",
"version": "",
"defaultScope": "teambit.code",
"mainFile": "index.ts",
"rootDir": "scopes/code/ui/code-editor"
},
"ui/code-tab-page": {
"scope": "teambit.code",
"version": "0.0.614",
Expand All @@ -1335,6 +1342,12 @@
"mainFile": "index.ts",
"rootDir": "scopes/code/ui/code-tab-tree"
},
"ui/code-view": {
"scope": "teambit.code",
"version": "5e2b49420c500d4d88e1b05aa232061abc0fa0a7",
"mainFile": "index.ts",
"rootDir": "components/ui/code-view"
},
"ui/compare/lane-compare": {
"scope": "teambit.lanes",
"version": "0.0.92",
Expand Down
84 changes: 84 additions & 0 deletions components/ui/code-view/code-view.module.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
@import '~@teambit/ui-foundation.ui.constants.z-indexes/z-indexes.module.scss';

.codeViewTitle {
display: flex;
height: 40px;
}

.img {
width: 20px;
margin-right: 10px;
}

.fileName {
display: flex;
align-items: baseline;
}

.componentCodeViewContainer {
display: flex;
width: calc(100% - 80px);
flex: 1;
padding: 24px 40px;
flex-direction: column;
transition: min-height 0.4s ease-in-out;
height: calc(100% - 48px);
min-height: calc(100% - 48px);
˝ &.loading {
padding: 0px 24px;
}
}

.componentCodeEditorContainer {
display: flex;
flex: 1;
transition: min-height 0.4s ease-in-out;
position: relative;
background: var(--on-surface-neutral-low-color, #282828) !important;
height: calc(100% - 40px);
min-height: calc(100% - 40px);

> section {
overflow: hidden;
}
}

.loader {
width: 100%;
color: var(--on-surface-neutral-low-color, #282828);
background-image: linear-gradient(to right, currentColor 0%, #2b2b2b 30%, #2b2b2b 50%, currentColor 100%);
opacity: 1;
visibility: visible;
transition: opacity 0.3s ease-in-out, visibility 0.3s ease-in-out;
position: absolute;
height: 220px;

> div {
background-image: linear-gradient(to right, currentColor 0%, #2b2b2b 30%, #2b2b2b 50%, currentColor 100%);
visibility: visible;
opacity: 1;
transition: opacity 0.3s ease-in-out, visibility 0.3s ease-in-out;
}
}

.hideLoader,
.hideLoader > div {
opacity: 0;
pointer-events: none;
visibility: hidden;
}

.themeContainer {
height: 100%;
min-height: 100%;
display: flex;
width: 100%;
flex: 1;

> div {
width: 100%;
height: 100%;
min-height: 100%;
display: flex;
}
}
154 changes: 154 additions & 0 deletions components/ui/code-view/code-view.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
import { H1 } from '@teambit/documenter.ui.heading';
import classNames from 'classnames';
import React, { HTMLAttributes, useMemo } from 'react';
import { OnMount, Monaco } from '@monaco-editor/react';
import { useFileContent } from '@teambit/code.ui.queries.get-file-content';
import { CodeEditor } from '@teambit/code.ui.code-editor';
import { LineSkeleton } from '@teambit/base-ui.loaders.skeleton';
import { ThemeSwitcher } from '@teambit/design.themes.theme-toggler';
import { DarkTheme } from '@teambit/design.themes.dark-theme';
import { staticStorageUrl } from '@teambit/base-ui.constants.storage';
import { ComponentID } from '@teambit/component';
import styles from './code-view.module.scss';
import { setupLanguage } from './monaco-language-init';

export type CodeViewProps = {
componentId: ComponentID;
currentFile?: string;
currentFileContent?: string;
icon?: string;
loading?: boolean;
} & HTMLAttributes<HTMLDivElement>;

// a translation list of specific monaco languages that are not the same as their file ending.
const languageOverrides = {
ts: 'typescript',
tsx: 'typescript',
js: 'javascript',
jsx: 'javascript',
mdx: 'markdown',
md: 'markdown',
};

export function CodeView({
className,
componentId,
currentFile,
icon,
currentFileContent,
loading: loadingFromProps,
}: CodeViewProps) {
const monacoRef = React.useRef<{
editor: any;
monaco: Monaco;
}>();

const { fileContent: downloadedFileContent, loading: loadingFileContent } = useFileContent(
componentId,
currentFile,
!!currentFileContent
);

const loading = loadingFromProps || loadingFileContent;
const fileContent = currentFileContent || downloadedFileContent;
const title = useMemo(() => currentFile?.split('/').pop(), [currentFile]);
const language = useMemo(() => {
if (!currentFile) return languageOverrides.ts;
const fileEnding = currentFile?.split('.').pop();
return languageOverrides[fileEnding || ''] || fileEnding;
}, [currentFile]);

const handleEditorDidMount: OnMount = (editor, monaco) => {
/**
* disable syntax check
* ts cant validate all types because imported files aren't available to the editor
*/
monacoRef.current = { monaco, editor };

monaco.languages.typescript.typescriptDefaults.setCompilerOptions({
target: monaco.languages.typescript.ScriptTarget.Latest,
allowNonTsExtensions: true,
moduleResolution: monaco.languages.typescript.ModuleResolutionKind.NodeJs,
module: monaco.languages.typescript.ModuleKind.CommonJS,
jsx: monaco.languages.typescript.JsxEmit.React,
noEmit: true,
typeRoots: ['node_modules/@types'],
jsxFactory: 'JSXAlone.createElement',
reactNamespace: 'React',
esModuleInterop: true,
});

setupLanguage(monaco, language).catch(() => {});

monaco.editor.defineTheme('bit', {
base: 'vs-dark',
inherit: true,
rules: [
{ token: 'delimiter', foreground: 'ffffff' },
{ token: 'delimiter.angle', foreground: '808080' },
{ token: 'tag.dom', foreground: '569cd6' },
{ token: 'tag.custom', foreground: '4ec9b0' },
{ token: 'delimiter.bracket', foreground: 'd7ba7d' },
{ token: 'attribute.key', foreground: '9cdcfe' },
{ token: 'attribute.value', foreground: 'ce9178' },
{ token: 'delimiter.bracket', foreground: 'd7ba7d' },
{ token: 'jsx.attribute.value', foreground: 'ce9178' },
],

colors: {
'scrollbar.shadow': '#222222',
'diffEditor.insertedTextBackground': '#1C4D2D',
'diffEditor.removedTextBackground': '#761E24',
'editor.selectionBackground': '#5A5A5A',
'editor.overviewRulerBorder': '#6a57fd',
'editor.lineHighlightBorder': '#6a57fd',
},
});

monaco.editor.setTheme('bit');
};
const codeEditor = useMemo(
() => (
<CodeEditor
language={language}
fileContent={fileContent}
filePath={currentFile}
onMount={handleEditorDidMount}
Loader={<CodeViewLoader />}
/>
),
[fileContent]
);

if (!fileContent && !loading && currentFile) return <EmptyCodeView />;

return (
<div className={classNames(styles.componentCodeViewContainer, className, loading && styles.loading)}>
<div className={styles.codeViewTitle}>
<H1 size="sm" className={styles.fileName}>
{currentFile && <img className={styles.img} src={icon} />}
<span>{title}</span>
</H1>
</div>
<div className={classNames(styles.componentCodeEditorContainer, loading && styles.loading)}>
<ThemeSwitcher themes={[DarkTheme]} className={classNames(styles.themeContainer, className)}>
<CodeViewLoader className={classNames(!loading && styles.hideLoader)} />
{loading ? null : codeEditor}
</ThemeSwitcher>
</div>
</div>
);
}

function EmptyCodeView() {
return (
<div className={styles.emptyCodeView}>
<img src={`${staticStorageUrl}/harmony/empty-code-view.svg`} />
<div>Nothing to show</div>
</div>
);
}

export function CodeViewLoader({ className, ...rest }: React.HTMLAttributes<HTMLDivElement>) {
return <LineSkeleton {...rest} className={classNames(styles.loader, className)} count={75} />;
}
2 changes: 2 additions & 0 deletions components/ui/code-view/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { CodeView } from './code-view';
export type { CodeViewProps } from './code-view';
Loading