skewer-format 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# Skewer
+
+This repo is a idea to build a quiz tool fro exams based on text files alone. All questions and answers are stored in text files, and the tool will read these files to generate quizzes.
+
+# Format
+
+The format is based on AikenFormat, which is a simple format for multiple-choice questions. But I'm taking that as inspiration and creating my own format that is more flexible and can support different types of questions. Naming it as SkewerFormat.
+The reason for using text instead of JSON and other format is that text is more human-readable and easier to edit. The prime motive is to create all set of questions related to a exam or topic in a single vault of obsidian and just zip and pass.
+
+## Supported Question Types
+
+- Multiple Choice
+- True/False
+- Multiple Select
+- Type in the Answer
+- Question Set (a set of questions that are related to each other)

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { lexer } from "./src/lexer";
+export { parser } from "./src/parser";

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parser = exports.lexer = void 0;
+var lexer_1 = require("./src/lexer");
+Object.defineProperty(exports, "lexer", { enumerable: true, get: function () { return lexer_1.lexer; } });
+var parser_1 = require("./src/parser");
+Object.defineProperty(exports, "parser", { enumerable: true, get: function () { return parser_1.parser; } });

package/dist/src/lexer.d.ts

@@ -0,0 +1,23 @@
+export type Token = {
+    type: "KEY";
+    value: string;
+} | {
+    type: "COLON";
+    value: ":";
+} | {
+    type: "VALUE";
+    value: string;
+} | {
+    type: "OPTION_KEY";
+    value: string;
+} | {
+    type: "DOT";
+    value: ".";
+} | {
+    type: "OPTION_VALUE";
+    value: string;
+} | {
+    type: "SENTINEL";
+    value: string;
+};
+export declare function lexer(input: string): Token[];

package/dist/src/lexer.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lexer = lexer;
+function lexer(input) {
+    const tokens = [];
+    const lines = input
+        .split("\n")
+        .map(line => line.trim())
+        .filter(Boolean);
+    for (const line of lines) {
+        const optionMatch = line.match(/^([A-Z])\.\s*(.+)$/);
+        if (optionMatch) {
+            tokens.push({
+                type: "OPTION_KEY",
+                value: optionMatch[1]
+            });
+            tokens.push({
+                type: "DOT",
+                value: "."
+            });
+            tokens.push({
+                type: "OPTION_VALUE",
+                value: optionMatch[2]
+            });
+            continue;
+        }
+        const keyValueMatch = line.match(/^([A-Z_]+):\s*(.+)$/);
+        if (keyValueMatch) {
+            tokens.push({
+                type: "KEY",
+                value: keyValueMatch[1]
+            });
+            tokens.push({
+                type: "COLON",
+                value: ":"
+            });
+            tokens.push({
+                type: "VALUE",
+                value: keyValueMatch[2]
+            });
+        }
+        const sentinalMatch = line.match(/^---$/m);
+        if (sentinalMatch) {
+            tokens.push({
+                type: "SENTINEL",
+                value: "---"
+            });
+            continue;
+        }
+    }
+    return tokens;
+}
+const input = `
+
+---
+QUESTION: Which of the following best describes the primary purpose of a preloader in web design?
+A. To enhance the visual aesthetics of the website
+B. To ensure faster actual loading times of the website
+C. To create the perception of faster loading times through engaging animations or progress indicators
+D. To provide additional information about the website's content
+ANSWER: C
+EXPLANATION: Preloaders are used to create the perception of faster loading times, engaging users with animations or progress indicators while the website content loads in the background.
+
+---
+QUESTION: In the context of web design, what does SVG stand for and what is its primary use?
+A. Scalable Vector Graphics, used for defining three-dimensional graphics
+B. Simple Vector Graphics, used for creating basic two-dimensional images
+C. Scalable Vector Graphics, used for defining two-dimensional graphics with interactivity and animation support
+D. Standard Vector Graphics, used for standardizing image formats across different platforms
+ANSWER: C
+EXPLANATION: SVG stands for Scalable Vector Graphics, an XML-based vector image format for two-dimensional graphics with support for interactivity and animation.
+
+---
+`;

package/dist/src/parser.d.ts

@@ -0,0 +1,20 @@
+import type { Token } from "./lexer.js";
+interface Question {
+    id?: string;
+    type?: string;
+    question?: string;
+    options?: {
+        key: string;
+        value: string;
+    }[];
+    answer?: string | Array<string>;
+    explanation?: string;
+}
+interface QuestionSet {
+    id: string;
+    type: string;
+    para: string;
+    questions: Array<Question>;
+}
+export declare function parser(tokens: Token[]): Array<Question | QuestionSet>;
+export {};

