freeCodeCamp/tools/challenge-helper-scripts/README.md

freeCodeCamp Project-based Curriculum Tools

This folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.

create-next-step.js

A one-off script that will automatically add the next step based on the last step numbered as part-xxx.md where xxx represents the 3-digit step number of the last step. The challenge seed code will use the previous step's challenge seed code with the editable region markers (ERMs) removed.

Note: This script also runs reorder-steps.js.

How to run script:

1. Change to the directory of the project.
2. Run the following npm command:

npm run create-next-step

create-empty-steps.js

A one-off script that automatically adds a specified number of steps at a specific starting step number. The challenge seed code for all steps created will be empty.

Note: This script also runs reorder-steps.js.

How to run script:

1. Change to the directory of the project.
2. Run the following npm command:

npm run create-empty-steps start=X num=Y # where X is the starting step number and Y is the number of steps to create.

create-step-between.js

A one-off script that automatically adds a new step between two existing consecutive steps. The challenge seed code will use the existing starting step's challenge seed code with the editable region markers (ERMs) removed.

Note: This script also runs reorder-steps.js.

How to run script:

1. Change to the directory of the project.
2. Run the following npm command:

npm run create-step-between start=X end=Y # where X is the starting step number and Y is the following step number.

delete-step.js

A one-off script that deletes an existing step and then reorders the remaining step files in the project's folder as well as updates the challengeOrder property array in the project's meta.json with the new order of the steps.

How to run script

1. Change to the directory of the project.
2. Run the following npm command:

npm run delete-step num=x # where x is the step number to be deleted.

reorder-steps.js

A one-off script that automatically reorders the step files in a project's markdown files based on the filename. It also updates the challengeOrder property array in the project's meta.json with the new order of the steps.

Working Example

Let's say you start with the following project structure:

part-1.md
part-2.md
part-3.md
part-4.md
part-5.md
part-6.md

At some point you decide you need to delete part-2.md, because that step is no longer needed. Also, you decide to break down part-4.md into three steps instead of just one.

To accomplish the this restructure, you would need to delete part-2.md and then add a part-4a.md and a part=5b.md. The new folder structure would look like the following:

part-001.md
part-003.md
part-004.md
part-004a.md
part-004b.md
part-005.md
part-006.md

You now need the file names to be part-1.md through part-7.md, because you removed one but gained two more for a net difference of one file. Also, the frontmatter of each file below a deleted step or added step will need to be modified by making the title key value match the new step number. For example, after renaming part-3.md to part-2.md, you would need to change part-2.md's title from Part 03 to Part 02.

See below for the actual project folder changes needed:

part-001.md
part-003.md renamed to part-002.md and title changes to "Part 2"
part-004.md renames to part-003.md and title changes to "Part 3"
part-004a.md renames to part-004.md and title changes to "Part 4"
part-004b.md renames to part-005.md and title changes to "Part 5"
part-005.md renames to part-006.md and title changes to "Part 6"
part-006.md renames to part-007.md and title changes to "Part 7"

Along with the above changes, the challengeOrder key in the project's meta.json file needs to reflect the new step order. This is needed because each step below a step deletion and/or step addtion changes the title assoiciated with each of the affected step's challenge id.

How to run script

1. Change to the directory of the project.
2. Run the following npm command:

npm run reorder-steps