fix(tools): update helper scripts (#41923)

This commit is contained in:
Oliver Eyton-Williams
2021-04-27 20:29:49 +02:00
committed by GitHub
parent 300ff756ce
commit 17a7a84b48
4 changed files with 13 additions and 18 deletions

View File

@ -35,7 +35,7 @@ A one-off script that automatically adds a new step between two existing consecu
1. Change to the directory of the project. 1. Change to the directory of the project.
2. Run the following npm command: 2. Run the following npm command:
```bash ```bash
npm run create-step-between start=X end=Y # where X is the starting step number and Y is the following step number. npm run create-step-between start=X # where X is the starting step number
``` ```
## [delete-step.js](delete-step.js) ## [delete-step.js](delete-step.js)

View File

@ -22,8 +22,8 @@ if (!num) {
num = parseInt(num, 10); num = parseInt(num, 10);
const stepStart = parseInt(start, 10); const stepStart = parseInt(start, 10);
if (num < 1 || num > 20) { if (num < 1 || num > 100) {
throw `No steps created. arg 'num' must be between 1 and 20 inclusive`; throw `No steps created. arg 'num' must be between 1 and 100 inclusive`;
} }
const maxStepNum = stepStart + num - 1; const maxStepNum = stepStart + num - 1;

View File

@ -14,25 +14,17 @@ const allStepsExist = (steps, stepsToFind) =>
const projectPath = getProjectPath(); const projectPath = getProjectPath();
const args = getArgValues(process.argv); const args = getArgValues(process.argv);
let { start, end } = args; const start = parseInt(args.start, 10);
start = parseInt(start, 10);
end = parseInt(end, 10);
if ( if (!Number.isInteger(start) || start < 1) {
!Number.isInteger(start) || throw 'Step not created. Start step must be greater than 0.';
!Number.isInteger(end) ||
start < 1 ||
start !== end - 1
) {
throw (
'Step not created. Steps specified must be' +
' consecutive numbers and start step must be greater than 0.'
);
} }
const end = start + 1;
const existingSteps = getExistingStepNums(projectPath); const existingSteps = getExistingStepNums(projectPath);
if (!allStepsExist(existingSteps, [start, end])) { if (!allStepsExist(existingSteps, [start, end])) {
throw 'Step not created. At least one of the steps specified does not exist.'; throw `Step not created. Both start step, ${start}, and end step, ${end}, must exist`;
} }
const challengeSeeds = getChallengeSeeds( const challengeSeeds = getChallengeSeeds(

View File

@ -85,6 +85,7 @@ ${seedTails}`
id: ${ObjectID.generate()} id: ${ObjectID.generate()}
title: Part ${stepNum} title: Part ${stepNum}
challengeType: 0 challengeType: 0
dashedName: part-${stepNum}
--- ---
# --description-- # --description--
@ -176,11 +177,13 @@ const reorderSteps = () => {
const challengeID = frontMatter.data.id || ObjectID.generate(); const challengeID = frontMatter.data.id || ObjectID.generate();
const title = const title =
newFileName === 'final.md' ? 'Final Prototype' : `Part ${newStepNum}`; newFileName === 'final.md' ? 'Final Prototype' : `Part ${newStepNum}`;
const dashedName = `part-${newStepNum}`;
challengeOrder.push(['' + challengeID, title]); challengeOrder.push(['' + challengeID, title]);
const newData = { const newData = {
...frontMatter.data, ...frontMatter.data,
id: challengeID, id: challengeID,
title title,
dashedName
}; };
fs.writeFileSync(filePath, frontMatter.stringify(newData)); fs.writeFileSync(filePath, frontMatter.stringify(newData));
}); });