Class BlockCreator

curriculum/src/build-superblock.ts:265–423

  return addMetaToChallenge(fixChallengeProperties(challenge), meta);
}
export class BlockCreator {
  /**
   * @param {object} options - Options object
   * @param {string} options.blockContentDir - Directory containing block content files
   * @param {string} options.i18nBlockContentDir - Directory containing i18n block content files
   * @param {string} options.lang - Language code for the block content
   * @param {object} options.commentTranslations - Translations for comments in challenges
   * @constructor
   * @description Initializes the BlockCreator with directories for block content and structure.
   * This class is responsible for reading block directories, parsing challenges, and validating them
   * against the meta information.
   */

  blockContentDir: string;
  i18nBlockContentDir: string;
  lang: string;
  commentTranslations: CommentDictionary;
  skipValidation: boolean | undefined;

  constructor({
    blockContentDir,
    i18nBlockContentDir,
    lang,
    commentTranslations,
    skipValidation
  }: {
    blockContentDir: string;
    i18nBlockContentDir: string;
    lang: string;
    commentTranslations: CommentDictionary;
    skipValidation?: boolean;
  }) {
    this.blockContentDir = blockContentDir;
    this.i18nBlockContentDir = i18nBlockContentDir;
    this.lang = lang;
    this.commentTranslations = commentTranslations;
    this.skipValidation = skipValidation;
  }

  /**
   * Creates a challenge from a markdown file
   * @param {object} options - Options object
   * @param {string} options.filename - Name of the challenge file
   * @param {string} options.block - Name of the block
   * @param {object} options.meta - Meta information for the block
   * @param {boolean} options.isAudited - Whether the block is audited for i18n
   * @param {Function} parser - Parser function to use (defaults to parseMD)
   * @returns {Promise<object>} The finalized challenge object
   */
  async createChallenge(
    {
      filename,
      block,
      meta,
      isAudited
    }: { filename: string; block: string; meta: Meta; isAudited: boolean },
    parser = parseMD
  ) {