@jutge.org/toolkit 4.4.16 → 4.4.19

package/toolkit/quiz.ts

@@ -1,44 +1,79 @@
 import { Command } from '@commander-js/extra-typings'
-import { makeQuiz, validateQuiz } from '../lib/quiz'
+import { runQuiz, lintQuiz } from '../lib/quiz'
+import {
+    loadQuizTestInput,
+    playQuiz,
+    writeQuizTestOutput,
+} from '../lib/play-quiz'
 import tui from '../lib/tui'
 import { findRealDirectories } from '../lib/helpers'
 import { random } from 'radash'
 
 export const quizCmd = new Command('quiz')
-    .description('Commands related to quizzes')
+    .summary('Commands related to quizzes')
 
     .action(() => {
         quizCmd.help()
     })
 
 quizCmd
-    .command('validate')
-    .description('Validate a quiz problem')
+    .command('lint')
+    .summary('Lint a quiz problem')
 
     .option('-d, --directory <directory>', 'problem directory', '.')
 
     .action(async ({ directory }) => {
         const realDirectories = await findRealDirectories([directory])
         for (const directory of realDirectories) {
-            await tui.section(`Validating quiz in directory ${tui.hyperlink(directory)}`, async () => {
-                await validateQuiz(directory)
+            await tui.section(`Linting quiz in directory ${tui.hyperlink(directory)}`, async () => {
+                await lintQuiz(directory)
             })
         }
     })
 
 quizCmd
-    .command('make')
-    .description('Make a quiz problem')
+    .command('run')
+    .summary('Run a quiz problem')
+    .description(
+        `Run a quiz problem.
+
+This command will run the quiz problem and print the resulting object to stdout.
+A random seed will be generated if not provided.
+`)
 
     .option('-d, --directory <directory>', 'problem directory', '.')
     .option('-s, --seed <seed>', 'random seed')
+    .option('-f, --format <format>', 'output format (json|yaml)', 'json')
 
-    .action(async ({ directory, seed }) => {
-        tui.warning('The quiz make command is work-in-progress and may not work as expected yet.')
-        const realDirectories = await findRealDirectories([directory])
+    .action(async ({ directory, seed, format }) => {
         const seedValue = seed ? parseInt(seed, 10) : random(1000000, 9999999)
-        for (const directory of realDirectories) {
-            await makeQuiz(directory, seedValue)
-            return // in this case we only process one directory as quizzes should only have one language
+        const object = await runQuiz(directory, seedValue)
+        if (format === 'json') {
+            tui.json(object)
+        } else {
+            tui.yaml(object)
+        }
+    })
+
+
+quizCmd
+    .command('play')
+    .summary('Play a quiz problem')
+    .description(
+        `Play an interactive quiz test. Questions are shown in sequence; you can review and change answers before submitting.
+Input is a JSON file from \`quiz run\`; if --input is omitted, a run is generated with a random seed from the given directory.
+If --output is given, the results (your answers, correct answers, and score per question) are written to that file.`)
+
+    .option('-i, --input <input>', 'input JSON file from quiz run')
+    .option('-o, --output <output>', 'output file for results')
+    .option('-d, --directory <directory>', 'problem directory (used when --input is not provided)', '.')
+    .option('-s, --seed <seed>', 'random seed (used when --input is not provided)')
+
+    .action(async ({ input, output, directory, seed }) => {
+        const seedValue = seed !== undefined ? parseInt(seed, 10) : undefined
+        const quizInput = await loadQuizTestInput(input, directory, seedValue)
+        const results = await playQuiz(quizInput)
+        if (output !== undefined) {
+            await writeQuizTestOutput(output, results)
         }
     })

package/toolkit/share.ts

@@ -2,11 +2,11 @@ import { password } from '@inquirer/prompts'
 import { Command } from '@commander-js/extra-typings'
 import { updateSharingSettings } from '../lib/share'
 
-
 export const cmdShare = new Command('share')
     .summary('Update and show sharing settings')
 
-    .description(`Update and show sharing settings
+    .description(
+        `Update and show sharing settings
 
 First, this command updates the sharing settings in problem.yml file with the ones on Jutge.org to ensure they are consistent.
 
@@ -18,7 +18,8 @@ Then, it updates the sharing settings in Jutge.org with the requested changes. T
     --solutions Share solutions
     --no-solutions Stop sharing solutions
 
-Finally, it updates problem.yml file with the current sharing settings and shows them.`)
+Finally, it updates problem.yml file with the current sharing settings and shows them.`,
+    )
 
     .option('-d, --directory <directory>', 'problem directory', '.')
     .option('--passcode [code]', 'Set a passcode (prompted if omitted)')
@@ -46,4 +47,4 @@ Finally, it updates problem.yml file with the current sharing settings and shows
         const solutions = this.getOptionValueSource('solutions') !== 'default' ? opts.solutions : undefined
 
         await updateSharingSettings(opts.directory, { passcode, testcases, solutions })
-    })
+    })

package/toolkit/submit.ts

@@ -10,7 +10,10 @@ export const submitCmd = new Command('submit')
     .option('-c, --compiler <id>', 'compiler to use (default: auto-detect from file extension)', 'auto')
     .option('-l, --language <code>', 'language code (ca, es, en, ...)', 'en')
     .option('-n, --no-wait', 'do not wait for submissions to be judged')
-    .option('--no-browser', 'do not open the submission URL in the browser (only print URL and/or wait for verdict in terminal)')
+    .option(
+        '--no-browser',
+        'do not open the submission URL in the browser (only print URL and/or wait for verdict in terminal)',
+    )
     .option('-a, --annotation <annotation>', "annotation for the submission (default: 'jtk-submit-<nanoid16>')")
 
     .action(async (programs, { directory, compiler, language, wait, browser, annotation }) => {