freecodecamp--freecodecamp/tools/challenge-helper-scripts/helpers/project-metadata.ts

import path from 'path';
import {
  getBlockStructure,
  writeBlockStructure
} from '@freecodecamp/curriculum/file-handler';
import type { BlockLabel } from '@freecodecamp/shared/config/blocks';
import { getProjectPath } from './get-project-info.js';

export type Meta = {
  blockLayout: string;
  blockLabel?: BlockLabel;
  isUpcomingChange: boolean;
  dashedName: string;
  helpCategory: string;
  time: string;
  template: string;
  required: string[];
  challengeOrder: { id: string; title: string }[];
};

function getMetaData() {
  const block = getBlock(getProjectPath());
  return getBlockStructure(block) as Meta;
}

function getBlock(filePath: string) {
  return path.basename(filePath);
}

async function updateMetaData(newMetaData: Record<string, unknown>) {
  const block = getBlock(getProjectPath());
  await writeBlockStructure(block, newMetaData);
}

export { getMetaData, updateMetaData, getBlock };