Skip to content

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

feat: per-challenge tsconfig support (#1262)

Tsvetomir Bonev286f134b4915
diff --git a/apps/web/src/app/[locale]/challenge/[slug]/getChallengeRouteData.ts b/apps/web/src/app/[locale]/challenge/[slug]/getChallengeRouteData.ts
index 4bf736d8..d6ac5851 100644
--- a/apps/web/src/app/[locale]/challenge/[slug]/getChallengeRouteData.ts
+++ b/apps/web/src/app/[locale]/challenge/[slug]/getChallengeRouteData.ts
@@ -4,6 +4,7 @@ import { cache } from 'react';
import { getAllFlags } from '~/utils/feature-flags';
import { AOT_CHALLENGES } from './aot-slugs';
import { daysAfterDecemberFirst } from '~/utils/aot';
+import { validateCompilerOptions } from '~/utils/validateCompilerOptions';
export type ChallengeRouteData = NonNullable<Awaited<ReturnType<typeof getChallengeRouteData>>>;
@@ -56,6 +57,11 @@ export const getChallengeRouteData = cache(async (slug: string, session: Session
},
});
+ const tsconfig = challenge.tsconfig;
+ if (!validateCompilerOptions(tsconfig)) {
+ throw new Error(`Challenge "${challenge.slug}" has an invalid tsconfig`);
+ }
+
/**
* Select the first track that the user is enrolled in for this challenge.
*/
@@ -83,6 +89,7 @@ export const getChallengeRouteData = cache(async (slug: string, session: Session
challenge: {
...challenge,
hasSolved: challenge.submission.length > 0,
+ tsconfig,
},
track,
};
diff --git a/apps/web/src/utils/validateCompilerOptions.ts b/apps/web/src/utils/validateCompilerOptions.ts
new file mode 100644
index 00000000..e0c98666
--- /dev/null
+++ b/apps/web/src/utils/validateCompilerOptions.ts
@@ -0,0 +1,6 @@
+import type * as monaco from 'monaco-editor';
+
+export const validateCompilerOptions = (value: unknown): value is TSCompilerOptions =>
+ value == null || (typeof value === 'object' && !Array.isArray(value));
+
+export type TSCompilerOptions = monaco.languages.typescript.CompilerOptions | undefined;
diff --git a/packages/db/mocks/challenges.mock.ts b/packages/db/mocks/challenges.mock.ts
index 4f16aa30..4b7e9608 100644
--- a/packages/db/mocks/challenges.mock.ts
+++ b/packages/db/mocks/challenges.mock.ts
@@ -18,6 +18,12 @@ export interface InfoFile {
const redundantChallenges = ['pick', 'flatten'];
+const tsconfigOverrides: Record<string, object> = {
+ 'assert-array-index': {
+ noUncheckedIndexedAccess: true,
+ },
+};
+
const creditLine = (author: string) =>
`\n\n\nThis challenge was ported from [Type Challenges](https://tsch.js.org/) and was authored by [${author}](https://www.github.com/${author})`;
@@ -63,17 +69,20 @@ export async function loadChallengesFromTypeChallenge(isProd = false) {
continue;
}
- if ((isProd && !redundantChallenges.includes(title.toLowerCase())) || !isProd) {
+ const slug = slugify(title);
+
+ if ((isProd && !redundantChallenges.includes(slug)) || !isProd) {
arr.push({
...(isProd ? {} : { id: idNum }),
name: title,
- slug: slugify(title),
+ slug,
description: descriptionWithCredit,
status: ChallengeStatus.ACTIVE,
code: prompt,
tests: testData,
difficulty: difficulty === 'warm' ? 'BEGINNER' : (difficulty.toUpperCase() as Difficulty),
shortDescription: README.slice(0, 100),
+ ...(slug in tsconfigOverrides && { tsconfig: tsconfigOverrides[slug] }),
});
}
}
diff --git a/packages/db/schema.prisma b/packages/db/schema.prisma
index ab2788f0..e58a2d9e 100644
--- a/packages/db/schema.prisma
+++ b/packages/db/schema.prisma
@@ -164,6 +164,7 @@ model Challenge {
/// Test cases that need to be passed in order have the submission be accepted.
tests String @db.MediumText
status ChallengeStatus @default(PENDING)
+ tsconfig Json?
user User @relation(fields: [userId], references: [id])
userId String
diff --git a/packages/db/seed/data/challenge-ingest.ts b/packages/db/seed/data/challenge-ingest.ts
index 41df8937..7ad9bfe5 100644
--- a/packages/db/seed/data/challenge-ingest.ts
+++ b/packages/db/seed/data/challenge-ingest.ts
@@ -88,6 +88,17 @@ async function buildChallenge(pathToDirectory: string) {
console.error('Error parsing JSON:', jsonError);
}
}
+ if (fileName === 'tsconfig') {
+ try {
+ const fileContents = await fs.promises.readFile(itemPath, 'utf8');
+ const jsonData = JSON.parse(fileContents);
+ if (jsonData.compilerOptions != null) {
+ challengeToCreate.tsconfig = jsonData.compilerOptions;
+ }
+ } catch (jsonError) {
+ console.error('Error parsing JSON:', jsonError);
+ }
+ }
// @TODO: we'll ingest solutions later
// const isWithinSolutionsDirectory = challengePath.split('/').at(-1) === 'solutions';
//
diff --git a/packages/monaco/src/index.tsx b/packages/monaco/src/index.tsx
index 3f5402b2..04cdf265 100644
--- a/packages/monaco/src/index.tsx
+++ b/packages/monaco/src/index.tsx
@@ -20,6 +20,7 @@ export interface CodePanelProps {
code: string;
slug: string;
tests: string;
+ tsconfig?: monaco.languages.typescript.CompilerOptions;
};
saveSubmission: (code: string, isSuccessful: boolean) => Promise<void>;
submissionDisabled: boolean;
@@ -113,6 +114,7 @@ export function CodePanel(props: CodePanelProps) {
setIsTestPanelExpanded={setIsTestPanelExpanded}
tests={tests}
userCode={code}
+ tsconfig={props.challenge.tsconfig}
onMount={{
tests: async (editor, monaco) => {
const getTsWorker = await monaco.languages.typescript.getTypeScriptWorker();
diff --git a/packages/monaco/src/split-editor.tsx b/packages/monaco/src/split-editor.tsx
index 6cedd79b..ada38c9b 100644
--- a/packages/monaco/src/split-editor.tsx
+++ b/packages/monaco/src/split-editor.tsx
@@ -38,6 +38,7 @@ export interface SplitEditorProps {
setIsTestPanelExpanded: (isExpanded: boolean) => void;
tests: string;
userCode: string;
+ tsconfig?: monacoType.languages.typescript.CompilerOptions;
onValidate?: {
tests?: OnValidate;
user?: OnValidate;
@@ -79,6 +80,7 @@ export default function SplitEditor({
tests,
userCode,
userEditorState,
+ tsconfig,
}: SplitEditorProps) {
const { toast } = useToast();
const { settings, updateSettings } = useEditorSettingsStore();
@@ -308,14 +310,16 @@ export default function SplitEditor({
const model = monaco.editor.getModel(monaco.Uri.parse(USER_CODE_PATH))!;
const code = model.getValue();
debouncedUserCodeAta(code);
+
monaco.languages.typescript.typescriptDefaults.setCompilerOptions({
- ...monaco.languages.typescript.typescriptDefaults.getCompilerOptions(),
+ allowNonTsExtensions: true,
strict: true,
target: monaco.languages.typescript.ScriptTarget.ESNext,
strictNullChecks: true,
moduleResolution: monaco.languages.typescript.ModuleResolutionKind.NodeJs,
allowSyntheticDefaultImports: true,
outDir: 'lib', // kills the override input file error
+ ...tsconfig,
});
monaco.languages.registerDocumentFormattingEditProvider(