ysandler/brightScreen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📕 update readme config examples

Browse Source
This commit is contained in:
ysandler 2020-09-08 20:25:21 -05:00 committed by Joshua Shoemaker
parent 8d9ac8beba
commit 30b6094619
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -18,7 +18,7 @@ All that is required is a Git repo with a brightScreen.json configuration file t
"documentationUrl": "https://brightScreen.io/courses/Test-Lesson/", "documentationUrl": "https://brightScreen.io/courses/Test-Lesson/",
"lessons": [ "lessons": [
{ {
"name": "Lesson 1", "name": "Lesson One",
"location": "lessonOne/indexTest.js", "location": "lessonOne/indexTest.js",
"description": "Test Description for Lesson 1", "description": "Test Description for Lesson 1",
"executionPrefix": "node", "executionPrefix": "node",
@ -39,15 +39,17 @@ A course testing file will look something like this:
const testedValue = codeFromUser(input) const testedValue = codeFromUser(input)
if (testedValue === expectedOutput) { if (testedValue === expectedOutput) {
console.log({ const message = {
didPass: true, didPass: true,
message: 'Passed Test 1' message: 'Passed Test 1'
}) }
console.log(JSON.stringify(message))
} else { } else {
console.log({ const message = {
didPass: false, didPass: false,
message: 'Did not return expected value' message: 'Did not return expected value'
}) }
console.log(JSON.stringify(message))
} }
} }
@ -59,11 +61,11 @@ In theory, any interpreted language can be used for a course as long as it can b
Your tests are created as a child process. To interface vack with brightScreen, your tests should return a JSON object through the Standard Out of what every platform you are testing with. Your tests are created as a child process. To interface vack with brightScreen, your tests should return a JSON object through the Standard Out of what every platform you are testing with.
Example of Standard Iut from Tests Example of Standard Out from Tests
{ {
didPass: false, "didPass": false,
message: 'Value was not FizzBuzz' "message": "Value was not FizzBuzz"
} }