freeCodeCamp/tools/challenge-helper-scripts/create-daily-challenges.ts

/*
  Script to create daily coding challenge files in the dev-playground superblock.
  Accepts a number arg for how many challenges to create.
*/

import { readFileSync, writeFileSync } from 'fs';
import path, { join } from 'path';
import { fileURLToPath } from 'url';
import ObjectID from 'bson-objectid';
import { Meta } from './helpers/project-metadata';
import { getArgValue } from './helpers/get-arg-value';
import {
  getDailyJavascriptChallengeTemplate,
  getDailyPythonChallengeTemplate
} from './helpers/get-challenge-template';

const numberOfChallengesToCreate = getArgValue(process.argv);

if (numberOfChallengesToCreate > 10) {
  throw new Error('Are you sure you want to create that many challenges?');
}

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

const curriculumPath = join(__dirname, '../../curriculum');

const structureBlocksPath = join(curriculumPath, '/structure/blocks');
const jsStructurePath = join(
  structureBlocksPath,
  '/daily-coding-challenges-javascript.json'
);
const pyStructurePath = join(
  structureBlocksPath,
  '/daily-coding-challenges-python.json'
);

const challengeBlocksPath = join(curriculumPath, '/challenges/english/blocks');
const jsChallengesPath = join(
  challengeBlocksPath,
  '/daily-coding-challenges-javascript'
);
const pyChallengesPath = join(
  challengeBlocksPath,
  '/daily-coding-challenges-python'
);

for (let i = 0; i < numberOfChallengesToCreate; i++) {
  const jsMeta = JSON.parse(readFileSync(jsStructurePath, 'utf-8')) as Meta;
  const pyMeta = JSON.parse(readFileSync(pyStructurePath, 'utf-8')) as Meta;

  const numberOfJsChallenges = jsMeta.challengeOrder.length;
  const numberOfPyChallenges = pyMeta.challengeOrder.length;

  if (numberOfJsChallenges !== numberOfPyChallenges) {
    throw new Error(
      'Inconsistent number of challenges in each daily challenge language, cannot create new challenge.'
    );
  }

  const challengeId = new ObjectID();
  const newChallengeNumber = numberOfJsChallenges + 1;

  createDailyJsChallenge({
    challengeId,
    challengeNumber: newChallengeNumber,
    meta: jsMeta
  });
  createDailyPyChallenge({
    challengeId,
    challengeNumber: newChallengeNumber,
    meta: pyMeta
  });
}

interface CreateDailyChallengeOptions {
  challengeId: ObjectID;
  challengeNumber: number;
  meta: Meta;
}

function createDailyJsChallenge({
  challengeId,
  challengeNumber,
  meta
}: CreateDailyChallengeOptions) {
  const newMeta = {
    ...meta,
    challengeOrder: [
      ...meta.challengeOrder,
      {
        // eslint-disable-next-line @typescript-eslint/no-base-to-string
        id: challengeId.toString(),
        title: `Challenge ${challengeNumber}: Placeholder`
      }
    ]
  };

  writeFileSync(jsStructurePath, JSON.stringify(newMeta, null, 2));

  const jsTemplate = getDailyJavascriptChallengeTemplate({
    challengeId,
    challengeNumber
  });

  const jsChallengePath = join(
    jsChallengesPath,
    // eslint-disable-next-line @typescript-eslint/no-base-to-string
    `${challengeId.toString()}.md`
  );

  writeFileSync(jsChallengePath, jsTemplate);
}

function createDailyPyChallenge({
  challengeId,
  challengeNumber,
  meta
}: CreateDailyChallengeOptions) {
  const newMeta = {
    ...meta,
    challengeOrder: [
      ...meta.challengeOrder,
      {
        // eslint-disable-next-line @typescript-eslint/no-base-to-string
        id: challengeId.toString(),
        title: `Challenge ${challengeNumber}: Placeholder`
      }
    ]
  };

  writeFileSync(pyStructurePath, JSON.stringify(newMeta, null, 2));

  const pyTemplate = getDailyPythonChallengeTemplate({
    challengeId,
    challengeNumber
  });

  const pyChallengePath = join(
    pyChallengesPath,
    // eslint-disable-next-line @typescript-eslint/no-base-to-string
    `${challengeId.toString()}.md`
  );

  writeFileSync(pyChallengePath, pyTemplate);
}