import { existsSync } from 'fs'; import fs from 'fs/promises'; import path from 'path'; import { prompt } from 'inquirer'; import { format } from 'prettier'; import ObjectID from 'bson-objectid'; import { SuperBlocks, languageSuperBlocks, superBlockToFolderMap } from '../../shared/config/curriculum'; import { createDialogueFile, validateBlockName } from './utils'; import { getBaseMeta } from './helpers/get-base-meta'; import { createIntroMD } from './helpers/create-intro'; const helpCategories = ['English'] as const; type BlockInfo = { title: string; intro: string[]; }; type SuperBlockInfo = { blocks: Record; }; type IntroJson = Record; interface CreateBlockArgs { superBlock: SuperBlocks; block: string; helpCategory: string; title?: string; } async function createLanguageBlock( superBlock: SuperBlocks, block: string, helpCategory: string, title?: string ) { if (!title) { title = block; } await updateIntroJson(superBlock, block, title); const challengeId = await createDialogueChallenge(superBlock, block); await createMetaJson(superBlock, block, title, helpCategory, challengeId); // TODO: remove once we stop relying on markdown in the client. await createIntroMD(superBlock, block, title); } async function updateIntroJson( superBlock: SuperBlocks, block: string, title: string ) { const introJsonPath = path.resolve( __dirname, '../../client/i18n/locales/english/intro.json' ); const newIntro = await parseJson(introJsonPath); newIntro[superBlock].blocks[block] = { title, intro: ['', ''] }; void withTrace( fs.writeFile, introJsonPath, await format(JSON.stringify(newIntro), { parser: 'json' }) ); } async function createMetaJson( superBlock: SuperBlocks, block: string, title: string, helpCategory: string, challengeId: ObjectID ) { const metaDir = path.resolve(__dirname, '../../curriculum/challenges/_meta'); const newMeta = getBaseMeta('Language'); newMeta.name = title; newMeta.dashedName = block; newMeta.helpCategory = helpCategory; newMeta.superBlock = superBlock; newMeta.challengeOrder = [ // eslint-disable-next-line @typescript-eslint/no-base-to-string { id: challengeId.toString(), title: "Dialogue 1: I'm Tom" } ]; const newMetaDir = path.resolve(metaDir, block); if (!existsSync(newMetaDir)) { await withTrace(fs.mkdir, newMetaDir); } void withTrace( fs.writeFile, path.resolve(metaDir, `${block}/meta.json`), await format(JSON.stringify(newMeta), { parser: 'json' }) ); } async function createDialogueChallenge( superBlock: SuperBlocks, block: string ): Promise { const superBlockSubPath = superBlockToFolderMap[superBlock]; const newChallengeDir = path.resolve( __dirname, `../../curriculum/challenges/english/${superBlockSubPath}/${block}` ); if (!existsSync(newChallengeDir)) { await withTrace(fs.mkdir, newChallengeDir); } return createDialogueFile({ projectPath: newChallengeDir + '/' }); } function parseJson(filePath: string) { return withTrace(fs.readFile, filePath, 'utf8').then( // unfortunately, withTrace does not correctly infer that the third argument // is a string, so it uses the (path, options?) overload and we have to cast // result to string. result => JSON.parse(result as string) as JsonSchema ); } // fs Promise functions return errors, but no stack trace. This adds back in // the stack trace. function withTrace( fn: (...x: Args) => Promise, ...args: Args ): Promise { return fn(...args).catch((reason: Error) => { throw Error(reason.message); }); } void prompt([ { name: 'superBlock', message: 'Which certification does this belong to?', default: SuperBlocks.A2English, type: 'list', choices: Object.values(languageSuperBlocks) }, { name: 'block', message: 'What is the dashed name (in kebab-case) for this block?', validate: validateBlockName, filter: (block: string) => { return block.toLowerCase().trim(); } }, { name: 'title', default: ({ block }: { block: string }) => block }, { name: 'helpCategory', message: 'Choose a help category', default: 'English', type: 'list', choices: helpCategories } ]) .then( async ({ superBlock, block, helpCategory, title }: CreateBlockArgs) => await createLanguageBlock(superBlock, block, helpCategory, title) ) .then(() => console.log( 'All set. Now use pnpm run clean:client in the root and it should be good to go.' ) );