Skip to content

Connect, collaborate, and grow with a community of TypeScript developers

feat: Splits Editors on Challenge Page (#306)

Jim Burbridgea7d78f49f41f
diff --git a/apps/web/src/app/admin/challenge/[challengeId]/challenge-review.tsx b/apps/web/src/app/admin/challenge/[challengeId]/challenge-review.tsx
index 5f35c79c..b9efbb2f 100644
--- a/apps/web/src/app/admin/challenge/[challengeId]/challenge-review.tsx
+++ b/apps/web/src/app/admin/challenge/[challengeId]/challenge-review.tsx
@@ -70,7 +70,7 @@ export function ChallengeReview({ challenge }: Props) {
<Markdown>{challenge.description}</Markdown>
</div>
<div className="flex-1 rounded-l-xl rounded-r-2xl border border-zinc-300 dark:border-zinc-700">
- <CodeEditor value={challenge.prompt} />
+ <CodeEditor value={challenge.tests} />
</div>
</div>
<div className="flex justify-end gap-3 p-4">
diff --git a/apps/web/src/app/admin/page.tsx b/apps/web/src/app/admin/page.tsx
index 3e9b1ede..94aa8ed7 100644
--- a/apps/web/src/app/admin/page.tsx
+++ b/apps/web/src/app/admin/page.tsx
@@ -8,7 +8,7 @@ import { ChallengeReviews } from './_components/challenge-reviews';
import { ManageTracks } from './_components/tracks';
import { getBannedUsers, getUploadedImages } from '~/components/admin/admin.actions';
import { ImageUploadReport } from '~/components/admin/images';
-import { Reports } from '~/components/admin/reports';
+import Reports from '~/components/admin/reports';
import { BannedUsers } from '~/components/admin/users';
import { getInfiniteReports } from '~/components/report/report.action';
diff --git a/apps/web/src/app/challenge/_components/code-panel/index.tsx b/apps/web/src/app/challenge/_components/code-panel/index.tsx
index 9c660546..5ce75856 100644
--- a/apps/web/src/app/challenge/_components/code-panel/index.tsx
+++ b/apps/web/src/app/challenge/_components/code-panel/index.tsx
@@ -1,6 +1,6 @@
'use client';
-import { loader } from '@monaco-editor/react';
+import { loader, useMonaco } from '@monaco-editor/react';
import clsx from 'clsx';
import { Loader2, Settings } from '@repo/ui/icons';
import type * as monaco from 'monaco-editor';
@@ -27,9 +27,9 @@ import { saveSubmission } from '../../[id]/submissions/save-submission.action';
import { USER_CODE_START, USER_CODE_START_REGEX } from './constants';
import { libSource } from './editor-types';
import { createTwoslashInlayProvider } from './twoslash';
-import { CodeEditor } from '~/components/ui/code-editor';
import { type ChallengeRouteData } from '~/app/challenge/[id]/getChallengeRouteData';
import { useLocalStorage } from '~/utils/useLocalStorage';
+import SplitEditor from '~/components/ui/split-editor';
const VimStatusBar = dynamic(() => import('./vimMode').then((v) => v.VimStatusBar), {
ssr: false,
@@ -70,11 +70,11 @@ export function CodePanel(props: Props) {
lzstring.decompressFromEncodedURIComponent(params.get('code') ?? '') ?? localStorageCode;
const getDefaultCode = () => {
- if (!defaultCode) {
- return props.challenge.prompt;
+ if (!localStorageCode) {
+ return props.challenge.code;
}
- const [appendSolutionToThis, separator] = props.challenge.prompt.split(USER_CODE_START_REGEX);
+ const [appendSolutionToThis, separator] = props.challenge.code.split(USER_CODE_START_REGEX);
return `${appendSolutionToThis ?? ''}${separator ?? ''}${defaultCode}`;
};
@@ -86,10 +86,9 @@ export function CodePanel(props: Props) {
const [editorState, setEditorState] = useState<monaco.editor.IStandaloneCodeEditor>();
const handleSubmit = async () => {
- const [, solution] = code.split(USER_CODE_START);
const hasErrors = tsErrors.some((e) => e.length);
- await saveSubmission(props.challenge.id, session?.user.id!, solution ?? '', !hasErrors);
+ await saveSubmission(props.challenge.id, session?.user.id!, code ?? '', !hasErrors);
router.refresh();
if (hasErrors) {
@@ -125,6 +124,7 @@ export function CodePanel(props: Props) {
}
const model = editor.getModel();
+ console.info('MODEL', model?.uri);
if (!model) {
throw new Error();
@@ -158,12 +158,17 @@ export function CodePanel(props: Props) {
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]">
@@ -187,14 +192,37 @@ export function CodePanel(props: Props) {
</Dialog>
</div>
<div className="w-full flex-1">
- <CodeEditor
- onChange={(code) => {
- setCode(code ?? '');
- // we we only want to save whats after the comment
- const [, , storeThiseCode] = (code ?? '').split(USER_CODE_START_REGEX);
- setLocalStorageCode(storeThiseCode ?? '');
+ <SplitEditor
+ tests={props.challenge.tests}
+ challenge={props.challenge.code}
+ onMount={{ tests: onMount(code, setTsErrors) }}
+ onChange={{
+ user: async (code) => {
+ if (!monacoInstance) return null;
+ setCode(code ?? '');
+ // we we only want to save whats after the comment
+ const [, , storeThiseCode] = (code ?? '').split(USER_CODE_START_REGEX);
+
+ // 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'),
+ );
+ if (!mm) return null;
+ const model = await getModel(mm.uri);
+
+ const errors = await Promise.all([
+ model.getSemanticDiagnostics(filename),
+ model.getSyntacticDiagnostics(filename),
+ Promise.resolve([]),
+ model.getCompilerOptionsDiagnostics(filename),
+ ] as const);
+ setTsErrors(errors);
+ setLocalStorageCode(storeThiseCode ?? '');
+ },
}}
- onMount={onMount(code, setTsErrors)}
value={code}
/>
</div>
diff --git a/apps/web/src/components/admin/reports.tsx b/apps/web/src/components/admin/reports.tsx
index 0e96d0ef..4ca9ab51 100644
--- a/apps/web/src/components/admin/reports.tsx
+++ b/apps/web/src/components/admin/reports.tsx
@@ -2,14 +2,22 @@
import { useInfiniteQuery } from '@tanstack/react-query';
import { useRouter } from 'next/navigation';
import React from 'react';
-import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@repo/ui';
+import {
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableRow,
+ Pagination,
+} from '@repo/ui';
import { getInfiniteReports, type InfiniteReports } from '../report/report.action';
export interface ReportsProps {
initialReports: InfiniteReports;
}
-export function Reports({ initialReports }: ReportsProps) {
+export default function Reports2({ initialReports }: ReportsProps) {
const router = useRouter();
const [page, setPage] = React.useState(0);
@@ -42,6 +50,17 @@ export function Reports({ initialReports }: ReportsProps) {
return (
<section className="data-table">
+ <header className="flex justify-end">
+ <Pagination
+ onChange={(e) => {
+ if (!e.detail.pageLoaded) fetchNextPage().then(() => setPage(e.detail.page - 1));
+ else setPage(e.detail.page - 1);
+ }}
+ totalPages={data?.pages.length}
+ hasNextPage={hasNextPage}
+ currentPage={0 + 1}
+ />
+ </header>
<Table>
<TableHeader>
<TableRow>
@@ -64,7 +83,7 @@ export function Reports({ initialReports }: ReportsProps) {
<TableCell>
<div className="flex flex-wrap gap-2">
{tr.issues.map((i) => (
- <div className="rounded-full bg-zinc-800 px-3 py-1" key={`issues-${i.id}`}>
+ <div key={`issues-${i.id}`} className="rounded-full bg-zinc-800 px-3 py-1">
{i.type}
</div>
))}
diff --git a/apps/web/src/components/report/types/challenge.report.tsx b/apps/web/src/components/report/types/challenge.report.tsx
index 1c38612f..7114c52f 100644
--- a/apps/web/src/components/report/types/challenge.report.tsx
+++ b/apps/web/src/components/report/types/challenge.report.tsx
@@ -39,7 +39,10 @@ export default async function ChallengeReport({ report }: ChallengeReportProps)
</div>
<Markdown className="mt-4">{report.challenge.description}</Markdown>
</div>
- <CodeEditor height="50vh" value={report.challenge.prompt} />
+ <Text intent="h3">Tests Panel</Text>
+ <CodeEditor height="20vh" value={report.challenge.tests} />
+ <Text intent="h3">Base code provided</Text>
+ <CodeEditor height="30vh" value={report.challenge.code} />
</section>
);
}
diff --git a/apps/web/src/components/ui/code-editor.tsx b/apps/web/src/components/ui/code-editor.tsx
index 562f458a..1fa72b1a 100644
--- a/apps/web/src/components/ui/code-editor.tsx
+++ b/apps/web/src/components/ui/code-editor.tsx
@@ -46,7 +46,6 @@ export function CodeEditor({ onChange, onMount, options, value, ...props }: Prop
options={editorOptions}
theme={editorTheme}
value={value}
- {...props}
/>
);
}
diff --git a/apps/web/src/components/ui/split-editor.tsx b/apps/web/src/components/ui/split-editor.tsx
new file mode 100644
index 00000000..fbcd6e7f
--- /dev/null
+++ b/apps/web/src/components/ui/split-editor.tsx
@@ -0,0 +1,123 @@
+'use client';
+import clsx from 'clsx';
+import React, { useCallback, useEffect, useState } from 'react';
+import { useMonaco, type OnValidate, type OnMount, type OnChange } from '@monaco-editor/react';
+import { editor } from 'monaco-editor';
+import { CodeEditor } from './code-editor';
+import { libSource } from '~/app/challenge/_components/code-panel/editor-types';
+
+export interface SplitEditorProps extends Omit<React.HTMLProps<HTMLDivElement>, 'onChange'> {
+ tests: string;
+ challenge: string;
+ onValidate?: {
+ tests?: OnValidate;
+ user?: OnValidate;
+ };
+ onMount?: {
+ tests?: OnMount;
+ user?: OnMount;
+ };
+ onChange?: {
+ tests?: OnChange;
+ user?: OnChange;
+ };
+}
+
+export default function SplitEditor({
+ className,
+ tests,
+ challenge,
+ onMount,
+ onValidate,
+ onChange,
+}: SplitEditorProps) {
+ const monaco = useMonaco();
+
+ useEffect(() => {
+ if (monaco) {
+ const libUri = monaco.Uri.parse('file:///asserts.d.ts');
+
+ monaco.languages.typescript.typescriptDefaults.setEagerModelSync(true);
+
+ if (!monaco.editor.getModel(libUri)) {
+ monaco.languages.typescript.javascriptDefaults.addExtraLib(
+ libSource,
+ 'file:///asserts.d.ts',
+ );
+ monaco.editor
+ .createModel(libSource, 'typescript', libUri)
+ .setEOL(editor.EndOfLineSequence.LF);
+ }
+ }
+ }, [monaco]);
+
+ const [footerExpanded, setFooterExpanded] = useState(false);
+
+ return (
+ <div className={clsx('flex h-full flex-col gap-2', className)}>
+ <button onClick={() => setFooterExpanded(!footerExpanded)}>
+ {footerExpanded ? 'hide' : 'show'} all
+ </button>
+ {footerExpanded ? (
+ <header
+ className={clsx('flex-shrink-0 overflow-hidden transition-all', {
+ 'min-h-[30vh]': footerExpanded,
+ 'min-h-0': !footerExpanded,
+ })}
+ >
+ <CodeEditor
+ onMount={onMount?.tests}
+ defaultPath="file:///tests.ts"
+ value={tests}
+ defaultValue={tests}
+ onChange={onChange?.tests}
+ onValidate={onValidate?.tests}
+ />
+ </header>
+ ) : null}
+ <section className="flex-shrink flex-grow">
+ <CodeEditor
+ defaultPath="file:///user.ts"
+ onMount={onMount?.user}
+ defaultValue={challenge}
+ value={challenge}
+ onValidate={onValidate?.user}
+ onChange={async (e, a) => {
+ // Most of this shamelessly stolen from Stackoverflow.
+ if (monaco) {
+ const models = monaco.editor.getModels();
+ const getWorker = await monaco.languages.typescript.getTypeScriptWorker();
+
+ for (const model of models) {
+ const worker = await getWorker(model.uri);
+ const diagnostics = (
+ await Promise.all([
+ worker.getSyntacticDiagnostics(model.uri.toString()),
+ worker.getSemanticDiagnostics(model.uri.toString()),
+ ])
+ ).reduce((a, b) => a.concat(b));
+
+ 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;
+ });
+
+ monaco.editor.setModelMarkers(model, model.getLanguageId(), markers);
+ }
+ }
+ onChange?.user && onChange.user(e, a);
+ }}
+ />
+ </section>
+ </div>
+ );
+}
diff --git a/apps/web/src/components/wizard/TestCasesEditor.tsx b/apps/web/src/components/wizard/TestCasesEditor.tsx
index 4e22651d..f28c93d6 100644
--- a/apps/web/src/components/wizard/TestCasesEditor.tsx
+++ b/apps/web/src/components/wizard/TestCasesEditor.tsx
@@ -77,7 +77,7 @@ export function TestCasesEditor({ form, hasTsErrors, setTsErrors }: Props) {
<TypographyH3 className="mx-auto mb-4 lg:mb-6">Create Test Cases</TypographyH3>
<FormField
control={form.control}
- name="prompt"
+ name="tests"
render={({ field }) => {
return (
<FormItem className="h-full">
diff --git a/apps/web/src/components/wizard/default-challenge.md b/apps/web/src/components/wizard/default-challenge.md
index cd9417e8..430f47e9 100644
--- a/apps/web/src/components/wizard/default-challenge.md
+++ b/apps/web/src/components/wizard/default-challenge.md
@@ -1,7 +1 @@
-// TEST CASE START (code in test cases are not editable)
-Extends<HelloWorld, `Hello, ${string}`>()
-
-Extends<HelloWorld, `${string}!`>()
-
-// CODE START (code below this line is editable)
type HelloWorld = ""
diff --git a/apps/web/src/components/wizard/default-tests.md b/apps/web/src/components/wizard/default-tests.md
new file mode 100644
index 00000000..70ebdb8d
--- /dev/null
+++ b/apps/web/src/components/wizard/default-tests.md
@@ -0,0 +1,4 @@
+// TEST CASE START (code in test cases are not editable)
+Extends<HelloWorld, `Hello, ${string}`>()
+
+Extends<HelloWorld, `${string}!`>()
\ No newline at end of file
diff --git a/apps/web/src/components/wizard/index.tsx b/apps/web/src/components/wizard/index.tsx
index 5fc2185c..cf6ef675 100644
--- a/apps/web/src/components/wizard/index.tsx
+++ b/apps/web/src/components/wizard/index.tsx
@@ -15,6 +15,7 @@ import { Summary } from './Summary';
import { TestCasesEditor } from './TestCasesEditor';
import { uploadChallenge } from './create.action';
import DEFAULT_CHALLENGE_TEMPLATE from './default-challenge.md';
+import DEFAULT_TEST_CASES from './default-tests.md';
import DEFAULT_DESCRIPTION from './default-description.md';
import type { TsErrors } from '~/app/challenge/_components/code-panel';
import {
@@ -44,15 +45,12 @@ const createDescriptionSchema = z.object({
description: z.string().min(20, 'The description must be longer than 20 characters').max(65536),
});
const createTestCasesSchema = z.object({
- prompt: z
+ tests: z
.string()
.min(20, 'The test cases must be longer than 20 characters')
.max(65536)
- .regex(testCaseRegex, 'You need to have test cases in your challenge')
- .regex(
- USER_CODE_START_REGEX,
- `You need to have the line \`${USER_CODE_START}\` to signify the non-editable part`,
- ),
+ .regex(testCaseRegex, 'You need to have test cases in your challenge'),
+ code: z.string(),
});
export const createChallengeSchema = createExploreCardSchema
.merge(createDescriptionSchema)
@@ -88,7 +86,8 @@ export function Wizard() {
name: '',
difficulty: 'BEGINNER',
description: DEFAULT_DESCRIPTION,
- prompt: DEFAULT_CHALLENGE_TEMPLATE,
+ tests: DEFAULT_TEST_CASES,
+ code: DEFAULT_CHALLENGE_TEMPLATE,
},
});
diff --git a/packages/db/mocks/challenges.mock.ts b/packages/db/mocks/challenges.mock.ts
index 64a1de67..e8cad912 100644
--- a/packages/db/mocks/challenges.mock.ts
+++ b/packages/db/mocks/challenges.mock.ts
@@ -32,7 +32,8 @@ export async function loadChallengesFromTypeChallenge() {
f.filter((a) => a.isDirectory),
);
- const arr = [];
+ const arr: Omit<Prisma.ChallengeCreateManyInput, 'userId'>[] = [];
+
for (const dir of folders) {
const infoFile = resolve('./tmp/type-challenges/questions', dir.name, 'info.yml');
const contents = await readFile(infoFile).then((r) => r.toString());
@@ -65,8 +66,10 @@ export async function loadChallengesFromTypeChallenge() {
id: idNum,
name: title,
description: README,
- status: Math.floor(Math.random() * 2) > 0 ? ChallengeStatus.PENDING : ChallengeStatus.ACTIVE,
- prompt: `// TEST CASE START\n${testData}\n\n// CODE START\n${prompt}`,
+ status: ChallengeStatus.ACTIVE,
+ code: prompt,
+ tests: testData,
+ // prompt: `// TEST CASE START\n${testData}\n\n// CODE START\n${prompt}`,
difficulty: difficulty === 'warm' ? 'BEGINNER' : (difficulty.toUpperCase() as Difficulty),
shortDescription: README.slice(0, 100),
});
@@ -108,7 +111,8 @@ export const CHALLENGE_MAP: Record<
: undefined,
description: loadChallengeSync('beginner/desc'),
shortDescription: faker.lorem.lines({ min: 1, max: 2 }),
- prompt: loadChallengeSync('beginner/prompt'),
+ tests: '',
+ code: '',
difficulty: 'BEGINNER',
}),
EASY: () => ({
@@ -117,7 +121,8 @@ export const CHALLENGE_MAP: Record<
updatedAt: faker.date.between({ from: '2023-05-01', to: new Date() }),
description: loadChallengeSync('easy/desc'),
shortDescription: faker.lorem.lines({ min: 1, max: 2 }),
- prompt: loadChallengeSync('easy/prompt'),
+ tests: loadChallengeSync('easy/prompt'),
+ code: '',
difficulty: 'EASY',
}),
MEDIUM: () => ({
@@ -127,6 +132,8 @@ export const CHALLENGE_MAP: Record<
description: loadChallengeSync('medium/desc'),
shortDescription: faker.lorem.lines({ min: 1, max: 2 }),
prompt: loadChallengeSync('medium/prompt'),
+ tests: '',
+ code: '',
difficulty: 'MEDIUM',
}),
HARD: () => ({
@@ -135,7 +142,8 @@ export const CHALLENGE_MAP: Record<
updatedAt: faker.date.between({ from: '2023-05-01', to: new Date() }),
description: loadChallengeSync('hard/desc'),
shortDescription: faker.lorem.lines({ min: 1, max: 2 }),
- prompt: loadChallengeSync('hard/prompt'),
+ tests: loadChallengeSync('hard/prompt'),
+ code: '',
difficulty: 'HARD',
}),
EXTREME: () => ({
@@ -144,7 +152,8 @@ export const CHALLENGE_MAP: Record<
updatedAt: faker.date.between({ from: '2023-05-01', to: new Date() }),
description: loadChallengeSync('extreme/desc'),
shortDescription: faker.lorem.lines({ min: 1, max: 2 }),
- prompt: loadChallengeSync('extreme/prompt'),
+ tests: '',
+ code: '',
difficulty: 'EXTREME',
}),
};
diff --git a/packages/db/schema.prisma b/packages/db/schema.prisma
index 525a31e0..3eb80967 100644
--- a/packages/db/schema.prisma
+++ b/packages/db/schema.prisma
@@ -156,8 +156,10 @@ model Challenge {
description String @db.MediumText
/// this is a short blue thats shown on the explore card
shortDescription String
- /// this is the test cases + default starter code
- prompt String @db.MediumText
+ /// Starter code for the challenge
+ code String @db.MediumText
+ /// Test cases that need to be passed in order have the submission be accepted.
+ tests String @db.MediumText
status ChallengeStatus @default(PENDING)
user User @relation(fields: [userId], references: [id])
diff --git a/packages/ui/src/components/pagination.tsx b/packages/ui/src/components/pagination.tsx
index 7ffa8179..fa26ec41 100644
--- a/packages/ui/src/components/pagination.tsx
+++ b/packages/ui/src/components/pagination.tsx
@@ -13,7 +13,7 @@ export interface PaginationProps {
onChange: (e: CustomEvent<OnPageChangePayload>) => void;
}
-export default function Pagination({
+export function Pagination({
hasNextPage = false,
totalPages = 1,
currentPage = 1,