chore: move to tools/challenge-helper-scripts

tools/challenge-helper-scripts/utils.js

@@ -0,0 +1,216 @@
+const fs = require('fs');
+const path = require('path');
+const matter = require('gray-matter');
+const ObjectID = require('bson-objectid');
+
+const padWithLeadingZeros = originalNum => {
+  /* always want file step numbers 3 digits */
+  const maxDigits = 3;
+  let paddedNum = '' + originalNum;
+  while (paddedNum.length < maxDigits) {
+    paddedNum = '0' + paddedNum;
+  }
+  return paddedNum;
+};
+
+const removeErms = seedCode => {
+  const lines = seedCode.split('\n');
+  return lines
+    .filter(line => !line.includes('--fcc-editable-region--'))
+    .join('\n');
+};
+
+const createStepFile = ({
+  projectPath,
+  stepNum,
+  challengeSeed = '',
+  stepBetween = false
+}) => {
+  if (challengeSeed) {
+    challengeSeed = removeErms(challengeSeed);
+  }
+
+  const descStepNum = stepBetween ? stepNum + 1 : stepNum;
+  const stepDescription = `${
+    stepBetween ? 'new' : ''
+  } step ${descStepNum} instructions`;
+  const challengeSeedSection = `<section id='challengeSeed'>
+
+${challengeSeed.trim()}
+
+</section>`;
+
+  const template = `---
+id: ${ObjectID.generate()}
+title: Part ${stepNum}
+challengeType: 0
+isHidden: true
+---
+
+## Description
+<section id='description'>
+
+${stepDescription}
+
+</section>
+
+## Tests
+<section id='tests'>
+
+\`\`\`yml
+tests:
+  - text: Test 1
+    testString: ''
+
+\`\`\`
+
+</section>
+
+## Challenge Seed
+${challengeSeedSection}
+`;
+
+  let finalStepNum = padWithLeadingZeros(stepNum);
+  finalStepNum += stepBetween ? 'a' : '';
+  fs.writeFileSync(`${projectPath}part-${finalStepNum}.md`, template);
+};
+
+const reorderSteps = () => {
+  const projectPath = getProjectPath();
+
+  const projectName = process.env.CALLING_DIR
+    ? process.env.CALLING_DIR.split(path.sep)
+        .slice(-1)
+        .toString()
+    : process
+        .cwd()
+        .split(path.sep)
+        .slice(-1)
+        .toString();
+
+  const curriculumPath = process.env.CALLING_DIR
+    ? ''
+    : path.join(__dirname, '../');
+
+  const projectMetaPath = path.resolve(
+    curriculumPath,
+    'challenges',
+    '_meta',
+    projectName,
+    'meta.json'
+  );
+
+  let metaData;
+  try {
+    metaData = fs.readFileSync(projectMetaPath);
+  } catch (err) {
+    throw `No _meta.json file exists at ${projectMetaPath}`;
+  }
+
+  let foundFinal = false;
+  const filesArr = [];
+  fs.readdirSync(projectPath).forEach(fileName => {
+    if (path.extname(fileName).toLowerCase() === '.md') {
+      if (!fileName.endsWith('final.md')) {
+        filesArr.push(fileName);
+      } else {
+        foundFinal = true;
+      }
+    }
+  });
+
+  if (foundFinal) {
+    filesArr.push('final.md');
+  }
+
+  const filesToReorder = filesArr.map((fileName, i) => {
+    const newStepNum = i + 1;
+    const newFileName =
+      fileName !== 'final.md'
+        ? `part-${padWithLeadingZeros(newStepNum)}.md`
+        : 'final.md';
+    return {
+      oldFileName: fileName,
+      newFileName,
+      newStepNum
+    };
+  });
+
+  const challengeOrder = [];
+  const parsedData = JSON.parse(metaData);
+
+  filesToReorder.forEach(({ oldFileName, newFileName, newStepNum }) => {
+    fs.renameSync(
+      `${projectPath}${oldFileName}`,
+      `${projectPath}${newFileName}.tmp`
+    );
+    const filePath = `${projectPath}${newFileName}.tmp`;
+    const frontMatter = matter.read(filePath);
+    const challengeID = frontMatter.data.id || ObjectID.generate();
+    const title =
+      newFileName === 'final.md' ? 'Final Prototype' : `Part ${newStepNum}`;
+    challengeOrder.push(['' + challengeID, title]);
+    const newData = {
+      ...frontMatter.data,
+      id: challengeID,
+      title
+    };
+    fs.writeFileSync(filePath, frontMatter.stringify(newData));
+  });
+
+  filesToReorder.forEach(({ newFileName }) => {
+    fs.renameSync(
+      `${projectPath}${newFileName}.tmp`,
+      `${projectPath}${newFileName}`
+    );
+  });
+
+  const newMeta = { ...parsedData, challengeOrder };
+  fs.writeFileSync(projectMetaPath, JSON.stringify(newMeta, null, 2));
+  console.log('Reordered steps');
+};
+
+const getChallengeSeed = challengeFilePath => {
+  const fileContent = fs.readFileSync(challengeFilePath, 'utf8');
+  const matchedSection = fileContent
+    .toString()
+    .match(/<section id='challengeSeed'>(?<challengeSeed>[\s\S]+)<\/section>/);
+  let finalChallengeSeed = '';
+  if (matchedSection) {
+    let {
+      groups: { challengeSeed }
+    } = matchedSection;
+    finalChallengeSeed = challengeSeed ? challengeSeed : '';
+  }
+  return finalChallengeSeed;
+};
+
+const getExistingStepNums = projectPath => {
+  return fs.readdirSync(projectPath).reduce((stepNums, fileName) => {
+    if (
+      path.extname(fileName).toLowerCase() === '.md' &&
+      !fileName.endsWith('final.md')
+    ) {
+      let stepNum = fileName.split('.')[0].split('-')[1];
+      if (!/^\d{3}$/.test(stepNum)) {
+        throw `Step not created. File ${fileName} has a step number containing non-digits.` +
+          ' Please run reorder-steps script first.';
+      }
+      stepNum = parseInt(stepNum, 10);
+      stepNums.push(stepNum);
+    }
+    return stepNums;
+  }, []);
+};
+
+const getProjectPath = () =>
+  (process.env.CALLING_DIR || process.cwd()) + path.sep;
+
+module.exports = {
+  createStepFile,
+  getChallengeSeed,
+  padWithLeadingZeros,
+  reorderSteps,
+  getExistingStepNums,
+  getProjectPath
+};