testownik-converter 1.0.0 → 1.0.3

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../dist/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testownik-converter",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "A command-line utility to convert quizzes into Solvro's Testownik format.",
   "type": "module",
   "author": "Konrad Guzek",
@@ -14,9 +14,14 @@
     "url": "git+https://github.com/kguzek/testownik-converter.git"
   },
   "bin": {
-    "testownik-converter": "node dist/index.js"
+    "testownik-converter": "bin/index.js"
+  },
+  "scripts": {
+    "build": "tsup"
   },
   "dependencies": {
+    "boxen": "^8.0.1",
+    "chalk": "^5.6.2",
     "commander": "^14.0.3"
   },
   "devDependencies": {
@@ -24,7 +29,5 @@
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   },
-  "scripts": {
-    "build": "tsup"
-  }
-}
+  "packageManager": "pnpm@10.28.2"
+}

package/src/adapters/base-adapter.ts

@@ -1,6 +1,8 @@
-import type { AdapterOptions, TestownikQuestion, TestownikQuiz } from "@/types";
 import { readFileSync, writeFileSync } from "node:fs";
 
+import type { AdapterOptions, TestownikQuestion, TestownikQuiz } from "@/types";
+import { logger } from "@/logging";
+
 export abstract class BaseAdapter {
   protected inputContent!: string;
   protected options!: AdapterOptions;
@@ -16,6 +18,12 @@ export abstract class BaseAdapter {
 
   private createQuiz(): TestownikQuiz {
     const questions = this.convertQuestions();
+    if (questions.length === 0) {
+      throw new Error("Could not find any questions in the input file.");
+    }
+    logger.info(
+      `Successfully imported ${questions.length} question${questions.length === 1 ? "" : "s"}!`,
+    );
     const quiz: TestownikQuiz = {
       title: this.options.quizTitle,
       ...(this.options.quizDescription == null
@@ -29,6 +37,8 @@ export abstract class BaseAdapter {
   writeOutput(): void {
     const quiz = this.createQuiz();
     const data = JSON.stringify(quiz, null, 2);
-    writeFileSync(this.options.outputFilename, data, "utf8");
+    const filename = this.options.outputFilename;
+    writeFileSync(filename, data, "utf8");
+    logger.info(`Converted quiz written to ${filename}.`);
   }
 }

package/src/adapters/ccna-adapter.ts

@@ -1,37 +1,50 @@
-import { BaseAdapter } from "./base-adapter";
 import type { TestownikQuestion, TestownikAnswer } from "@/types";
 
-const QUESTION_REGEX = new RegExp(
-  String.raw`^(?:(?<number>\d+)\.\s+)?(?<question>.+)$\n(?<answers>(?:(?=^-\s).+$\n?)+\n?)`,
-  "gm",
-);
+import { BaseAdapter } from "./base-adapter";
+import { logger } from "@/logging";
+
+const QUESTION_REGEX =
+  /^(?<number>\d+)\.\s+(?<question>[\s\S]+?)\n^-\s+(?<answers>.+(?:\r?\n.+)+)/gm;
 
-const ANSWER_REGEX = new RegExp(
-  String.raw`^- (?<correct>\[✓\] )?(?<question>.+)$`,
-  "gm",
-);
+const ANSWER_REGEX = /^(?<correct>\[✓\]\s+)?(?<answer>[\s\S]+)/m;
 
 export class CcnaAdapter extends BaseAdapter {
   convertQuestions() {
-    QUESTION_REGEX.lastIndex = 0;
     const questions: TestownikQuestion[] = [];
-    let questionMatch: RegExpExecArray | null;
-    while (
-      (questionMatch = QUESTION_REGEX.exec(this.inputContent)) != null &&
-      questionMatch.groups != null
-    ) {
-      const answers: TestownikAnswer[] = [];
-      ANSWER_REGEX.lastIndex = 0;
+    for (const questionMatch of this.inputContent.matchAll(QUESTION_REGEX)) {
+      if (questionMatch.groups == null) {
+        continue;
+      }
+      const questionText = questionMatch.groups.question?.trim();
+      if (!questionText) {
+        logger.warn("Skipping question with no text");
+        continue;
+      }
+
+      const answersText = questionMatch.groups.answers?.trim();
+      if (!answersText) {
+        logger.warn(`Skipping question with no answers: '${questionText}'`);
+        continue;
+      }
 
-      const rawAnswers = questionMatch.groups.answers;
-      let answerMatch: RegExpExecArray | null;
-      while (
-        (answerMatch = ANSWER_REGEX.exec(rawAnswers)) != null &&
-        answerMatch.groups != null
-      ) {
+      const answers: TestownikAnswer[] = [];
+      for (const fullAnswerText of answersText.split(/\r?\n-\s+/)) {
+        const answerMatch = fullAnswerText.match(ANSWER_REGEX);
+        if (answerMatch?.groups == null) {
+          logger.warn(`Skiping invalid answer: ${fullAnswerText}`);
+          continue;
+        }
+        const isCorrect = answerMatch?.groups?.correct != null;
+        const answerText = answerMatch.groups?.answer?.trim();
+        if (!answerText) {
+          logger.warn(
+            `Skipping answer with no text in question: ${questionText}`,
+          );
+          continue;
+        }
         const answer: TestownikAnswer = {
-          text: answerMatch.groups.question,
-          is_correct: answerMatch.groups.correct != null,
+          text: answerText,
+          is_correct: isCorrect,
         };
         answers.push(answer);
       }
@@ -39,7 +52,7 @@ export class CcnaAdapter extends BaseAdapter {
         continue;
       }
       const question: TestownikQuestion = {
-        text: questionMatch.groups.question,
+        text: questionText,
         answers,
         multiple: answers.filter((answer) => answer.is_correct).length > 1,
       };

package/src/cli/index.ts

@@ -1,6 +1,8 @@
 import { Command } from "commander";
+
 import { CcnaAdapter } from "@/adapters/ccna-adapter";
-import { REPO_NAME, REPO_URL } from "@/constants";
+import { REPO_NAME, REPO_URL, VERSION } from "@/constants";
+import { cardIntro, cardOutro, cardError, logger } from "@/logging";
 
 const program = new Command();
 program
@@ -15,28 +17,38 @@ program
     `Generated by ${REPO_NAME}: ${REPO_URL}`,
   )
   .option("-o, --output <filename>", "output JSON filename", "testownik.json")
-  .version("1.0.0");
+  .version(VERSION);
 
 program
   .command("ccna")
   .argument("<filename>", "input text filename")
   .description("Parses questions from Cisco's CCNA exam format.")
   .action((inputFilename: string) => {
-    const options = program.opts();
+    logger.print(cardIntro);
+    try {
+      const options = program.opts();
+
+      const outputFilename: string = options.output;
+      const quizTitle: string = options.title;
+      const quizDescription: string | undefined = options.description;
 
-    const outputFilename: string = options.output;
-    const quizTitle: string = options.title;
-    const quizDescription: string | undefined = options.description;
+      const adapter = new CcnaAdapter({
+        inputFilename,
+        outputFilename,
+        quizTitle,
+        quizDescription,
+      });
 
-    const adapter = new CcnaAdapter({
-      inputFilename,
-      outputFilename,
-      quizTitle,
-      quizDescription,
-    });
+      adapter.writeOutput();
 
-    adapter.writeOutput();
-    console.log(`Quiz written to ${options.output}!`);
+      logger.print(cardOutro);
+    } catch (error) {
+      logger.error(
+        error instanceof Error ? error.message : `Unknown error: ${error}`,
+      );
+      logger.print(cardError);
+      process.exitCode = 1;
+    }
   });
 
 program.parse(process.argv);

package/src/constants/index.ts

@@ -1,5 +1,9 @@
-export const REPO_NAME = "testownik-converter";
-
+export const AUTHOR_EMAIL = "konrad@guzek.uk";
+export const AUTHOR_NAME = "Konrad Guzek";
 export const AUTHOR_URL = "https://github.com/kguzek";
 
-export const REPO_URL = `${AUTHOR_URL}/${REPO_NAME}`;
+export const REPO_NAME = "Testownik Converter";
+export const REPO_SLUG = "testownik-converter";
+export const REPO_URL = `${AUTHOR_URL}/${REPO_SLUG}`;
+
+export const VERSION = process.env.npm_package_version || "1.0.1";

package/src/logging/cards.ts

@@ -0,0 +1,62 @@
+import boxen from "boxen";
+import chalk from "chalk";
+
+import {
+  AUTHOR_EMAIL,
+  AUTHOR_NAME,
+  AUTHOR_URL,
+  REPO_NAME,
+  REPO_URL,
+  VERSION,
+} from "@/constants";
+
+export const cardIntro = boxen(
+  chalk.white(`
+Welcome to ${REPO_NAME} version ${VERSION}!
+
+Author: ${AUTHOR_NAME}
+GitHub: ${chalk.underline(AUTHOR_URL)}
+Email: ${AUTHOR_EMAIL}
+`),
+  {
+    padding: 1,
+    margin: 1,
+    borderStyle: "round",
+    borderColor: "cyan",
+    textAlignment: "center",
+  },
+);
+
+export const cardOutro = boxen(
+  chalk.white(`
+Thank you for using ${REPO_NAME}.
+
+⭐ Star me on GitHub! ⭐
+  
+${chalk.underline(REPO_URL)}
+`),
+  {
+    padding: 1,
+    margin: 1,
+    borderStyle: "round",
+    borderColor: "yellow",
+    textAlignment: "center",
+  },
+);
+
+const generateErrorCard = (text: string) =>
+  boxen(chalk.white(text), {
+    padding: 1,
+    margin: 1,
+    borderStyle: "round",
+    borderColor: "red",
+    textAlignment: "center",
+  });
+
+export const cardError = generateErrorCard(`
+
+An unexpected error occurred during the program's execution.
+If the problem persists, please report it on GitHub:
+
+${chalk.underline(REPO_URL + "/issues/new")}
+`);

package/src/logging/index.ts

@@ -0,0 +1,3 @@
+export * from "./logger";
+
+export * from "./cards";

package/src/logging/logger.ts

@@ -0,0 +1,16 @@
+import { REPO_NAME } from "@/constants";
+
+import chalk from "chalk";
+
+const formatMessage = (emoji: string, message: string) =>
+  `\n${emoji} ${chalk.dim("[")}${chalk.bgCyan.black(REPO_NAME)}${chalk.reset.dim("]")} ${message}`;
+
+export const logger = {
+  print: console.log,
+  info: (message: string) =>
+    console.info(formatMessage("🤖", chalk.cyan(message))),
+  warn: (message: string) =>
+    console.warn(formatMessage("⚠️", chalk.yellow(message))),
+  error: (message: string) =>
+    console.error(formatMessage("❌", chalk.red(message))),
+};

package/src/types/adapters.ts

@@ -2,5 +2,5 @@ export interface AdapterOptions {
   inputFilename: string;
   outputFilename: string;
   quizTitle: string;
-  quizDescription?: string;
+  quizDescription: string | undefined;
 }

package/src/types/index.ts

@@ -1,3 +1,3 @@
-export type { AdapterOptions } from "./adapters";
+export type * from "./adapters";
 
-export type { TestownikQuiz, TestownikQuestion } from "./testownik";
+export type * from "./testownik";

package/src/types/testownik.ts

@@ -4,7 +4,7 @@ interface QuizPart {
   image_url?: string;
 }
 
-interface TestownikAnswer extends QuizPart {
+export interface TestownikAnswer extends QuizPart {
   is_correct: boolean;
 }