package/dist/src/parser.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parser = parser;
+const lexer_js_1 = require("./lexer.js");
+function parser(tokens) {
+    var _a;
+    const resultArr = [];
+    let question = {
+        options: []
+    };
+    let sentinel = "close";
+    let currentType;
+    let i = 0;
+    function resetQuestion() {
+        question = {
+            options: []
+        };
+    }
+    while (i < tokens.length) {
+        const token = tokens[i];
+        if (token.type === "SENTINEL") {
+            sentinel = "close";
+            resultArr.push(question);
+            resetQuestion();
+            i++;
+            continue;
+        }
+        if (token.type === "KEY") {
+            const key = token.value;
+            const valueToken = tokens[i + 2]; //i+1 colon
+            if (valueToken && valueToken.type == "VALUE") {
+                switch (key) {
+                    case "TYPE":
+                        question.type = valueToken.value;
+                        currentType = valueToken.value;
+                        break;
+                    case "QUESTION":
+                        if (sentinel === "open") {
+                            sentinel = "close";
+                            resultArr.push(question);
+                            resetQuestion();
+                            // Need to to thing if things are absent
+                        }
+                        question.question = valueToken.value;
+                        question.id = crypto.randomUUID();
+                        sentinel = "open";
+                        break;
+                    case "ANSWER":
+                        if (valueToken.value.length > 1) {
+                            question.answer = valueToken.value.split(",");
+                        }
+                        else {
+                            question.answer = valueToken.value;
+                        }
+                        if (question.answer.length == 1 && question.type == undefined) {
+                            question.type = "MCQ";
+                        }
+                        break;
+                    case "EXPLANATION":
+                        question.explanation = valueToken.value;
+                        break;
+                }
+                i += 3;
+                continue;
+            }
+        }
+        if (token.type == "OPTION_KEY") {
+            const optionValueToken = tokens[i + 2];
+            if (optionValueToken &&
+                optionValueToken.type === "OPTION_VALUE") {
+                (_a = question.options) === null || _a === void 0 ? void 0 : _a.push({
+                    key: token.value,
+                    value: optionValueToken.value
+                });
+                i += 3;
+                continue;
+            }
+        }
+    }
+    console.log(resultArr.length);
+    return resultArr;
+}
+let input = `
+TYPE: MCQ
+QUESTION: In web design, what is the recommended approach for typography to ensure readability and clarity?
+A. Using a variety of fonts to make the text stand out
+B. Opting for serif fonts for their historical significance and readability
+C. Choosing sans-serif fonts for modern aesthetics
+D. Using the largest font size possible for all text
+ANSWER: B
+EXPLANATION: Serif fonts are often chosen for their historical significance and readability.
+`;
+input = `
+Here are five hard-level MCQ questions based on the provided prompt:
+
+QUESTION: Which of the following best describes the primary purpose of a preloader in web design?
+A. To enhance the visual aesthetics of the website
+B. To ensure faster actual loading times of the website
+C. To create the perception of faster loading times through engaging animations or progress indicators
+D. To provide additional information about the website's content
+ANSWER: C
+EXPLANATION: Preloaders are used to create the perception of faster loading times, engaging users with animations or progress indicators while the website content loads in the background.
+
+QUESTION: In the context of web design, what does SVG stand for and what is its primary use?
+A. Scalable Vector Graphics, used for defining three-dimensional graphics
+B. Simple Vector Graphics, used for creating basic two-dimensional images
+C. Scalable Vector Graphics, used for defining two-dimensional graphics with interactivity and animation support
+D. Standard Vector Graphics, used for standardizing image formats across different platforms
+ANSWER: C
+EXPLANATION: SVG stands for Scalable Vector Graphics, an XML-based vector image format for two-dimensional graphics with support for interactivity and animation.
+
+QUESTION: When designing a website, which structural element is crucial for indicating the primary actions users should take?
+A. Hero section
+B. Feature section
+C. Call to Action (CTA)
+D. Testimonial section
+ANSWER: C
+EXPLANATION: The Call to Action (CTA) section is designed to prompt users to take specific actions, such as signing up, purchasing, or contacting, making it a crucial element in website design.
+
+---
+QUESTION: Which type of user flow is specifically designed to illustrate the sequence of steps a user takes to complete a specific task on a website?
+A. Wire flow
+B. Task flow
+C. Content flow
+D. Navigation flow
+ANSWER: B
+EXPLANATION: Task flow is a type of user flow that illustrates the sequence of steps a user takes to complete a specific task on a website, helping designers understand user interactions and improve the user experience.
+
+---
+QUESTION: In web design, what is the recommended approach for typography to ensure readability and clarity?
+A. Using a variety of fonts to make the text stand out
+B. Opting for serif fonts for their historical significance and readability
+C. Choosing sans-serif fonts for modern aesthetics
+D. Using the largest font size possible for all text
+ANSWER: B
+EXPLANATION: Serif fonts are often chosen for their historical significance and readability, making them a popular choice for body text in web design to ensure clarity and ease of reading.
+
+---`;
+let lex_out = (0, lexer_js_1.lexer)(input);
+// console.log(lex_out);
+console.log(parser(lex_out));

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "skewer-format",
+    "version": "1.0.0",
+    "description": "New format to store quiz in text format",
+    "license": "MIT",
+    "author": "sassykumar <sasikumarstu@gamil.com>",
+    "files": [
+        "dist"
+    ],
+    "type": "commonjs",
+    "main": "dist/index.js",
+    "scripts": {
+        "dev": "vite",
+        "build": "tsc -b && vite build",
+        "lint": "eslint .",
+        "preview": "vite preview",
+        "prepare": "husky"
+    },
+    "dependencies": {
+        "prettier": "^3.8.3",
+        "react": "^19.2.4",
+        "react-dom": "^19.2.4"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.29.0",
+        "@eslint/js": "^9.39.4",
+        "@rolldown/plugin-babel": "^0.2.0",
+        "@types/babel__core": "^7.20.5",
+        "@types/node": "^24.12.0",
+        "@types/react": "^19.2.14",
+        "@types/react-dom": "^19.2.3",
+        "@vitejs/plugin-react": "^6.0.0",
+        "babel-plugin-react-compiler": "^1.0.0",
+        "eslint": "^9.39.4",
+        "eslint-plugin-react-hooks": "^7.0.1",
+        "eslint-plugin-react-refresh": "^0.5.2",
+        "globals": "^17.4.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^17.0.4",
+        "typescript": "~5.9.3",
+        "typescript-eslint": "^8.56.1",
+        "vite": "^8.0.0"
+    },
+    "lint-staged": {
+        "*.{js,ts,tsx,json,css,md}": [
+            "prettier --write"
+        ],
+        "*.{js,ts,tsx}": [
+            "eslint --fix --max-warnings=10"
+        ]
+    }
+}