@jutge.org/toolkit 4.2.38 → 4.3.0

package/docs/getting-started-guide.md

@@ -241,6 +241,7 @@ jtk generate problem                # Create problem with AI
 jtk make                            # Build all problem elements
 jtk verify <program>                # Test a solution
 jtk upload                          # Upload to Jutge.org
+jtk submit -l <language> <solution> # Submit a solution to Jutge.org
 jtk clean                           # Clean temporary files
 jtk passcode                        # Manage problem passcode
 

package/docs/login.md

@@ -0,0 +1 @@
+

package/docs/windows.md

@@ -0,0 +1,106 @@
+# Notes for Windows
+
+## Installation
+
+- Use PowerShell as terminal. Remember to reopen the terminal after the installation of each tool.
+
+- Bun is a JavaScript runtime like Node.js but faster and lighter.
+  It is required to run the toolkit on Windows. Install `bun` from https://bun.sh/. It is easy.
+
+- Install the toolkit using `bun`:
+
+    ```sh
+    bun install --global "@jutge.org/toolkit"
+    ```
+
+    The first time may take a while as `bun` needs to download and compile some dependencies. If it fails with a `mkdir` error, just try again, it seems to be a transient error.
+
+- Check that the installation was successful:
+
+    ```sh
+    jtk
+    ```
+
+    It should show the help message. You can always add a `--help` flag to any command to get more information.
+
+- Check the tools required by the toolkit:
+
+    ```sh
+    jtk doctor
+    ```
+
+    It should print information about the installed tools. If any tool is missing, consider installing it and try again. Depending on your workflow, some dependencies may not be necessary.
+
+## Upgrade
+
+Try to use the latest version of the toolkit. Upgrade the toolkit to the latest version with the following command:
+
+```powershell
+jtk upgrade
+```
+
+Check the version after upgrading:
+
+```powershell
+jtk --version
+```
+
+## Dependencies
+
+- LaTeX: A LaTeX distribution is required to compile problem statements and get their PDFs. It is not necessary but strongly recommended.
+
+    For Windows, install MiKTeX from https://miktex.org/download. During installation, select the option to install missing packages on-the-fly.
+
+- Pandoc: Pandoc with Lua support is required to convert problem statements to Markdown, Text and HTML. It is not necessary but recommended.
+
+    Install it easily using the Windows Package Manager (`winget`):
+
+    ```powershell
+    winget install --id JohnMacFarlane.Pandoc
+    ```
+
+- Python 3: You only need Python 3 if you plan to use Python scripts in your problems.
+
+    Install Python from https://www.python.org/downloads/windows/. Make sure to check the option to add Python to the system PATH during installation. The toolkit uses `python3` command to run Python scripts.
+
+- C/C++ Compiler: You only need a C/C++ compiler if you plan to use C/C++ programs in your problems. The toolkit uses `gcc` and `g++` commands to compile C and C++ programs, respectively.
+
+    We suggest using [w64devkit](https://github.com/skeeto/w64devkit), a portable C and C++ development kit for Windows. Here are the steps to install it:
+    1. **Download** the latest `.exe` file from https://github.com/skeeto/w64devkit/releases.
+
+    2. **Extract** by double-clicking the downloaded file and choosing a destination (e.g., `C:\w64devkit`).
+
+    3. **Run** `w64devkit.exe` from the extracted folder to open a terminal with gcc and g++ available.
+
+    4. **Test** by typing `gcc --version` in the terminal.
+
+    5. **Compile programs:**
+
+        ```bash
+        gcc myprogram.c -o myprogram.exe
+        g++ myprogram.cpp -o myprogram.exe
+        ```
+
+    Other options are to install [MinGW-w64](http://mingw-w64.org/doku.php) or use the compiler provided by [MSYS2](https://www.msys2.org/).
+
+- Java: You only need Java if you plan to use Java programs in your problems. The toolkit uses the `java` and `javac` commands to run and compile Java programs, respectively.
+
+    Install the Java Runtime Environment (JRE) from https://www.java.com/en/download/manual.jsp. Make sure to download the Windows version.
+
+- Likewise, you may need to install Rust, Haskell and Clojure if you plan to use these languages in your problems. If you know how to install them on Windows, please consider contributing to the documentation.
+
+## Miscellaneous tips
+
+- Open a file with its associated application with `start filename.extension`.
+
+- Show environment variables with `echo $env:VARIABLE`.
+
+- Set environment temporarly variables with `$env:VARIABLE=value`.
+
+- Set environment variables permanently with `[System.Environment]::SetEnvironmentVariable('VARIABLE', 'value', 'User')`.
+
+- Console font doesn't support Unicode: The default console font (Raster Fonts) doesn't support many Unicode characters. Change to a font like "Consolas", "Lucida Console", or "Cascadia Code" in your PowerShell window properties.
+
+```
+
+```

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@jutge.org/toolkit",
     "description": "Toolkit to prepare problems for Jutge.org",
-    "version": "4.2.38",
+    "version": "4.3.0",
     "homepage": "https://jutge.org",
     "author": {
         "name": "Jutge.org",
@@ -84,6 +84,7 @@
         "pretty-ms": "^9.3.0",
         "radash": "^12.1.1",
         "semver": "^7.7.3",
+        "sharp": "^0.34.5",
         "terminal-link": "^5.0.0",
         "tree-node-cli": "^1.6.0",
         "yaml": "^2.8.2",

package/toolkit/ai.ts

@@ -0,0 +1,56 @@
+import { Command } from '@commander-js/extra-typings'
+import sharp from 'sharp'
+import z from 'zod'
+import { complete, generateImage, listModels } from '../lib/ai.ts'
+import { settings } from '../lib/settings.ts'
+import tui from '../lib/tui.ts'
+import { convertStringToItsType } from '../lib/utils.ts'
+
+export const aiCmd = new Command('ai')
+    .description('Query AI models')
+
+    .action(() => {
+        aiCmd.help()
+    })
+
+aiCmd
+    .command('models')
+    .description('Show available AI models')
+
+    .action(async () => {
+        const models = await listModels()
+        tui.yaml(models)
+    })
+
+aiCmd
+    .command('complete')
+    .description('Complete a prompt using an AI model')
+
+    .argument('<prompt>', 'the user prompt to complete')
+    .option('-s, --system-prompt <system>', 'the system prompt to use', 'You are a helpful assistant.')
+    .option('-m, --model <model>', 'the AI model to use', settings.defaultModel)
+
+    .action(async (prompt, { model, systemPrompt }) => {
+        prompt = prompt.trim()
+        systemPrompt = systemPrompt.trim()
+        const answer = await complete(model, systemPrompt, prompt)
+        tui.print(answer)
+    })
+
+// TODO: generate with different aspect ratios
+aiCmd
+    .command('image')
+    .description('Generate a square image using an AI model')
+
+    .argument('<prompt>', 'description of the image to generate')
+    .option('-m, --model <model>', 'the graphic AI model to use', 'openai/dall-e-3')
+    .option('-s, --size <size>', 'the size of the image (in pixels)', '1024')
+    .option('-o, --output <path>', 'the output image path', 'image.png')
+
+    .action(async (prompt, { model, size, output }) => {
+        const sizeInt = z.int().min(16).max(2048).parse(convertStringToItsType(size))
+        const image = await generateImage(model, prompt)
+        await sharp(image).resize(sizeInt, sizeInt).toFile(output)
+        tui.success(`Generated image saved to ${output}`)
+        await tui.image(output, 20, 10)
+    })

package/toolkit/generate.ts

@@ -1,5 +1,8 @@
 import { Argument, Command } from '@commander-js/extra-typings'
+import { join } from 'path'
+import sharp from 'sharp'
 import { createProblemWithJutgeAI } from '../lib/create-with-jutgeai'
+import { complete } from '../lib/aiclient'
 import { languageKeys, languageNames, proglangKeys, proglangNames } from '../lib/data'
 import {
     addAlternativeSolution,
@@ -10,6 +13,7 @@ import {
 import { newProblem } from '../lib/problem'
 import { settings } from '../lib/settings'
 import tui from '../lib/tui'
+import { writeText } from '../lib/utils'
 import { getLoggedInJutgeClient } from '../lib/login'
 
 export const generateCmd = new Command('generate')
@@ -153,7 +157,7 @@ generateCmd
             if (all || efficiency) await generateTestCasesGenerator(jutge, model, problem, output, 'efficiency')
         })
     })
-/*
+
 generateCmd
     .command('award.png')
     .summary('Generate award.png using JutgeAI')
@@ -179,15 +183,25 @@ The new image will be saved as award.png in the problem directory, overriding an
     .argument('[prompt]', 'prompt to generate the image', '')
 
     .action(async (prompt, { directory, model }) => {
+        const jutge = await getLoggedInJutgeClient()
         const output = join(directory, 'award.png')
         const problem = await newProblem(directory)
-        if (prompt.trim() === '') {
-            prompt = problem.problemLangYmls[problem.originalLanguage!].title || 'A colorful award'
+        let imagePrompt = prompt.trim()
+        if (imagePrompt === '') {
+            imagePrompt = 'A colorful award on a white background'
         }
-        const image = await generateImage(model, prompt)
-        await sharp(image).resize(512, 512).toFile(output)
-        await tui.image(output, 20, 10)
-        tui.success(`Added ${output}`)
+        await tui.section('Generating award image', async () => {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call -- generated API client
+            const download = await jutge.instructor.jutgeai.createImage({
+                model,
+                label: 'award',
+                prompt: imagePrompt,
+                size: '1024x1024',
+            })
+            await sharp(Buffer.from(download.data)).resize(512, 512).toFile(output)
+            await tui.image(output, 20, 10)
+            tui.success(`Added ${output}`)
+        })
     })
 
 generateCmd
@@ -217,11 +231,14 @@ The new message will be saved as award.html in the problem directory, overriding
     .option('-m, --model <model>', 'AI model to use', settings.defaultModel)
 
     .action(async (prompt, { directory, model }) => {
+        const jutge = await getLoggedInJutgeClient()
         const output = join(directory, 'award.html')
-        const problem = await newProblem(directory)
-        const message = await complete(model, '', prompt)
-        tui.print(message)
-        await writeText(output, message)
-        tui.success(`Added ${output}`)
+        const systemPrompt =
+            'You generate short textual award messages shown when a user solves a problem. Output only the message text, no markdown code blocks or explanation. If you like, use a famous quote by a famous person. In this case, use the name of the person in the message.'
+        await tui.section('Generating award message', async () => {
+            const message = await complete(jutge, model, 'award', systemPrompt, prompt)
+            tui.print(message)
+            await writeText(output, message)
+            tui.success(`Added ${output}`)
+        })
     })
-*/

package/toolkit/index.ts

@@ -18,6 +18,7 @@ import { quizCmd } from './quiz'
 import { upgradeCmd } from './upgrade'
 import { uploadCmd } from './upload'
 import { cmdPasscode } from './passcode'
+import { submitCmd } from './submit'
 import { askCmd } from './ask'
 import { convertCmd } from './convert'
 import { stageCmd } from './stage'
@@ -36,6 +37,7 @@ program.addCommand(cleanCmd)
 program.addCommand(cloneCmd)
 program.addCommand(generateCmd)
 program.addCommand(verifyCmd)
+program.addCommand(submitCmd)
 program.addCommand(convertCmd)
 program.addCommand(stageCmd)
 program.addCommand(doctorCmd)

package/toolkit/submit.ts

@@ -0,0 +1,14 @@
+import { Command } from '@commander-js/extra-typings'
+import { submitInDirectory } from '../lib/submit'
+
+export const submitCmd = new Command('submit')
+    .summary('Submit solutions to Jutge.org')
+
+    .argument('<programs...>', 'programs to submit (e.g. solution.cc slow.py buggy.py)')
+    .option('-d, --directory <directory>', 'problem directory', '.')
+    .option('-l, --language <code>', 'language code (ca, es, en, ...)', 'en')
+    .option('-n, --no-wait', 'do not wait for submissions to be judged')
+
+    .action(async (programs, { directory, language, wait }) => {
+        await submitInDirectory(directory, language, programs, !wait)
+    })