@jpetit/toolkit 3.0.23 → 3.1.2

package/package.json

@@ -1,27 +1,52 @@
 {
     "name": "@jpetit/toolkit",
     "description": "Toolkit to prepare problems for Jutge.org",
-    "version": "3.0.23",
+    "version": "3.1.2",
+    "homepage": "https://jutge.org",
+    "author": {
+        "name": "Jutge.org",
+        "email": "info@jutge.org",
+        "url": "https://jutge.org"
+    },
+    "contributors": [
+        {
+            "name": "Jordi Petit",
+            "url": "https://github.com/jordi-petit"
+        },
+        {
+            "name": "Pau Fernández",
+            "url": "https://github.com/pauek"
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/jutge-org/jutge-toolkit.git"
+    },
     "publishConfig": {
         "access": "public"
     },
     "module": "index.ts",
     "type": "module",
-    "bin": "toolkit/index.ts",
+    "bin": {
+        "jutge-toolkit": "toolkit/index.ts",
+        "jtk": "toolkit/index.ts"
+    },
     "scripts": {
         "lint": "eslint .",
         "format": "bun prettier --write .",
-        "depcheck": "bunx depcheck"
+        "depcheck": "bunx depcheck",
+        "update-jutge-client": "(cd lib ; rm -f jutge_api_client.ts ; https --download https://api.jutge.org/clients/download/typescript)"
     },
     "files": [
+        "assets",
         "lib",
-        "toolkit",
-        "assets"
+        "toolkit"
     ],
     "dependencies": {
         "@commander-js/extra-typings": "^14.0.0",
         "@eslint/js": "^9.39.2",
         "@inquirer/prompts": "^8.1.0",
+        "archiver": "^7.0.1",
         "boxen": "^8.0.1",
         "bun-types": "^1.3.5",
         "chalk": "^5.6.2",
@@ -30,35 +55,49 @@
         "eslint": "^9.39.2",
         "execa": "^9.6.1",
         "gpt-tokenizer": "^3.4.0",
+        "handlebars": "^4.7.8",
         "human-id": "^4.1.3",
         "image-size": "^2.0.2",
-        "install": "^0.13.0",
-        "jdenticon": "^3.3.0",
+        "inquirer-checkbox-plus-plus": "^1.1.1",
         "marked": "^17.0.1",
         "marked-terminal": "^7.3.0",
         "multi-llm-ts": "^4.6.2",
         "nanoid": "^5.1.6",
+        "openai": "^6.15.0",
         "ora": "^9.0.0",
         "prettier": "^3.7.4",
         "pretty-bytes": "^7.1.0",
         "pretty-ms": "^9.3.0",
         "radash": "^12.1.1",
-        "slug": "^11.0.1",
+        "semver": "^7.7.3",
+        "sharp": "^0.34.5",
         "terminal-image": "^4.1.0",
         "terminal-link": "^5.0.0",
-        "typescript-eslint": "^8.50.0",
+        "typescript-eslint": "^8.51.0",
         "yaml": "^2.8.2",
-        "zod": "^4.2.1"
+        "zod": "^4.3.4",
+        "zod-package-json": "^2.1.0",
+        "zod-validation-error": "^5.0.0"
     },
     "devDependencies": {
+        "@types/archiver": "^7.0.0",
         "@types/image-size": "^0.8.0",
         "@types/marked": "^6.0.0",
         "@types/marked-terminal": "^6.1.1",
         "@types/node": "^25.0.3",
         "@types/ora": "^3.2.0",
-        "@types/slug": "^5.0.9"
+        "@types/semver": "^7.7.1"
     },
     "peerDependencies": {
         "typescript": "^5.9.3"
+    },
+    "prettier": {
+        "semi": false,
+        "singleQuote": true,
+        "trailingComma": "all",
+        "tabWidth": 4,
+        "useTabs": false,
+        "arrowParens": "always",
+        "printWidth": 120
     }
 }

package/toolkit/about.ts

@@ -0,0 +1,43 @@
+import { Command } from '@commander-js/extra-typings'
+import chalk from 'chalk'
+import { nothing, projectDir, readJson } from '../lib/utils.ts'
+import { join } from 'path'
+import { PackageJson } from 'zod-package-json'
+import tui from '../lib/tui.ts'
+
+const packageJson = PackageJson.parse(await readJson(join(projectDir(), 'package.json')))
+
+export const aboutCmd = new Command('about')
+    .description('Get information about jutge-toolkit')
+
+    .action(async () => {
+        await nothing()
+        tui.print(chalk.bold(`jutge-toolkit ${packageJson.version}`))
+        tui.print(packageJson.description!)
+        tui.print('')
+        tui.url(packageJson.homepage!)
+        tui.print('')
+        tui.print('Author:')
+        showperson(packageJson.author!)
+        tui.print('')
+        tui.print('Contributors:')
+        for (const contributor of packageJson.contributors!) {
+            showperson(contributor)
+        }
+    })
+
+function showperson(person: string | { name: string; email?: string; url?: string }) {
+    let line = '    - '
+    if (typeof person === 'string') {
+        line += person
+    } else {
+        line += person.name
+        if (person.email) {
+            line += ` <${tui.link('mailto://' + person.email, person.email)}>`
+        }
+        if (person.url) {
+            line += ` (${tui.link(person.url)})`
+        }
+    }
+    tui.print(line)
+}

package/toolkit/ai.ts

@@ -1,30 +1,56 @@
 import { Command } from '@commander-js/extra-typings'
-import { complete, listModels } from '../lib/ai.ts'
+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 ai = new Command('ai').description('Query AI models')
+export const aiCmd = new Command('ai')
+    .description('Query AI models')
 
-ai.command('complete')
+    .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')
+    .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 (eg: openai/gpt-5, google/gemini-2.5-pro, ...)',
-        'google/gemini-2.5-flash-lite',
-    )
+    .option('-m, --model <model>', 'the AI model to use', settings.defaultModel)
 
     .action(async (prompt, { model, systemPrompt }) => {
-        if (!prompt) prompt = 'Who are you?'
-        if (!systemPrompt) systemPrompt = 'You are a helpful assistant.'
-
+        prompt = prompt.trim()
+        systemPrompt = systemPrompt.trim()
         const answer = await complete(model, systemPrompt, prompt)
-        console.log(answer)
+        tui.print(answer)
     })
 
