@jutge.org/toolkit 4.0.5 → 4.2.0

package/toolkit/make.ts

@@ -0,0 +1,92 @@
+import { Command } from '@commander-js/extra-typings'
+import { join, resolve } from 'path'
+import { findRealDirectories } from '../lib/helpers'
+import { newMaker } from '../lib/maker'
+import tui from '../lib/tui'
+import { nothing, projectDir } from '../lib/utils'
+
+export const makeCmd = new Command('make')
+    .description('Make problem elements')
+
+    .argument('[tasks...]', 'tasks to make: all|info|exe|cor|pdf|txt|md|html', ['all'])
+    .option('-d, --directories <directories...>', 'problem directories', ['.'])
+    .option('-i, --ignore-errors', 'ignore errors on a directory and continue processing', false)
+    .option('-e, --only-errors', 'only show errors at the final summary', false)
+
+    .action(async (tasks, { directories, ignoreErrors, onlyErrors }) => {
+        if (tasks.length === 0) {
+            tasks = ['all']
+        }
+        if (tasks.includes('all') && tasks.length > 1) {
+            throw new Error("When 'all' is specified, no other tasks should be provided")
+        }
+        if (!tasks.every((t) => ['all', 'info', 'exe', 'cor', 'pdf', 'txt', 'md', 'html'].includes(t))) {
+            throw new Error('Tasks must be one of: all, info, exe, cor, pdf, txt, md, html')
+        }
+
+        console.log()
+        await tui.image(join(projectDir(), 'assets', 'images', 'jutge-toolkit.png'), 8, 4)
+
+        const errors: Record<string, string> = {} // directory -> error message
+
+        const realDirectories = await findRealDirectories(directories)
+
+        for (const directory of realDirectories) {
+            try {
+                tui.title(`Making problem in directory ${tui.hyperlink(directory, resolve(directory))}`)
+
+                const maker = await newMaker(directory)
+
+                // If tasks include 'all', run makeProblem
+                if (tasks.includes('all')) {
+                    await maker.makeProblem()
+                } else {
+                    // Run specific tasks
+                    if (tasks.includes('info')) {
+                        // already done in maker initialization
+                    }
+                    if (tasks.includes('exe')) {
+                        await maker.makeExecutables()
+                    }
+                    if (tasks.includes('cor')) {
+                        await maker.makeCorrects()
+                    }
+                    if (tasks.includes('pdf')) {
+                        await maker.makePdfStatements()
+                    }
+                    if (tasks.includes('txt') || tasks.includes('html') || tasks.includes('md')) {
+                        await maker.makeTextualStatements(
+                            tasks.filter((t) => ['txt', 'html', 'md'].includes(t)) as Array<'txt' | 'html' | 'md'>,
+                        )
+                    }
+                }
+            } catch (error) {
+                const errorMessage = error instanceof Error ? error.message : String(error)
+
+                if (ignoreErrors) {
+                    errors[directory] = errorMessage
+                    tui.error(`Error: ${errorMessage}`)
+                } else {
+                    throw error
+                }
+            }
+            console.log()
+        }
+
+        tui.title('Summary')
+        await tui.section('', async () => {
+            await nothing()
+            if (realDirectories.length === 0) {
+                tui.warning('No problem directories found')
+            }
+            for (const directory of realDirectories) {
+                if (errors[directory]) {
+                    tui.directory(directory)
+                    tui.error(`  ${errors[directory]}`)
+                } else if (!onlyErrors) {
+                    tui.directory(directory)
+                    tui.success(`  No errors found`)
+                }
+            }
+        })
+    })

package/toolkit/quiz.ts

@@ -0,0 +1,44 @@
+import { Command } from '@commander-js/extra-typings'
+import { makeQuiz, validateQuiz } from '../lib/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')
+
+    .action(() => {
+        quizCmd.help()
+    })
+
+quizCmd
+    .command('validate')
+    .description('Validate a quiz problem')
+
+    .option('-d, --directories <directories...>', 'problem directories', ['.'])
+
+    .action(async ({ directories }) => {
+        const realDirectories = await findRealDirectories(directories)
+        for (const directory of realDirectories) {
+            await tui.section(`Validating quiz in directory ${tui.hyperlink(directory)}`, async () => {
+                await validateQuiz(directory)
+            })
+        }
+    })
+
+quizCmd
+    .command('make')
+    .description('Make a quiz problem')
+
+    .option('-d, --directory <directory>', 'problem directory', '.')
+    .option('-s, --seed <seed>', 'random seed')
+
+    .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])
+        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
+        }
+    })

package/toolkit/upgrade.ts

@@ -0,0 +1,9 @@
+import { Command } from '@commander-js/extra-typings'
+import { upgrade } from '../lib/versions'
+
+export const upgradeCmd = new Command('upgrade')
+    .description('Upgrade to the latest version')
+
+    .action(async () => {
+        await upgrade()
+    })

package/toolkit/upload.ts

@@ -0,0 +1,20 @@
+import { Command } from '@commander-js/extra-typings'
+import { uploadProblem } from '../lib/upload'
+import { newProblem } from '../lib/problem'
+
+export const uploadCmd = new Command('upload')
+    .summary('Upload problem to Jutge.org')
+    .description(
+        `Upload problem to Jutge.org
+
+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.
+`,
+    )
+
+    .option('-d, --directory <directory>', 'problem directory', '.')
+
+    .action(async ({ directory }) => {
+        const problem = await newProblem(directory)
+        await uploadProblem(problem)
+    })

package/toolkit/verify.ts

@@ -0,0 +1,15 @@
+import { Command } from '@commander-js/extra-typings'
+import { newMaker } from '../lib/maker'
+
+export const verifyCmd = new Command('verify')
+    .description('Verify programs against golden solution')
+
+    .argument('<programs...>', 'source programs to verify')
+    .option('-d, --directory <path>', 'problem directory', '.')
+
+    .action(async (programs, { directory }) => {
+        const maker = await newMaker(directory)
+        for (const program of programs) {
+            await maker.verifyCandidate(program)
+        }
+    })