Connect, collaborate, and grow with a community of TypeScript developers
Fixed vim mode in the editor (#398)
ggrandi1bd03f0dec2c
diff --git a/apps/admin/package.json b/apps/admin/package.jsonindex d2cf0a61..3054c2b6 100644--- a/apps/admin/package.json+++ b/apps/admin/package.json@@ -6,7 +6,7 @@"scripts": {"build": "next build","clean": "rm -rf .next dist node_modules",- "dev": "dotenv -e ../../.env next dev",+ "dev": "dotenv -e ../../.env next dev -p 3001","format": "prettier -w \"src/**/*.{ts,tsx,css,cjs,mjs,json}\"","lint": "eslint .","start": "next start",diff --git a/apps/web/src/components/user/profile.tsx b/apps/web/src/components/user/profile.tsxindex 2fbc5288..b727d898 100644--- a/apps/web/src/components/user/profile.tsx+++ b/apps/web/src/components/user/profile.tsx@@ -14,7 +14,7 @@ export const metadata: Metadata = {export async function Profile({ username: usernameFromQuery }: Props) {const [, username] = decodeURIComponent(usernameFromQuery).split('@');-+if (!username) return notFound();const user = await prisma.user.findFirst({diff --git a/apps/web/src/components/wizard/TestCasesEditor.tsx b/apps/web/src/components/wizard/TestCasesEditor.tsxindex 9ade21d4..5f1afd68 100644--- a/apps/web/src/components/wizard/TestCasesEditor.tsx+++ b/apps/web/src/components/wizard/TestCasesEditor.tsx@@ -2,10 +2,17 @@ import type { OnChange } from '@monaco-editor/react';import type { TsErrors } from '@repo/monaco';import { CodeEditor, loadCheckingLib, type CodeEditorProps } from '@repo/monaco/code-editor';import { FormField, FormItem, FormMessage, TypographyH3 } from '@repo/ui';-import { useCallback } from 'react';+import { useCallback, useState } from 'react';+import type * as monaco from 'monaco-editor';+import dynamic from 'next/dynamic';+import { createTwoslashInlayProvider } from '@repo/monaco/twoslash';import type { WizardForm } from '.';import { SettingsButton } from '~/app/challenge/_components/settings/settings-button';+const VimStatusBar = dynamic(() => import('@repo/monaco/vim-mode').then((v) => v.VimStatusBar), {+ ssr: false,+});+interface Props {form: Pick<WizardForm, 'control'>;hasTsErrors: boolean;@@ -13,40 +20,48 @@ interface Props {}export function TestCasesEditor({ form, hasTsErrors, setTsErrors }: Props) {- const onMount = useCallback(- (onError: (v: TsErrors) => void): CodeEditorProps['onMount'] =>- async (editor, monaco) => {- loadCheckingLib(monaco);+ const [editorState, setEditorState] = useState<monaco.editor.IStandaloneCodeEditor>();++ const onMount = useCallback<NonNullable<CodeEditorProps['onMount']>>(+ async (editor, monaco) => {+ loadCheckingLib(monaco);++ const model = editor.getModel();- const model = editor.getModel();+ if (!model) {+ throw new Error();+ }- if (!model) {- throw new Error();- }+ const ts = await (await monaco.languages.typescript.getTypeScriptWorker())(model.uri);- const ts = await (await monaco.languages.typescript.getTypeScriptWorker())(model.uri);+ const filename = model.uri.toString();- const filename = model.uri.toString();+ // what actually runs when checking errors+ const typeCheck = async () => {+ const errors = await Promise.all([+ ts.getSemanticDiagnostics(filename),+ ts.getSyntacticDiagnostics(filename),+ ts.getSuggestionDiagnostics(filename),+ ts.getCompilerOptionsDiagnostics(filename),+ ] as const);- // what actually runs when checking errors- const typeCheck = async () => {- const errors = await Promise.all([- ts.getSemanticDiagnostics(filename),- ts.getSyntacticDiagnostics(filename),- ts.getSuggestionDiagnostics(filename),- ts.getCompilerOptionsDiagnostics(filename),- ] as const);+ setTsErrors(errors);+ };- onError(errors);- };+ model.onDidChangeContent(() => {+ typeCheck().catch(console.error);+ });- model.onDidChangeContent(() => {- typeCheck().catch(console.error);- });+ await typeCheck();- await typeCheck();- },- [],+ monaco.languages.registerInlayHintsProvider(+ 'typescript',+ createTwoslashInlayProvider(monaco, ts),+ );++ setEditorState(editor);+ },+ [setTsErrors],);return (@@ -57,7 +72,7 @@ export function TestCasesEditor({ form, hasTsErrors, setTsErrors }: Props) {name="tests"render={({ field }) => {return (- <FormItem className="h-full">+ <FormItem className="flex-1"><div className="flex h-full flex-col overflow-hidden rounded-2xl border border-zinc-300 dark:border-zinc-700"><div className="sticky top-0 flex h-[40px] flex-row-reverse items-center border-b border-zinc-300 px-3 py-2 dark:border-zinc-700 dark:bg-[#1e1e1e]"><SettingsButton />@@ -65,10 +80,13 @@ export function TestCasesEditor({ form, hasTsErrors, setTsErrors }: Props) {<div className="w-full flex-1"><CodeEditoronChange={field.onChange as OnChange}- onMount={onMount(setTsErrors)}+ onMount={onMount}value={field.value}/></div>+ <div className="sticky bottom-0 flex items-center justify-end p-2 dark:bg-[#1e1e1e]">+ {editorState ? <VimStatusBar editor={editorState} /> : null}+ </div><FormMessage />{!hasTsErrors && (<div className="text-destructive text-sm">You must have failing test cases</div>diff --git a/packages/monaco/package.json b/packages/monaco/package.jsonindex 927182c0..2d641f75 100644--- a/packages/monaco/package.json+++ b/packages/monaco/package.json@@ -5,7 +5,9 @@"exports": {".": "./src/index.tsx","./code-editor": "./src/code-editor.tsx",- "./settings-store": "./src/settings-store.ts"+ "./settings-store": "./src/settings-store.ts",+ "./vim-mode": "./src/vim-mode.tsx",+ "./twoslash": "./src/twoslash.ts"},"typesVersions": {"*": {@@ -17,6 +19,12 @@],"settings-store": ["./src/settings-store.ts"+ ],+ "vim-mode": [+ "./src/vim-mode.tsx"+ ],+ "twoslash": [+ "./src/twoslash.ts"]}},diff --git a/packages/monaco/src/code-editor.tsx b/packages/monaco/src/code-editor.tsxindex f353992a..7260587c 100644--- a/packages/monaco/src/code-editor.tsx+++ b/packages/monaco/src/code-editor.tsx@@ -31,7 +31,7 @@ const DEFAULT_OPTIONS = {fontSize: 16,} as const satisfies EditorProps['options'];-export const LIB_URI = 'ts:filename/checking.d.ts';+export const LIB_URI = 'file:///asserts.d.ts';// eslint-disable-next-line @typescript-eslint/consistent-type-importsexport function loadCheckingLib(monaco: typeof import('monaco-editor')) {if (!monaco.editor.getModel(monaco.Uri.parse(LIB_URI))) {diff --git a/packages/monaco/src/index.tsx b/packages/monaco/src/index.tsxindex 15ca0074..d01a543c 100644--- a/packages/monaco/src/index.tsx+++ b/packages/monaco/src/index.tsx@@ -10,12 +10,11 @@ import React, { useRef, useState } from 'react';import lzstring from 'lz-string';import { Button, ToastAction, useToast, Tooltip, TooltipContent, TooltipTrigger } from '@repo/ui';import { useLocalStorage } from './useLocalStorage';-import SplitEditor from './split-editor';+import SplitEditor, { TESTS_PATH } from './split-editor';import { USER_CODE_START_REGEX } from './constants';import { createTwoslashInlayProvider } from './twoslash';-import { loadCheckingLib } from './code-editor';-const VimStatusBar = dynamic(() => import('./vimMode').then((v) => v.VimStatusBar), {+const VimStatusBar = dynamic(() => import('./vim-mode').then((v) => v.VimStatusBar), {ssr: false,});@@ -41,13 +40,14 @@ export function CodePanel(props: CodePanelProps) {const params = useSearchParams();const router = useRouter();const { toast } = useToast();- const [tsErrors, setTsErrors] = useState<TsErrors>([[], [], [], []]);- const [initialTypecheckDone, setInitialTypecheckDone] = useState(false);+ const [tsErrors, setTsErrors] = useState<TsErrors | undefined>(undefined);const [localStorageCode, setLocalStorageCode] = useLocalStorage(`challenge-${props.challenge.id}`,'',);+ const initialTypecheckDone = tsErrors === undefined;+const defaultCode =lzstring.decompressFromEncodedURIComponent(params.get('code') ?? '') ?? localStorageCode;@@ -63,12 +63,11 @@ export function CodePanel(props: CodePanelProps) {const [code, setCode] = useState(() => getDefaultCode());- const modelRef = useRef<monaco.editor.ITextModel>();- // ref doesnt cause a rerender- const [editorState, setEditorState] = useState<monaco.editor.IStandaloneCodeEditor>();+ const [testEditorState, setTestEditorState] = useState<monaco.editor.IStandaloneCodeEditor>();+ const [userEditorState, setUserEditorState] = useState<monaco.editor.IStandaloneCodeEditor>();const handleSubmit = async () => {- const hasErrors = tsErrors.some((e) => e.length);+ const hasErrors = tsErrors?.some((e) => e.length) ?? false;await props.saveSubmission(code ?? '', !hasErrors);router.refresh();@@ -89,65 +88,8 @@ export function CodePanel(props: CodePanelProps) {}};- const onMount =- (value: string, onError: (v: TsErrors) => void) =>- // eslint-disable-next-line @typescript-eslint/consistent-type-imports- async (editor: monaco.editor.IStandaloneCodeEditor, monaco: typeof import('monaco-editor')) => {- monaco.languages.typescript.typescriptDefaults.setCompilerOptions({- ...monaco.languages.typescript.typescriptDefaults.getCompilerOptions(),- strict: true,- target: monaco.languages.typescript.ScriptTarget.ESNext,- strictNullChecks: true,- });-- loadCheckingLib(monaco);-- const model = editor.getModel();- console.info('MODEL', model?.uri);-- if (!model) {- throw new Error();- }-- modelRef.current = model;- setEditorState(editor);-- const ts = await (await monaco.languages.typescript.getTypeScriptWorker())(model.uri);-- const filename = model.uri.toString();-- // what actually runs when checking errors- const typeCheck = async () => {- const errors = await Promise.all([- ts.getSemanticDiagnostics(filename),- ts.getSyntacticDiagnostics(filename),- ts.getSuggestionDiagnostics(filename),- ts.getCompilerOptionsDiagnostics(filename),- ] as const);-- onError(errors);- };-- // TODO: we prolly should use this for blocking ranges as it might not be as janky- // https://github.com/Pranomvignesh/constrained-editor-plugin- model.onDidChangeContent((e) => {- typeCheck().catch(console.error);- });-- await typeCheck();- setInitialTypecheckDone(true);-- editor.updateOptions({- readOnly: true,- renderValidationDecorations: 'on',- });-- monaco.languages.registerInlayHintsProvider(- 'typescript',- createTwoslashInlayProvider(monaco, ts),- );- };const monacoInstance = useMonaco();+return (<><div className="sticky top-0 flex h-[40px] flex-row-reverse items-center border-b border-zinc-300 px-3 py-2 dark:border-zinc-700 dark:bg-[#1e1e1e]">@@ -157,7 +99,35 @@ export function CodePanel(props: CodePanelProps) {<SplitEditortests={props.challenge.tests}challenge={props.challenge.code}- onMount={{ tests: onMount(code, setTsErrors) }}+ onMount={{+ tests: (editor) => {+ setTestEditorState(editor);+ },+ user: async (editor, monaco) => {+ monaco.languages.typescript.typescriptDefaults.setCompilerOptions({+ ...monaco.languages.typescript.typescriptDefaults.getCompilerOptions(),+ strict: true,+ target: monaco.languages.typescript.ScriptTarget.ESNext,+ strictNullChecks: true,+ });++ setUserEditorState(editor);++ const model = editor.getModel();+ console.info('MODEL', model?.uri);++ if (!model) {+ throw new Error();+ }++ const ts = await (await monaco.languages.typescript.getTypeScriptWorker())(model.uri);++ monaco.languages.registerInlayHintsProvider(+ 'typescript',+ createTwoslashInlayProvider(monaco, ts),+ );+ },+ }}onChange={{user: async (code) => {if (!monacoInstance) return null;@@ -167,36 +137,35 @@ export function CodePanel(props: CodePanelProps) {// Wow this is just... remarkably jank.- const getModel = await monacoInstance.languages.typescript.getTypeScriptWorker();- const filename = 'file:///tests.ts';- const mm = monacoInstance.editor.getModel(- monacoInstance.Uri.parse('file:///tests.ts'),- );+ const getTsWorker = await monacoInstance.languages.typescript.getTypeScriptWorker();++ const mm = monacoInstance.editor.getModel(monacoInstance.Uri.parse(TESTS_PATH));if (!mm) return null;- const model = await getModel(mm.uri);++ const tsWorker = await getTsWorker(mm.uri);const errors = await Promise.all([- model.getSemanticDiagnostics(filename),- model.getSyntacticDiagnostics(filename),+ tsWorker.getSemanticDiagnostics(TESTS_PATH),+ tsWorker.getSyntacticDiagnostics(TESTS_PATH),Promise.resolve([]),- model.getCompilerOptionsDiagnostics(filename),+ tsWorker.getCompilerOptionsDiagnostics(TESTS_PATH),] as const);+setTsErrors(errors);setLocalStorageCode(storeThiseCode ?? '');},}}- value={code}/></div><divclassName={clsx({- 'justify-between': editorState,+ 'justify-between': testEditorState,},'sticky bottom-0 flex items-center justify-end p-2 dark:bg-[#1e1e1e]',)}>- {editorState ? <VimStatusBar editor={editorState} /> : null}+ {userEditorState && <VimStatusBar editor={userEditorState} />}<div className="flex items-center justify-center gap-4"><Tooltip><TooltipTrigger asChild>diff --git a/packages/monaco/src/split-editor.tsx b/packages/monaco/src/split-editor.tsxindex e037184d..90f830d7 100644--- a/packages/monaco/src/split-editor.tsx+++ b/packages/monaco/src/split-editor.tsx@@ -3,10 +3,15 @@ import clsx from 'clsx';import React, { useCallback, useEffect, useState } from 'react';import { useMonaco, type OnValidate, type OnMount, type OnChange } from '@monaco-editor/react';import type { editor } from 'monaco-editor';-import { CodeEditor } from './code-editor';+import { CodeEditor, LIB_URI } from './code-editor';import { libSource } from './editor-types';-export interface SplitEditorProps extends Omit<React.HTMLProps<HTMLDivElement>, 'onChange'> {+export const TESTS_PATH = 'file:///tests.ts';+export const USER_CODE_PATH = 'file:///user.ts';++export interface SplitEditorProps {+ /** the classes applied to the container div */+ className?: string;tests: string;challenge: string;onValidate?: {@@ -35,15 +40,12 @@ export default function SplitEditor({useEffect(() => {if (monaco) {- const libUri = monaco.Uri.parse('file:///asserts.d.ts');+ const libUri = monaco.Uri.parse(LIB_URI);monaco.languages.typescript.typescriptDefaults.setEagerModelSync(true);if (!monaco.editor.getModel(libUri)) {- monaco.languages.typescript.javascriptDefaults.addExtraLib(- libSource,- 'file:///asserts.d.ts',- );+ monaco.languages.typescript.javascriptDefaults.addExtraLib(libSource, LIB_URI);monaco.editor.createModel(libSource, 'typescript', libUri).setEOL(monaco.editor.EndOfLineSequence.LF);@@ -66,8 +68,15 @@ export default function SplitEditor({})}><CodeEditor- onMount={onMount?.tests}- defaultPath="file:///tests.ts"+ onMount={(editor, monaco) => {+ editor.updateOptions({+ readOnly: true,+ renderValidationDecorations: 'on',+ });++ onMount?.tests?.(editor, monaco);+ }}+ defaultPath={TESTS_PATH}value={tests}defaultValue={tests}onChange={onChange?.tests}@@ -77,7 +86,7 @@ export default function SplitEditor({) : null}<section className="flex-shrink flex-grow"><CodeEditor- defaultPath="file:///user.ts"+ defaultPath={USER_CODE_PATH}onMount={onMount?.user}defaultValue={challenge}value={challenge}@@ -100,21 +109,22 @@ export default function SplitEditor({const markers = diagnostics.map((d) => {const start = model.getPositionAt(d.start!);const end = model.getPositionAt(d.start! + d.length!);- let f: editor.IMarkerData;+return {severity: monaco.MarkerSeverity.Error,startLineNumber: start.lineNumber,endLineNumber: end.lineNumber,startColumn: start.column,endColumn: end.column,- message: d.messageText,- } as editor.IMarkerData;+ message: d.messageText as string,+ } satisfies editor.IMarkerData;});monaco.editor.setModelMarkers(model, model.getLanguageId(), markers);}}- onChange?.user && onChange.user(e, a);++ onChange?.user?.(e, a);}}/></section>diff --git a/packages/monaco/src/twoslash.ts b/packages/monaco/src/twoslash.tsindex c16bb09e..1e4d5efd 100644--- a/packages/monaco/src/twoslash.ts+++ b/packages/monaco/src/twoslash.ts@@ -1,14 +1,18 @@// based on: https://github.com/microsoft/TypeScript-Website/blob/v2/packages/playground/src/twoslashInlays.tsimport type * as monaco from 'monaco-editor';+export const TWOSLASH_INLAY_HINTS_PROVIDER = 'twoslash inlay hints provider';+const queryRegex = /^\s*\/\/\s*\^\?$/gm;+export const createTwoslashInlayProvider = (m: typeof monaco,worker: monaco.languages.typescript.TypeScriptWorker,) => {const provider: monaco.languages.InlayHintsProvider = {+ displayName: TWOSLASH_INLAY_HINTS_PROVIDER,provideInlayHints: async (model, _, cancel) => {const text = model.getValue();- const queryRegex = /^\s*\/\/\s*\^\?$/gm;+let match;const results: monaco.languages.InlayHint[] = [];if (model.isDisposed()) {diff --git a/packages/monaco/src/vimMode.tsx b/packages/monaco/src/vim-mode.tsxsimilarity index 70%rename from packages/monaco/src/vimMode.tsxrename to packages/monaco/src/vim-mode.tsxindex 797818a2..2a70f057 100644--- a/packages/monaco/src/vimMode.tsx+++ b/packages/monaco/src/vim-mode.tsx@@ -6,7 +6,7 @@ import { type VimMode, initVimMode } from 'monaco-vim';import { useEditorSettingsStore } from './settings-store';interface VimStatusBarProps {- editor: monaco.editor.IStandaloneCodeEditor;+ editor: monaco.editor.IStandaloneCodeEditor;}export function VimStatusBar({ editor }: VimStatusBarProps) {@@ -16,15 +16,16 @@ export function VimStatusBar({ editor }: VimStatusBarProps) {useEffect(() => {if (settings.bindings === 'vim') {- if (!vimModeRef.current) {- vimModeRef.current = initVimMode(editor, statusBarRef.current);- }- } else {- vimModeRef.current?.dispose();- vimModeRef.current = undefined;- if (statusBarRef.current) {- statusBarRef.current.textContent = '';- }+ vimModeRef.current = initVimMode(editor, statusBarRef.current);++ return () => vimModeRef.current?.dispose();+ }++ vimModeRef.current?.dispose();+ vimModeRef.current = undefined;++ if (statusBarRef.current) {+ statusBarRef.current.textContent = '';}}, [editor, settings.bindings]);