@learnpack/learnpack 4.0.10 → 4.0.12

package/lib/managers/config/exercise.js

@@ -1,236 +1,243 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterFiles = exports.detect = exports.isDirectory = exports.shouldBeVisible = exports.isCodable = exports.validateExerciseDirectoryName = exports.exercise = void 0;
-const p = require("path");
-// import frontMatter from 'front-matter'
-const fs = require("fs");
-const console_1 = require("../../utils/console");
-const allowed_files_1 = require("./allowed_files");
-// eslint-disable-next-line
-const frontMatter = require("front-matter");
-exports.exercise = (path, position, configObject) => {
-    const { config, exercises } = configObject;
-    let slug = p.basename(path);
-    if (!exports.validateExerciseDirectoryName(slug)) {
-        console_1.default.error(`Exercise directory ${slug} has an invalid name, it has to start with two or three digits followed by words separated by underscors or hyphen (no white spaces). e.g: 01.12-hello-world`);
-    }
-    // get all the files
-    const files = fs.readdirSync(path);
-    /**
-     * build the translation array like:
-     {
-         "us": "path/to/Readme.md",
-          "es": "path/to/Readme.es.md"
-        }
-        */
-    const translations = {};
-    for (const file of files.filter(file => file.toLowerCase().includes("readme"))) {
-        const parts = file.split(".");
-        if (parts.length === 3)
-            translations[parts[1]] = file;
-        else
-            translations.us = file;
-    }
-    // if the slug is a dot, it means there is not "exercises" folder, and its just a single README.md
-    if (slug === ".")
-        slug = "default-index";
-    const detected = exports.detect(configObject, files);
-    const exerciseObj = {
-        position,
-        path,
-        slug,
-        translations,
-        language: detected === null || detected === void 0 ? void 0 : detected.language,
-        entry: (detected === null || detected === void 0 ? void 0 : detected.entry) ? path + "/" + detected.entry : null,
-        title: slug || "Exercise",
-        graded: files.some((file) => file.toLowerCase().startsWith("test.") ||
-            file.toLowerCase().startsWith("tests.")),
-        files: exports.filterFiles(files, path),
-        // if the exercises was on the config before I may keep the status done
-        done: Array.isArray(exercises) &&
-            typeof exercises[position] !== "undefined" &&
-            path.slice(Math.max(0, path.indexOf("exercises/") + 10)) ===
-                exercises[position].slug ?
-            exercises[position].done :
-            false,
-        getReadme: function (lang = null) {
-            if (lang === "us")
-                lang = null; // <-- english is default, no need to append it to the file name
-            if (!fs.existsSync(`${this.path}/README${lang ? "." + lang : ""}.md`)) {
-                console_1.default.error(`Language ${lang} not found for exercise ${slug}, switching to default language`);
-                if (lang)
-                    lang = null;
-                if (!fs.existsSync(`${this.path}/README${lang ? "." + lang : ""}.md`))
-                    throw new Error("Readme file not found for exercise: " + this.path + "/README.md");
-            }
-            const content = fs.readFileSync(`${this.path}/README${lang ? "." + lang : ""}.md`, "utf8");
-            const attr = frontMatter(content);
-            return attr;
-        },
-        getFile: function (name) {
-            const file = this.files.find((f) => f.name === name);
-            if (!file || !fs.existsSync(file.path)) {
-                throw new Error(`File not found: + ${file === null || file === void 0 ? void 0 : file.path}`);
-            }
-            else if (fs.lstatSync(file.path).isDirectory()) {
-                return ("Error: This is not a file to be read, but a directory: " + file.path);
-            }
-            // get file content
-            const content = fs.readFileSync(file.path);
-            // create reset folder
-            if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets`))
-                fs.mkdirSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets`);
-            if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/` + this.slug)) {
-                fs.mkdirSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/` + this.slug);
-            }
-            for (const _file of this.files) {
-                const stats = fs.statSync(_file.path);
-                if (stats.isDirectory() || _file.hidden)
-                    continue;
-                const fileContent = fs.readFileSync(_file.path);
-                if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/${this.slug}/${_file.name}`)) {
-                    fs.writeFileSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/${this.slug}/${_file.name}`, fileContent);
-                }
-            }
-            return content;
-        },
-        saveFile: function (name, content) {
-            const file = this.files.find((f) => f.name === name);
-            if (file) {
-                if (!fs.existsSync(file.path)) {
-                    throw new Error("File not found: " + file.path);
-                }
-                return fs.writeFileSync(file.path, content, "utf8");
-            }
-        },
-        getTestReport: function () {
-            var _a;
-            const _path = `${(_a = configObject === null || configObject === void 0 ? void 0 : configObject.confPath) === null || _a === void 0 ? void 0 : _a.base}/reports/${this.slug}.json`;
-            if (!fs.existsSync(_path))
-                return {};
-            const content = fs.readFileSync(_path);
-            const data = JSON.parse(`${content}`);
-            return data;
-        },
-    };
-    return exerciseObj;
-};
-exports.validateExerciseDirectoryName = (str) => {
-    if (str === "./")
-        return true;
-    // TODO: Add nameValidationREgex from the config
-    const regex = /^(\d{2,3}(\.\d{1,2})?-([\dA-Za-z]+(-|_)?)+)$/;
-    return regex.test(str);
-};
-exports.isCodable = (str) => {
-    const extension = p.extname(str);
-    return allowed_files_1.default.extensions.includes(extension.slice(1).toLowerCase());
-};
-const isNotConfiguration = (str) => {
-    return !allowed_files_1.default.names.includes(str);
-};
-exports.shouldBeVisible = function (file) {
-    return (
-    // doest not have "test." on their name
-    !file.name.toLocaleLowerCase().includes("test.") &&
-        !file.name.toLocaleLowerCase().includes("tests.") &&
-        !file.name.toLocaleLowerCase().includes(".hide.") &&
-        // ignore hidden files
-        file.name.charAt(0) !== "." &&
-        // ignore learn.json and bc.json
-        !file.name.toLocaleLowerCase().includes("learn.json") &&
-        !file.name.toLocaleLowerCase().includes("bc.json") &&
-        // ignore images, videos, vectors, etc.
-        exports.isCodable(file.name) &&
-        isNotConfiguration(file.name) &&
-        // readme's and directories
-        !file.name.toLowerCase().includes("readme.") &&
-        !exports.isDirectory(file.path) &&
-        file.name.charAt(0) !== "_");
-};
-exports.isDirectory = (source) => {
-    // if(path.basename(source) === path.basename(config.dirPath)) return false
-    return fs.lstatSync(source).isDirectory();
-};
-exports.detect = (configObject, files) => {
-    if (!configObject) {
-        return;
-    }
-    const { config } = configObject;
-    if (!config)
-        throw new Error("No configuration found during the engine detection");
-    if (!config.entries)
-        throw new Error("No configuration found for entries, please add a 'entries' object with the default file name for your exercise entry file that is going to be used while compiling, for example: index.html for html, app.py for python3, etc.");
-    // A language was found on the config object, but this language will only be used as last resort, learnpack will try to guess each exercise language independently based on file extension (js, jsx, html, etc.)
-    let hasFiles = files.filter(f => f.includes(".py"));
-    if (hasFiles.length > 0)
-        return {
-            language: "python3",
-            entry: hasFiles.find(f => config.entries.python3 === f),
-        };
-    hasFiles = files.filter(f => f.includes(".java"));
-    if (hasFiles.length > 0)
-        return {
-            language: "java",
-            entry: hasFiles.find(f => config.entries.java === f),
-        };
-    hasFiles = files.filter(f => f.includes(".jsx"));
-    if (hasFiles.length > 0)
-        return {
-            language: "react",
-            entry: hasFiles.find(f => config.entries.react === f),
-        };
-    const hasHTML = files.filter(f => f.includes("index.html"));
-    const hasIndexJS = files.find(f => f.includes("index.js"));
-    const hasJS = files.filter(f => f.includes(".js"));
-    // angular, vue, vanillajs needs to have at least 2 files (html,css,js),
-    // the test.js and the entry file in js
-    // if not its just another HTML
-    if (hasIndexJS && hasHTML.length > 0)
-        return {
-            language: "vanillajs",
-            entry: hasIndexJS,
-        };
-    if (hasHTML.length > 0)
-        return {
-            language: "html",
-            entry: hasHTML.find(f => config.entries.html === f),
-        };
-    if (hasJS.length > 0)
-        return {
-            language: "node",
-            entry: hasJS.find(f => config.entries.node === f),
-        };
-    return {
-        language: null,
-        entry: null,
-    };
-};
-exports.filterFiles = (files, basePath = ".") => files
-    .map((ex) => ({
-    path: basePath + "/" + ex,
-    name: ex,
-    hidden: !exports.shouldBeVisible({
-        name: ex,
-        path: basePath + "/" + ex,
-    }),
-}))
-    .sort((f1, f2) => {
-    const score = {
-        // sorting priority
-        "index.html": 1,
-        "styles.css": 2,
-        "styles.scss": 2,
-        "style.css": 2,
-        "style.scss": 2,
-        "index.css": 2,
-        "index.scss": 2,
-        "index.js": 3,
-    };
-    return score[f1.name] < score[f2.name] ? -1 : 1;
-});
-exports.default = {
-    exercise: exports.exercise,
-    detect: exports.detect,
-    filterFiles: exports.filterFiles,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterFiles = exports.detect = exports.isDirectory = exports.shouldBeVisible = exports.isCodable = exports.validateExerciseDirectoryName = exports.exercise = void 0;
+const p = require("path");
+// import frontMatter from 'front-matter'
+const fs = require("fs");
+const console_1 = require("../../utils/console");
+const allowed_files_1 = require("./allowed_files");
+// eslint-disable-next-line
+const frontMatter = require("front-matter");
+const exercise = (path, position, configObject) => {
+    const { config, exercises } = configObject;
+    let slug = p.basename(path);
+    if (!(0, exports.validateExerciseDirectoryName)(slug)) {
+        console_1.default.error(`Exercise directory ${slug} has an invalid name, it has to start with two or three digits followed by words separated by underscors or hyphen (no white spaces). e.g: 01.12-hello-world`);
+    }
+    // get all the files
+    const files = fs.readdirSync(path);
+    /**
+     * build the translation array like:
+     {
+         "us": "path/to/Readme.md",
+          "es": "path/to/Readme.es.md"
+        }
+        */
+    const translations = {};
+    for (const file of files.filter(file => file.toLowerCase().includes("readme"))) {
+        const parts = file.split(".");
+        if (parts.length === 3)
+            translations[parts[1]] = file;
+        else
+            translations.us = file;
+    }
+    // if the slug is a dot, it means there is not "exercises" folder, and its just a single README.md
+    if (slug === ".")
+        slug = "default-index";
+    const detected = (0, exports.detect)(configObject, files);
+    const exerciseObj = {
+        position,
+        path,
+        slug,
+        translations,
+        language: detected === null || detected === void 0 ? void 0 : detected.language,
+        entry: (detected === null || detected === void 0 ? void 0 : detected.entry) ? path + "/" + detected.entry : null, // full path to the exercise entry
+        title: slug || "Exercise",
+        graded: files.some((file) => file.toLowerCase().startsWith("test.") ||
+            file.toLowerCase().startsWith("tests.")),
+        files: (0, exports.filterFiles)(files, path),
+        // if the exercises was on the config before I may keep the status done
+        done: Array.isArray(exercises) &&
+            typeof exercises[position] !== "undefined" &&
+            path.slice(Math.max(0, path.indexOf("exercises/") + 10)) ===
+                exercises[position].slug ?
+            exercises[position].done :
+            false,
+        getReadme: function (lang = null) {
+            if (lang === "us")
+                lang = null; // <-- english is default, no need to append it to the file name
+            if (!fs.existsSync(`${this.path}/README${lang ? "." + lang : ""}.md`)) {
+                console_1.default.error(`Language ${lang} not found for exercise ${slug}, switching to default language`);
+                if (lang)
+                    lang = null;
+                if (!fs.existsSync(`${this.path}/README${lang ? "." + lang : ""}.md`))
+                    throw new Error("Readme file not found for exercise: " + this.path + "/README.md");
+            }
+            const content = fs.readFileSync(`${this.path}/README${lang ? "." + lang : ""}.md`, "utf8");
+            const attr = frontMatter(content);
+            return attr;
+        },
+        getFile: function (name) {
+            const file = this.files.find((f) => f.name === name);
+            if (!file || !fs.existsSync(file.path)) {
+                throw new Error(`File not found: + ${file === null || file === void 0 ? void 0 : file.path}`);
+            }
+            else if (fs.lstatSync(file.path).isDirectory()) {
+                return ("Error: This is not a file to be read, but a directory: " + file.path);
+            }
+            // get file content
+            const content = fs.readFileSync(file.path);
+            // create reset folder
+            if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets`))
+                fs.mkdirSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets`);
+            if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/` + this.slug)) {
+                fs.mkdirSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/` + this.slug);
+            }
+            for (const _file of this.files) {
+                const stats = fs.statSync(_file.path);
+                if (stats.isDirectory() || _file.hidden)
+                    continue;
+                const fileContent = fs.readFileSync(_file.path);
+                if (!fs.existsSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/${this.slug}/${_file.name}`)) {
+                    fs.writeFileSync(`${config === null || config === void 0 ? void 0 : config.dirPath}/resets/${this.slug}/${_file.name}`, fileContent);
+                }
+            }
+            return content;
+        },
+        saveFile: function (name, content) {
+            const file = this.files.find((f) => f.name === name);
+            if (file) {
+                if (!fs.existsSync(file.path)) {
+                    throw new Error("File not found: " + file.path);
+                }
+                return fs.writeFileSync(file.path, content, "utf8");
+            }
+        },
+        getTestReport: function () {
+            var _a;
+            const _path = `${(_a = configObject === null || configObject === void 0 ? void 0 : configObject.confPath) === null || _a === void 0 ? void 0 : _a.base}/reports/${this.slug}.json`;
+            if (!fs.existsSync(_path))
+                return {};
+            const content = fs.readFileSync(_path);
+            const data = JSON.parse(`${content}`);
+            return data;
+        },
+    };
+    return exerciseObj;
+};
+exports.exercise = exercise;
+const validateExerciseDirectoryName = (str) => {
+    if (str === "./")
+        return true;
+    // TODO: Add nameValidationREgex from the config
+    const regex = /^(\d{2,3}(\.\d{1,2})?-([\dA-Za-z]+(-|_)?)+)$/;
+    return regex.test(str);
+};
+exports.validateExerciseDirectoryName = validateExerciseDirectoryName;
+const isCodable = (str) => {
+    const extension = p.extname(str);
+    return allowed_files_1.default.extensions.includes(extension.slice(1).toLowerCase());
+};
+exports.isCodable = isCodable;
+const isNotConfiguration = (str) => {
+    return !allowed_files_1.default.names.includes(str);
+};
+const shouldBeVisible = function (file) {
+    return (
+    // doest not have "test." on their name
+    !file.name.toLocaleLowerCase().includes("test.") &&
+        !file.name.toLocaleLowerCase().includes("tests.") &&
+        !file.name.toLocaleLowerCase().includes(".hide.") &&
+        // ignore hidden files
+        file.name.charAt(0) !== "." &&
+        // ignore learn.json and bc.json
+        !file.name.toLocaleLowerCase().includes("learn.json") &&
+        !file.name.toLocaleLowerCase().includes("bc.json") &&
+        // ignore images, videos, vectors, etc.
+        (0, exports.isCodable)(file.name) &&
+        isNotConfiguration(file.name) &&
+        // readme's and directories
+        !file.name.toLowerCase().includes("readme.") &&
+        !(0, exports.isDirectory)(file.path) &&
+        file.name.charAt(0) !== "_");
+};
+exports.shouldBeVisible = shouldBeVisible;
+const isDirectory = (source) => {
+    // if(path.basename(source) === path.basename(config.dirPath)) return false
+    return fs.lstatSync(source).isDirectory();
+};
+exports.isDirectory = isDirectory;
+const detect = (configObject, files) => {
+    if (!configObject) {
+        return;
+    }
+    const { config } = configObject;
+    if (!config)
+        throw new Error("No configuration found during the engine detection");
+    if (!config.entries)
+        throw new Error("No configuration found for entries, please add a 'entries' object with the default file name for your exercise entry file that is going to be used while compiling, for example: index.html for html, app.py for python3, etc.");
+    // A language was found on the config object, but this language will only be used as last resort, learnpack will try to guess each exercise language independently based on file extension (js, jsx, html, etc.)
+    let hasFiles = files.filter(f => f.includes(".py"));
+    if (hasFiles.length > 0)
+        return {
+            language: "python3",
+            entry: hasFiles.find(f => config.entries.python3 === f),
+        };
+    hasFiles = files.filter(f => f.includes(".java"));
+    if (hasFiles.length > 0)
+        return {
+            language: "java",
+            entry: hasFiles.find(f => config.entries.java === f),
+        };
+    hasFiles = files.filter(f => f.includes(".jsx"));
+    if (hasFiles.length > 0)
+        return {
+            language: "react",
+            entry: hasFiles.find(f => config.entries.react === f),
+        };
+    const hasHTML = files.filter(f => f.includes("index.html"));
+    const hasIndexJS = files.find(f => f.includes("index.js"));
+    const hasJS = files.filter(f => f.includes(".js"));
+    // angular, vue, vanillajs needs to have at least 2 files (html,css,js),
+    // the test.js and the entry file in js
+    // if not its just another HTML
+    if (hasIndexJS && hasHTML.length > 0)
+        return {
+            language: "vanillajs",
+            entry: hasIndexJS,
+        };
+    if (hasHTML.length > 0)
+        return {
+            language: "html",
+            entry: hasHTML.find(f => config.entries.html === f),
+        };
+    if (hasJS.length > 0)
+        return {
+            language: "node",
+            entry: hasJS.find(f => config.entries.node === f),
+        };
+    return {
+        language: null,
+        entry: null,
+    };
+};
+exports.detect = detect;
+const filterFiles = (files, basePath = ".") => files
+    .map((ex) => ({
+    path: basePath + "/" + ex,
+    name: ex,
+    hidden: !(0, exports.shouldBeVisible)({
+        name: ex,
+        path: basePath + "/" + ex,
+    }),
+}))
+    .sort((f1, f2) => {
+    const score = {
+        // sorting priority
+        "index.html": 1,
+        "styles.css": 2,
+        "styles.scss": 2,
+        "style.css": 2,
+        "style.scss": 2,
+        "index.css": 2,
+        "index.scss": 2,
+        "index.js": 3,
+    };
+    return score[f1.name] < score[f2.name] ? -1 : 1;
+});
+exports.filterFiles = filterFiles;
+exports.default = {
+    exercise: exports.exercise,
+    detect: exports.detect,
+    filterFiles: exports.filterFiles,
+};

package/lib/managers/config/index.d.ts

@@ -1,3 +1,3 @@
-import { IConfigManagerAttributes, IConfigManager } from "../../models/config-manager";
-declare const _default: ({ grading, mode, disableGrading, version, }: IConfigManagerAttributes) => Promise<IConfigManager>;
-export default _default;
+import { IConfigManagerAttributes, IConfigManager } from "../../models/config-manager";
+declare const _default: ({ grading, mode, disableGrading, version, }: IConfigManagerAttributes) => Promise<IConfigManager>;
+export default _default;