-ai.command('models')
-    .description('Show available AI models')
-    .action(async () => {
-        const models = await listModels()
-        console.dir(models, { depth: null })
+// 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/check.ts

@@ -0,0 +1,16 @@
+import { Command } from '@commander-js/extra-typings'
+import { newMaker } from '../lib/maker'
+
+export const checkCmd = new Command('check')
+    .alias('verify')
+    .description('Check candidate programs')
+
+    .argument('<programs...>', 'source programs to check')
+    .option('-d, --directory <path>', 'problem directory', '.')
+
+    .action(async (programs, { directory }) => {
+        const maker = await newMaker(directory)
+        for (const program of programs) {
+            await maker.checkCandidate(program)
+        }
+    })

package/toolkit/clean.ts

@@ -1,37 +1,27 @@
-import { cleanFiles } from '../lib/cleaner'
-import tui from '../lib/tui'
 import { Command, Option } from '@commander-js/extra-typings'
-import { resolve } from 'path'
+import { cleanDirectory } from '../lib/cleaner'
+import tui from '../lib/tui'
+import { findRealDirectories } from '../lib/helpers'
+
+// TODO: usefindRealDirectories from lib/helpers.ts
 
-export const clean = new Command('clean')
+export const cleanCmd = new Command('clean')
     .description('Clean generated files')
 
-    .argument('[directories...]', 'problem directories', ['.'])
-    .option('-i, --ignore-errors', 'ignore errors on a directory and continue processing', false)
+    .option('-d, --directories <directories...>', 'problem directories', ['.'])
+    .option('-a, --all', 'clean all generated files (including generated statement and correct files', false)
     .addOption(new Option('-f, --force', 'force removal').conflicts('dryRun'))
     .addOption(new Option('-n, --dry-run', 'show but do not remove files').conflicts('force'))
 
-    .action(async (directories, { ignoreErrors, force }) => {
-        // Default to dry-run if neither option is specified
-        const isForce = force || false
-        await tui.section('Cleaning generated files', async () => {
-            for (const directory of directories) {
-                try {
-                    await tui.section(
-                        `Cleaning directory ${tui.hyperlink(directory, resolve(directory))}`,
-                        async () => {
-                            await cleanFiles(isForce, directory)
-                        },
-                    )
-                } catch (error) {
-                    const errorMessage = error instanceof Error ? error.message : String(error)
+    .action(async ({ directories, all, force, dryRun }) => {
+        const isForce = force || false // default to dry-run if neither option is specified
 
-                    if (ignoreErrors) {
-                        tui.error(`Error: ${errorMessage}`)
-                    } else {
-                        throw error
-                    }
-                }
+        await tui.section(`Cleaning generated files`, async () => {
+            const realDirectories = await findRealDirectories(directories)
+            for (const directory of realDirectories) {
+                await tui.section(`Cleaning directory ${tui.hyperlink(directory)}`, async () => {
+                    await cleanDirectory(isForce, all, directory)
+                })
             }
         })
     })

package/toolkit/compilers.ts

@@ -1,16 +1,16 @@
 import { getAvailableCompilers, getCompilersInfo, getDefinedCompilerIds } from '../lib/compilers'
 import { Command } from '@commander-js/extra-typings'
 
-export const compilers = new Command('compilers')
+export const compilersCmd = new Command('compilers')
     .description('Query compiler information')
-    // default action is to list all compilers
+    // default action is to list all compilers because of older compatibility
 
     .action(async () => {
         const info = await getCompilersInfo()
         console.dir(info)
     })
 
-compilers
+compilersCmd
     .command('list-defined')
     .description('List all defined compiler names')
 
@@ -19,7 +19,7 @@ compilers
         console.dir(items)
     })
 
-compilers
+compilersCmd
     .command('list-available')
     .description('List all available compiler names')
 

package/toolkit/config.ts

@@ -0,0 +1,91 @@
+import { Command } from '@commander-js/extra-typings'
+import { confirm } from '@inquirer/prompts'
+import { editor } from '@inquirer/prompts'
+import YAML from 'yaml'
+import { ZodError } from 'zod'
+import { fromError } from 'zod-validation-error'
+import { configPath, loadSettings, saveSettings, settings } from '../lib/settings'
+import { Settings } from '../lib/types.ts'
+import tui from '../lib/tui.ts'
+import { convertStringToItsType } from '../lib/utils.ts'
+
+export const configCmd = new Command('config')
+    .summary('Manage configuration')
+    .description(
+        `Manage configuration
+    
+The actual configuration file is stored at ${configPath()}`,
+    )
+
+    .action(() => {
+        configCmd.help()
+    })
+
+configCmd
+    .command('show')
+    .alias('list')
+    .description('Show configuration options')
+
+    .action(async () => {
+        const settings = await loadSettings()
+        tui.yaml(settings)
+    })
+
+configCmd
+    .command('get <key>')
+    .description('Get the value of a configuration option')
+
+    .action((key: string) => {
+        if (!(key in settings)) {
+            throw new Error(`Configuration key ${key} does not exist`)
+        }
+        console.log((settings as any)[key])
+    })
+
+configCmd
+    .command('set <key> <value>')
+    .description('Set the value of a configuration option')
+
+    .action(async (key: string, value: string) => {
+        if (!(key in settings)) {
+            throw new Error(`Configuration key ${key} does not exist`)
+        }
+        const convertedValue = convertStringToItsType(value)
+        const newSettings = Settings.parse({ ...settings, [key]: convertedValue })
+        await saveSettings(newSettings)
+        tui.success(`Configuration key ${key} updated successfully`)
+    })
+
+configCmd
+    .command('edit')
+    .description('Open an editor (uses $EDITOR or $VISUAL) to modify the configuration options')
+
+    .action(async () => {
+        let data = YAML.stringify(settings, null, 4)
+        while (true) {
+            const newData = await editor({
+                message: 'Edit configuration',
+                default: data,
+                postfix: '.yml',
+                waitForUserInput: false,
+            })
+            try {
+                const newSettings = Settings.parse(YAML.parse(newData))
+                await saveSettings(newSettings)
+                tui.success('Configuration options updated successfully')
+                return
+            } catch (error) {
+                if (error instanceof ZodError) {
+                    console.error(fromError(error).toString())
+                } else {
+                    console.error(error)
+                }
+                const again = await confirm({ message: 'Edit again?', default: true })
+                if (!again) {
+                    tui.warning('No changes made to the configuration options')
+                    return
+                }
+                data = newData
+            }
+        }
+    })

package/toolkit/create.ts

@@ -1,65 +1,37 @@
-import tui from '../lib/tui'
 import { Command } from '@commander-js/extra-typings'
-import { confirm, input, select } from '@inquirer/prompts'
-import { exists, mkdir, rm } from 'fs/promises'
-import { normalize } from 'path'
-import { createProblemWithJutgeAI } from './create-jutge-ai'
-import { createProblemWithTemplate } from './create-template'
-import { createProblemWithWizard } from './create-wizard'
+import { createProblemWithJutgeAI } from '../lib/create-with-jutgeai'
+import { createProblemWithTemplate } from '../lib/create-with-template'
+import { settings } from '../lib/settings'
 
-async function selectMethod(): Promise<'template' | 'wizard' | 'jutgeAI'> {
-    return await select({
-        message: 'Method to create a new problem:',
-        choices: [
-            { name: 'Use a template', value: 'template' },
-            { name: 'Use the wizard', value: 'wizard' },
-            { name: 'Use JutgeAI', value: 'jutgeAI' },
-        ],
+export const createCmd = new Command('create')
+    .alias('new')
+    .description('Create a new problem')
+
+    .action(() => {
+        createCmd.help()
     })
-}
 
-async function selectOutputDir(): Promise<string> {
-    let dir = 'my-new-problem.pbm'
-    while (true) {
-        dir = await input({
-            message: 'Output directory for the new problem:',
-            default: dir,
-        })
-        dir = normalize(dir)
-        if (await exists(dir)) {
-            tui.error(`Directory ${dir} already exists.`)
-            const remove = await confirm({
-                message: 'Remove it?',
-                default: false,
-            })
-            if (!remove) continue
-            tui.action(`Removing directory ${dir}`)
-            await rm(dir, { recursive: true, force: true })
-            tui.success(`Removed directory ${dir}`)
-        }
-        if (!dir.endsWith('.pbm')) {
-            tui.warning("The output directory must end with the '.pbm' extension. Please try again.")
-            dir += '.pbm'
-            continue
-        }
-        await mkdir(dir, { recursive: true })
-        tui.success(`Created directory ${dir}`)
-        return dir
-    }
-}
+createCmd
+    .command('with-template')
+    .description('Create a problem with a template')
 
-export const create = new Command('create')
-    .description('Create a new problem')
+    .argument('[template]', 'template to use (empty to interactive selection)')
+    .option('-d, --directory <path>', 'output directory', 'new-problem.pbm')
+
+    .action(async (template, { directory }) => {
+        await createProblemWithTemplate(directory, template)
+    })
+
+createCmd
+    .command('with-ai')
+    .description('Create a problem with JutgeAI')
+
+    .option('-d, --directory <path>', 'output directory', 'new-problem.pbm')
+    .option('-i, --input <path>', 'input specification file')
+    .option('-o, --output <path>', 'output specification file')
+    .option('-n, --do-not-ask', 'do not ask interactively if --input given', false)
+    .option('-m, --model <model>', 'AI model to use', settings.defaultModel)
 
-    .action(async () => {
-        tui.title('Create new problem')
-        const outputDir = await selectOutputDir()
-        const method = await selectMethod()
-        if (method === 'template') {
-            await createProblemWithTemplate(outputDir)
-        } else if (method === 'wizard') {
-            await createProblemWithWizard(outputDir)
-        } else if (method === 'jutgeAI') {
-            await createProblemWithJutgeAI(outputDir)
-        }
+    .action(async ({ input, output, directory, model, doNotAsk }) => {
+        await createProblemWithJutgeAI(model, directory, input, output, doNotAsk)
     })

package/toolkit/doctor.ts

@@ -2,17 +2,21 @@ import * as doc from '../lib/doctor'
 import { Command } from '@commander-js/extra-typings'
 import tui from '../lib/tui'
 
-export const doctor = new Command('doctor')
-    .description('Diagnose and fix common issues with the project setup')
+export const doctorCmd = new Command('doctor')
+    .description('Diagnose status of the environment')
 
     .action(async () => {
-        tui.title('Doctor')
-
-        await tui.section('Checking Python3 installation', doc.checkPython3)
-        await tui.section('Checking C/C++ installation', doc.checkGCC)
-        await tui.section('Checking XeLaTeX installation', doc.checkXeLaTeX)
-        await tui.section('Checking Pandoc installation', doc.checkPandoc)
-        await tui.section('Checking ImageMagick installation', doc.checkImageMagick)
-        await tui.section('Checking AI models', doc.checkEnvVars)
-        await tui.section('Checking terminal', doc.checkTerminal)
+        await tui.section('Perform checks', async () => {
+            await tui.section('Checking Python3 installation', doc.checkPython3)
+            await tui.section('Checking C/C++ installation', doc.checkGCC)
+            await tui.section('Checking Haskell installation', doc.checkHaskell)
+            await tui.section('Checking Clojure installation', doc.checkClojure)
+            await tui.section('Checking Java installation', doc.checkJava)
+            await tui.section('Checking Rust installation', doc.checkRust)
+            await tui.section('Checking XeLaTeX installation', doc.checkXeLaTeX)
+            await tui.section('Checking Pandoc installation', doc.checkPandoc)
+            await tui.section('Checking ImageMagick installation', doc.checkImageMagick)
+            await tui.section('Checking AI models', doc.checkAIEnvVars)
+            await tui.section('Checking terminal', doc.checkTerminal)
+        })
     })