@jutge.org/toolkit 4.2.10 → 4.2.12

package/docs/problem-anatomy.md

@@ -116,7 +116,7 @@ This optional section describes the output of the problem.
 
 The `\Sample` section will contain the sample test cases. It is possible to adjust the formatting of the sample test cases: `\SampleOneCol` places input and output test cases one below the other, while `\SampleTwoCol` places them side by side.
 
-`RunPython` users should use `\SampleSession` to get their sample test cases properly formatted as interactive Python sessions using `sample.dt`. [CHECK]
+`RunPython` users should use `\SampleSession` to get their sample test cases properly formatted as interactive Python sessions using `sample.dt`. The `sample.dt` file should contain the sample test cases using the [doctest](https://docs.python.org/3/library/doctest.html) format and currently must be generated by hand.
 
 The title inside the `\Problem{}` macro should match the title in the metadata given in the `problem.lang.yml` file, but the title in the LaTeX file can contain math or LaTeX macros whereas the title in the YAML file should be plain text.
 
@@ -386,6 +386,10 @@ Python solutions should have all their executable code inside an `if __name__ ==
 
 Java solutions must have their `main` function placed in a `Main` class. See https://jutge.org/documentation/compilers/JDK for some examples.
 
+## Code templates
+
+Some problems may provide a code template where users can fill in with their own implementation. Code templates are named `code.ext`, where `ext` is the standard extension that corresponds to the selected programming language. For instance, a problem may contain `code.cc` and `code.py` in order to provide code templates in C++ and Python3.
+
 ## Scores
 
 In order to score submissions according to the correct test cases they pass, the file `scores.yml` must exist. `scores.yml` describes the scoring of a problem using YAML syntax. The scores are given through a list of partial scores. Each partial score contains the following fields:

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@jutge.org/toolkit",
     "description": "Toolkit to prepare problems for Jutge.org",
-    "version": "4.2.10",
+    "version": "4.2.12",
     "homepage": "https://jutge.org",
     "author": {
         "name": "Jutge.org",
@@ -53,6 +53,8 @@
     ],
     "dependencies": {
         "@commander-js/extra-typings": "^14.0.0",
+        "@dicebear/collection": "^9.3.1",
+        "@dicebear/core": "^9.3.1",
         "@eslint/js": "^9.39.2",
         "@inquirer/prompts": "^8.2.0",
         "archiver": "^7.0.1",
@@ -61,10 +63,10 @@
         "chalk": "^5.6.2",
         "cli-highlight": "^2.1.11",
         "commander": "^14.0.2",
+        "dayjs": "^1.11.19",
         "env-paths": "^3.0.0",
         "eslint": "^9.39.2",
         "execa": "^9.6.1",
-        "extract-zip": "^2.0.1",
         "gpt-tokenizer": "^3.4.0",
         "handlebars": "^4.7.8",
         "image-size": "^2.0.2",

package/toolkit/index.ts

@@ -20,6 +20,7 @@ import { upgradeCmd } from './upgrade'
 import { uploadCmd } from './upload'
 import { askCmd } from './ask'
 import { convertCmd } from './convert'
+import { stageCmd } from './stage'
 
 program.name(Object.keys(packageJson.bin as Record<string, string>)[0] as string)
 program.alias(Object.keys(packageJson.bin as Record<string, string>)[1] as string)
@@ -28,26 +29,28 @@ program.description(packageJson.description!)
 program.helpCommand('help [command]', 'Display help for command') // To get the message with uppercase :-)
 program.addHelpText('after', '\nMore documentation:\n  https://github.com/jutge-org/new-jutge-toolkit/tree/main/docs')
 
-program.addCommand(configCmd)
-program.addCommand(cloneCmd)
-program.addCommand(generateCmd)
 program.addCommand(makeCmd)
 program.addCommand(uploadCmd)
 program.addCommand(cleanCmd)
+program.addCommand(cloneCmd)
+program.addCommand(generateCmd)
 program.addCommand(verifyCmd)
 program.addCommand(convertCmd)
+program.addCommand(stageCmd)
 program.addCommand(doctorCmd)
 if (settings.developer) {
     program.addCommand(quizCmd)
     program.addCommand(compilersCmd)
     program.addCommand(aiCmd)
 }
+program.addCommand(configCmd)
 program.addCommand(upgradeCmd)
 program.addCommand(aboutCmd)
 program.addCommand(askCmd)
 
 try {
     await program.parseAsync()
+    process.exit(0)
 } catch (error) {
     console.log()
     console.error('An error occurred:')
@@ -63,4 +66,5 @@ try {
     } else {
         console.error(error)
     }
+    process.exit(1)
 }

package/toolkit/make.ts

@@ -6,7 +6,7 @@ import tui from '../lib/tui'
 import { nothing, projectDir } from '../lib/utils'
 
 export const makeCmd = new Command('make')
-    .description('Make problem elements')
+    .description('Make problem')
 
     .argument('[tasks...]', 'tasks to make: all|info|exe|cor|pdf|txt|md|html', ['all'])
     .option('-d, --directories <directories...>', 'problem directories', ['.'])
@@ -56,7 +56,10 @@ export const makeCmd = new Command('make')
                         await maker.makePdfStatements()
                     }
                     if (tasks.includes('txt') || tasks.includes('html') || tasks.includes('md')) {
-                        await maker.makeTextualStatements(
+                        await maker.makeFullTextualStatements(
+                            tasks.filter((t) => ['txt', 'html', 'md'].includes(t)) as Array<'txt' | 'html' | 'md'>,
+                        )
+                        await maker.makeShortTextualStatements(
                             tasks.filter((t) => ['txt', 'html', 'md'].includes(t)) as Array<'txt' | 'html' | 'md'>,
                         )
                     }

package/toolkit/stage.ts

@@ -0,0 +1,13 @@
+import { Command } from '@commander-js/extra-typings'
+import { Stager } from '../lib/stager'
+
+export const stageCmd = new Command('stage')
+    .summary('Stage problem')
+
+    .option('-d, --directory <directory>', 'problem directory', '.')
+    .option('-p, --problem_nm <problem_nm>', 'problem_nm', 'DRAFT')
+
+    .action(async ({ directory, problem_nm }) => {
+        const stager = new Stager(directory, problem_nm)
+        await stager.stage()
+    })

package/toolkit/upload.ts

@@ -8,6 +8,8 @@ export const uploadCmd = new Command('upload')
 
 If problem.yml exists, the problem will be updated at Jutge.org using that information (which includes its problem id).
 If problem.yml does not exist, a new problem will be created at Jutge.org and problem.yml will be generated.
+
+Please clean the problem directory before uploading to avoid uploading unnecessary files.
 `,
     )