- Notifications
You must be signed in to change notification settings - Fork0
CLI for CodeRoad tutorial creation
License
myhololens/coderoad-cli
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Command line interface forCodeRoad.
Use CodeRoad CLI to set up and build a tutorial configuration file.
npm install -g @coderoad/cli
Create templates files for building a new tutorial.
coderoad create
Templates for specific coding languages to come.
Build the configuration file to be used by the extension to run the tutorial.
coderoad build
Defaults assume:
- a
TUTORIAL.mdmarkdown file (change with--markdown OTHER.md) - a
coderoad.yamlfile (change with--yaml other.yaml) - an output file of
tutorial.json(change with--output other.json)
The configuration file is created by matching thelevel andstep ids between theTUTORIAL.md andcoderoad.yaml files against git commit messages with the same ids. For example:
TUTORIAL.md
#Tutorial TitleTutorial description.##1. This is a level with id = 1This level has two steps...###1.1 First stepThe first step with id L1S1. The Step id should start with the level id.####HINTS- The first hint available when a user requests a hint- The second hint that will show- The third and final hint, as it is last in order###1.2 The second stepThe second step...
coderoad.yaml
---levels: -id:"1"config:{}steps: -id:"1.1"setup:files: -package.jsoncommands: -npm installsolution:files: -package.jsoncommands: -npm install -id:"1.2"setup:files: -src/server.jscommands: -npm installsolution:files: -src/server.js
... and the commit messages
commit 8e0e3a42ae565050181fdb68298114df21467a74 (HEAD -> v2, origin/v2)Author: creator <author@email.com>Date: Sun May 3 16:16:01 2020 -0700 1.1 some messagecommit 9499611fc9b311040dcabaf2d98439fc0c356cc9Author: creator <author@email.com>Date: Sun May 3 16:13:37 2020 -0700 1.1S some messagecommit c5c62041282579b495d3589b2eb1fdda2bcd7155Author: creator <author@email.com>Date: Sun May 3 16:11:42 2020 -0700 1.2 some messageNote that the step1.1 has two commits, one with the suffixS. The first commit refers to the required tests and setup, while the second optional commit contains the solution. If there are multiple commits for a level or step, they are captured in order.
About
CLI for CodeRoad tutorial creation
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Languages
- TypeScript99.9%
- JavaScript0.1%