@jutge.org/toolkit 4.2.6 → 4.2.8

package/docs/problem-anatomy.md

@@ -30,6 +30,8 @@ There are four types of problems in Jutge.org:
 
 - **Graphic problems**: Similar to standard problems but involve graphical output to file `output.png` rather than standard output, typically (but not necessarily) solved using Python's graphical libraries.
 
+-- **Circuit problems**: A subtype of problems where users must implement digital circuits using the Verilog programming language. These problems use formal verification techniques and do not need test cases for evaluation. These are not covered in this document.
+
 - **Games**: Problems where users must implement an AI to play a game against other users or predefined strategies. These problems often involve turn-based gameplay and require users to implement specific functions to decide their moves. These are not covered in this document.
 
 - **Quizzes**: Problems where users must answer multiple-choice questions. These are not covered in this document.
@@ -236,6 +238,8 @@ There are also optional arguments that may be used:
 
 - `func_name`: Name of the function requested in case the problem only asks for a function (this must be used along with `source_modifier: no_main`).
 
+- `hide_html`: If set to `1`, the statement will not be shown in HTML in the Jutge.org website; use it sparingly.
+
 - `invisible_main`: If set to `1`, the `main.cc` file will not be provided to users. This is used by problems that do not require writing a `main` function.
 
 - `presentation_error`: If set to `1` (by default), the PE (Presentation Error) verdict will be enabled. Otherwise, the verdict will be WA (Wrong Answer) if the files are not identical.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@jutge.org/toolkit",
     "description": "Toolkit to prepare problems for Jutge.org",
-    "version": "4.2.6",
+    "version": "4.2.8",
     "homepage": "https://jutge.org",
     "author": {
         "name": "Jutge.org",
@@ -21,6 +21,11 @@
         "type": "git",
         "url": "git+https://github.com/jutge-org/new-jutge-toolkit.git"
     },
+    "keywords": [
+        "jutge.org",
+        "cli",
+        "command line interface"
+    ],
     "publishConfig": {
         "access": "public"
     },
@@ -29,17 +34,18 @@
     "bin": {
         "jutge-toolkit": "dist/index.js",
         "jtk": "dist/index.js",
-        "dev": "toolkit/index.ts"
+        "jtk-dev": "toolkit/index.ts"
     },
     "scripts": {
         "lint": "eslint .",
         "format": "bun prettier --write .",
         "depcheck": "bunx depcheck",
         "dev": "bun build --target bun --outfile dist/index.js ./toolkit --watch",
-        "build": "bun build --target bun --minify --outfile dist/index.js ./toolkit ",
+        "build": "bun build --target bun --minify --outfile dist/index.js ./toolkit",
         "update-jutge-client": "(cd lib ; rm -f jutge_api_client.ts ; https --download https://api.jutge.org/clients/download/typescript)"
     },
     "files": [
+        "README.md",
         "dist",
         "toolkit",
         "docs",
@@ -67,7 +73,6 @@
         "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",
@@ -82,6 +87,7 @@
         "zod-validation-error": "^5.0.0"
     },
     "devDependencies": {
+        "prettier": "^3.7.4",
         "typescript-eslint": "^8.51.0",
         "@types/archiver": "^7.0.0",
         "@types/image-size": "^0.8.0",

package/toolkit/ask.ts

@@ -32,7 +32,7 @@ export async function loadDocumentation(): Promise<string> {
     const documentsDir = join(projectDir(), 'docs')
     const toolkitDir = join(projectDir(), 'toolkit')
 
-    const documentPaths = await Array.fromAsync(glob('*.md', { cwd: documentsDir }))
+    const documentPaths = await Array.fromAsync(glob('*.{md,tex}', { cwd: documentsDir }))
     const sourcePaths = await Array.fromAsync(glob('*.ts', { cwd: toolkitDir }))
 
     const documents = await all(documentPaths.map((file) => readTextInDir(documentsDir, file)))

package/toolkit/convert.ts

@@ -0,0 +1,72 @@
+import { Command } from '@commander-js/extra-typings'
+import { findRealDirectories } from '../lib/helpers'
+import { newProblem } from '../lib/problem'
+import tui from '../lib/tui'
+import { readTextInDir, writeTextInDir } from '../lib/utils'
+
+export const convertCmd = new Command('convert')
+    .description('Convert deprecated elements in problem statements to the new format')
+
+    .action(() => {
+        convertCmd.help()
+    })
+
+convertCmd
+    .command('transform-at-signs')
+    .description('Transform @ signs to lstinline')
+
+    .option('-d, --directories <directories...>', 'problem directories', ['.'])
+
+    .action(async ({ directories }) => {
+        const realDirectories = await findRealDirectories(directories)
+
+        for (const realDirectory of realDirectories) {
+            await tui.section(`Processing ${realDirectory}`, async () => {
+                const problem = await newProblem(realDirectory)
+                for (const language of problem.languages) {
+                    await tui.section(`Converting problem.${language}.tex`, async () => {
+                        const originalText = await readTextInDir(realDirectory, `problem.${language}.tex`)
+                        const convertedText = replaceAtSigns(originalText)
+                        if (originalText !== convertedText) {
+                            await writeTextInDir(realDirectory, `problem.${language}.tex`, convertedText)
+                            await writeTextInDir(realDirectory, `problem.${language}.tex.original.bak`, originalText)
+                            tui.success(
+                                `Converted problem.${language}.tex, original backed up to problem.${language}.tex.original.bak`,
+                            )
+                        } else {
+                            tui.warning(`No changes needed for problem.${language}.tex`)
+                        }
+                    })
+                }
+            })
+        }
+    })
+
+/**
+ * Replaces all occurrences of @text@ with \lstinline|text|
+ *
+ * @param input - The input string to process
+ * @returns A new string with all @text@ patterns replaced with \lstinline|text|
+ *
+ * @remarks
+ * This function is designed to convert inline code markers from the @ syntax
+ * to LaTeX \lstinline syntax. It processes the input string and replaces all
+ * valid patterns while preserving invalid ones.
+ *
+ * Pattern matching rules:
+ * - Matches text enclosed between two @ symbols: @text@
+ * - The enclosed text must not contain @ symbols
+ * - The enclosed text must not contain newline characters (\n or \r)
+ * - The enclosed text must contain at least one character
+ * - All valid matches in the input are replaced (global replacement)
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * replaceAtSigns("Use @console.log()@ for debugging")
+ * // Returns: "Use \lstinline|console.log()| for debugging"
+ * ```
+ */
+function replaceAtSigns(input: string): string {
+    return input.replace(/@([^@\n\r]+)@/g, '\\lstinline|$1|')
+}

package/toolkit/index.ts

@@ -19,6 +19,7 @@ import { quizCmd } from './quiz'
 import { upgradeCmd } from './upgrade'
 import { uploadCmd } from './upload'
 import { askCmd } from './ask'
+import { convertCmd } from './convert'
 
 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)
@@ -34,6 +35,7 @@ program.addCommand(makeCmd)
 program.addCommand(uploadCmd)
 program.addCommand(cleanCmd)
 program.addCommand(verifyCmd)
+program.addCommand(convertCmd)
 program.addCommand(doctorCmd)
 if (settings.developer) {
     program.addCommand(quizCmd)