@learnpack/learnpack 2.1.25 → 2.1.27

package/src/utils/templates/isolated/01-hello-world/README.md

@@ -1,26 +1,26 @@
-# `01` First Exercise
-
-We created this first exercise as an example, you can find it located in the folder `./01-hello-world`.
-
-1. Every exercise must be located on a separate folder and it must have a README.md file inside with the exercise instructions written in markdown.
-2. You can have just a README file and it will be like a page in a book, no code files.
-3. You can also add a `README.[lang].md` file for translations, for example: `README.es.md` for spanish.
-
-## Video compatibility
-
-If you want to include some video introduction for each exercise, add a `intro` property in the markdown frontmatter of the README.md for that particular exercise:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
-
-You can also add a video solution for each exercise by adding a `tutorial` property on the markdown frontmatter of it's README.md:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
-tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
+# `01` First Exercise
+
+We created this first exercise as an example, you can find it located in the folder `./01-hello-world`.
+
+1. Every exercise must be located on a separate folder and it must have a README.md file inside with the exercise instructions written in markdown.
+2. You can have just a README file and it will be like a page in a book, no code files.
+3. You can also add a `README.[lang].md` file for translations, for example: `README.es.md` for spanish.
+
+## Video compatibility
+
+If you want to include some video introduction for each exercise, add a `intro` property in the markdown frontmatter of the README.md for that particular exercise:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+You can also add a video solution for each exercise by adding a `tutorial` property on the markdown frontmatter of it's README.md:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```

package/src/utils/templates/isolated/README.ejs

@@ -1,5 +1,5 @@
-# Welcome to <%= it.title %>
-
-You have initialized the exercises with grading=`incremental`; meaning that your students will complete one single tutorial with clear and autograded steps from beginning to end.
-
+# Welcome to <%= it.title %>
+
+You have initialized the exercises with grading=`incremental`; meaning that your students will complete one single tutorial with clear and autograded steps from beginning to end.
+
 Type `$ learnpack start` in your terminal to start the exercises.

package/src/utils/templates/isolated/README.es.ejs

@@ -1,5 +1,5 @@
-# Bienvenido a <%= it.title %>
-
-Has inicializado los ejercicios con grading=`incremental`; esto signigica que tus estudiantes completarán un solo tutorial con pasos claros e incrementales, desde el comienzo hasta el final.
-
+# Bienvenido a <%= it.title %>
+
+Has inicializado los ejercicios con grading=`incremental`; esto signigica que tus estudiantes completarán un solo tutorial con pasos claros e incrementales, desde el comienzo hasta el final.
+
 Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

package/src/utils/templates/no-grading/README.ejs

@@ -1,5 +1,5 @@
-# Welcome to <%= it.title %>
-
-You have initialized the exercises without grading, meaning that your students will completed exercises without the need of coding.
-
+# Welcome to <%= it.title %>
+
+You have initialized the exercises without grading, meaning that your students will completed exercises without the need of coding.
+
 Type `$ learnpack start` in your terminal to start the exercises.

package/src/utils/templates/no-grading/README.es.ejs

@@ -1,5 +1,5 @@
-# Bienvenido a <%= it.title %>
-
-Has inicializado los ejercicios sin grading; lo que signigica que tus estudiantes completarán los ejercicios sin necesidad de codificar.
-
+# Bienvenido a <%= it.title %>
+
+Has inicializado los ejercicios sin grading; lo que signigica que tus estudiantes completarán los ejercicios sin necesidad de codificar.
+
 Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

package/src/utils/validators.ts

@@ -1,18 +1,18 @@
-export function validURL(str: string) {
-  if (!str.includes('github.com')) {
-    return false
-  }
-
-  const pattern = new RegExp(
-    '^(https?:\\/\\/)?' + // protocol
-      '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
-      '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
-      '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
-      '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
-      '(\\#[-a-z\\d_]*)?$',
-    'i',
-  ) // fragment locator
-  return !!pattern.test(str)
-}
-
-export default {validURL}
+export function validURL(str: string) {
+  if (!str.includes('github.com')) {
+    return false
+  }
+
+  const pattern = new RegExp(
+    '^(https?:\\/\\/)?' + // protocol
+      '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
+      '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
+      '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
+      '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
+      '(\\#[-a-z\\d_]*)?$',
+    'i',
+  ) // fragment locator
+  return !!pattern.test(str)
+}
+
+export default {validURL}

package/src/utils/watcher.ts

@@ -1,25 +1,25 @@
-import * as chokidar from "chokidar";
-import Console from "./console";
-import * as debounce from "debounce";
-import { IConfigManager } from "../models/config-manager";
+import * as chokidar from "chokidar"
+import Console from "./console"
+import * as debounce from "debounce"
+import { IConfigManager } from "../models/config-manager"
 
 export default (path: string, reloadSocket: () => void) =>
   new Promise((resolve /* , reject */) => {
-    Console.debug("PATH:", path);
+    Console.debug("PATH:", path)
     const watcher = chokidar.watch(path, {
       // TODO: This watcher is not ready yet
       ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
       ignoreInitial: true,
-    });
+    })
     const onChange = (eventname: string, _filename: string) => {
-      resolve(eventname /* , filename */);
-      reloadSocket();
-    };
+      resolve(eventname /* , filename */)
+      reloadSocket()
+    }
 
-    watcher.on("all", debounce(onChange, 500, true));
+    watcher.on("all", debounce(onChange, 500, true))
     // watcher.on('all', onChange)
     process.on("SIGINT", function () {
-      watcher.close();
-      process.exit();
-    });
-  });
+      watcher.close()
+      process.exit()
+    })
+  })

package/lib/commands/audit.d.ts

@@ -1,6 +0,0 @@
-import SessionCommand from "../utils/SessionCommand";
-declare class AuditCommand extends SessionCommand {
-    init(): Promise<void>;
-    run(): Promise<void>;
-}
-export default AuditCommand;

package/lib/commands/audit.js

@@ -1,317 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const exercise_1 = require("../managers/config/exercise");
-const console_1 = require("../utils/console");
-const audit_1 = require("../utils/audit");
-const SessionCommand_1 = require("../utils/SessionCommand");
-const path = require("path");
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-class AuditCommand extends SessionCommand_1.default {
-    async init() {
-        const { flags } = this.parse(AuditCommand);
-        await this.initSession(flags);
-    }
-    async run() {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
-        console_1.default.log("Running command audit...");
-        // Get configuration object.
-        let config = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
-        if (config) {
-            const errors = [];
-            const warnings = [];
-            if (((_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.projectType) === "tutorial") {
-                const counter = {
-                    images: {
-                        error: 0,
-                        total: 0,
-                    },
-                    links: {
-                        error: 0,
-                        total: 0,
-                    },
-                    exercises: 0,
-                    readmeFiles: 0,
-                };
-                // Checks if learnpack clean has been run
-                audit_1.default.checkLearnpackClean(config, errors);
-                // Build exercises if they are not built yet.
-                (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
-                config = (_d = this.configManager) === null || _d === void 0 ? void 0 : _d.get();
-                // Check if the exercises folder has some files within any ./exercise
-                const exercisesPath = config.config.exercisesPath;
-                fs.readdir(exercisesPath, (err, files) => {
-                    if (err) {
-                        return console.log("Unable to scan directory: " + err);
-                    }
-                    // listing all files using forEach
-                    for (const file of files) {
-                        // Do whatever you want to do with the file
-                        const filePath = path.join(exercisesPath, file);
-                        if (fs.statSync(filePath).isFile())
-                            warnings.push({
-                                exercise: file,
-                                msg: "This file is not inside any exercise folder.",
-                            });
-                    }
-                });
-                // This function is being created because the find method doesn't work with promises.
-                const find = async (file, lang, exercise) => {
-                    if (file.name === lang) {
-                        await audit_1.default.checkUrl(config, file.path, file.name, exercise, errors, warnings, counter);
-                        return true;
-                    }
-                    return false;
-                };
-                console_1.default.debug("config", config);
-                console_1.default.info(" Checking if the config file is fine...");
-                // These two lines check if the 'slug' property is inside the configuration object.
-                console_1.default.debug("Checking if the slug property is inside the configuration object...");
-                if (!((_e = config.config) === null || _e === void 0 ? void 0 : _e.slug))
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The slug property is not in the configuration object",
-                    });
-                // These two lines check if the 'repository' property is inside the configuration object.
-                console_1.default.debug("Checking if the repository property is inside the configuration object...");
-                if (!((_f = config.config) === null || _f === void 0 ? void 0 : _f.repository))
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The repository property is not in the configuration object",
-                    });
-                else
-                    audit_1.default.isUrl((_g = config.config) === null || _g === void 0 ? void 0 : _g.repository, errors, counter);
-                // These two lines check if the 'description' property is inside the configuration object.
-                console_1.default.debug("Checking if the description property is inside the configuration object...");
-                if (!((_h = config.config) === null || _h === void 0 ? void 0 : _h.description))
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The description property is not in the configuration object",
-                    });
-                if (errors.length === 0)
-                    console_1.default.log("The config file is ok");
-                // Validates if images and links are working at every README file.
-                const exercises = config.exercises;
-                const readmeFiles = [];
-                if (exercises && exercises.length > 0) {
-                    console_1.default.info(" Checking if the images are working...");
-                    for (const index in exercises) {
-                        if (Object.prototype.hasOwnProperty.call(exercises, index)) {
-                            const exercise = exercises[index];
-                            if (!exercise_1.validateExerciseDirectoryName(exercise.title))
-                                errors.push({
-                                    exercise: exercise.title,
-                                    msg: `The exercise ${exercise.title} has an invalid name.`,
-                                });
-                            let readmeFilesCount = { exercise: exercise.title, count: 0 };
-                            if (Object.keys(exercise.translations).length === 0)
-                                errors.push({
-                                    exercise: exercise.title,
-                                    msg: `The exercise ${exercise.title} doesn't have a README.md file.`,
-                                });
-                            if (exercise.language === "python3" ||
-                                exercise.language === "python") {
-                                for (const f of exercise.files.map(f => f)) {
-                                    if (f.path.includes("test.py") ||
-                                        f.path.includes("tests.py")) {
-                                        const content = fs.readFileSync(f.path).toString();
-                                        const isEmpty = audit_1.default.checkForEmptySpaces(content);
-                                        if (isEmpty || !content)
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `This file (${f.name}) doesn't have any content inside.`,
-                                            });
-                                    }
-                                }
-                            }
-                            else {
-                                for (const f of exercise.files.map(f => f)) {
-                                    if (f.path.includes("test.js") ||
-                                        f.path.includes("tests.js")) {
-                                        const content = fs.readFileSync(f.path).toString();
-                                        const isEmpty = audit_1.default.checkForEmptySpaces(content);
-                                        if (isEmpty || !content)
-                                            errors.push({
-                                                exercise: exercise.title,
-                                                msg: `This file (${f.name}) doesn't have any content inside.`,
-                                            });
-                                    }
-                                }
-                            }
-                            for (const lang in exercise.translations) {
-                                if (Object.prototype.hasOwnProperty.call(exercise.translations, lang)) {
-                                    const files = [];
-                                    const findResultPromises = [];
-                                    for (const file of exercise.files) {
-                                        const found = find(file, exercise.translations[lang], exercise);
-                                        findResultPromises.push(found);
-                                    }
-                                    // eslint-disable-next-line
-                                    let findResults = await Promise.all(findResultPromises);
-                                    for (const found of findResults) {
-                                        if (found) {
-                                            readmeFilesCount = Object.assign(Object.assign({}, readmeFilesCount), { count: readmeFilesCount.count + 1 });
-                                            files.push(found);
-                                        }
-                                    }
-                                    if (!files.includes(true))
-                                        errors.push({
-                                            exercise: exercise.title,
-                                            msg: "This exercise doesn't have a README.md file.",
-                                        });
-                                }
-                            }
-                            readmeFiles.push(readmeFilesCount);
-                        }
-                    }
-                }
-                else
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The exercises array is empty.",
-                    });
-                console_1.default.log(`${counter.images.total - counter.images.error} images ok from ${counter.images.total}`);
-                console_1.default.info(" Checking if important files are missing... (README's, translations, gitignore...)");
-                // Check if all the exercises has the same ammount of README's, this way we can check if they have the same ammount of translations.
-                const files = [];
-                let count = 0;
-                for (const item of readmeFiles) {
-                    if (count < item.count)
-                        count = item.count;
-                }
-                for (const item of readmeFiles) {
-                    if (item.count !== count)
-                        files.push(` ${item.exercise}`);
-                }
-                if (files.length > 0) {
-                    const filesString = files.join(",");
-                    warnings.push({
-                        exercise: undefined,
-                        msg: files.length === 1 ?
-                            `This exercise is missing translations:${filesString}` :
-                            `These exercises are missing translations:${filesString}`,
-                    });
-                }
-                // Checks if the .gitignore file exists.
-                if (!fs.existsSync(".gitignore"))
-                    warnings.push({
-                        exercise: undefined,
-                        msg: ".gitignore file doesn't exist",
-                    });
-                counter.exercises = exercises.length;
-                for (const readme of readmeFiles) {
-                    counter.readmeFiles += readme.count;
-                }
-            }
-            else {
-                // This is the audit code for Projects
-                // Getting the learn.json schema
-                const schemaResponse = await fetch("https://raw.githubusercontent.com/tommygonzaleza/project-template/main/.github/learn-schema.json");
-                const schema = await schemaResponse.json();
-                // Checking the "learn.json" file:
-                const learnjson = JSON.parse(fs.readFileSync("./learn.json").toString());
-                if (!learnjson) {
-                    console_1.default.error("There is no learn.json file located in the root of the project.");
-                    process.exit(1);
-                }
-                // Checking the README.md files and possible translations.
-                let readmeFiles = [];
-                const translations = [];
-                const translationRegex = /README\.([a-z]{2,3})\.md/;
-                try {
-                    const data = await fs.promises.readdir("./");
-                    readmeFiles = data.filter(file => file.includes("README"));
-                    if (readmeFiles.length === 0)
-                        errors.push({
-                            exercise: undefined,
-                            msg: `There is no README file in the repository.`,
-                        });
-                }
-                catch (error) {
-                    if (error)
-                        console_1.default.error("There was an error getting the directory files", error);
-                }
-                for (const readmeFile of readmeFiles) {
-                    // Checking the language of each README file.
-                    if (readmeFile === "README.md")
-                        translations.push("us");
-                    else {
-                        const regexGroups = translationRegex.exec(readmeFile);
-                        if (regexGroups)
-                            translations.push(regexGroups[1]);
-                    }
-                    const readme = fs.readFileSync(path.resolve(readmeFile)).toString();
-                    const isEmpty = audit_1.default.checkForEmptySpaces(readme);
-                    if (isEmpty || !readme) {
-                        errors.push({
-                            exercise: undefined,
-                            msg: `This file "${readmeFile}" doesn't have any content inside.`,
-                        });
-                        continue;
-                    }
-                    if (readme.length < 800)
-                        errors.push({
-                            exercise: undefined,
-                            msg: `The "${readmeFile}" file should have at least 800 characters (It currently have: ${readme.length}).`,
-                        });
-                    // eslint-disable-next-line
-                    await audit_1.default.checkUrl(config, path.resolve(readmeFile), readmeFile, undefined, errors, warnings, 
-                    // eslint-disable-next-line
-                    undefined);
-                }
-                // Adding the translations to the learn.json
-                learnjson.translations = translations;
-                // Checking if the preview image (from the learn.json) is OK.
-                try {
-                    const res = await fetch(learnjson.preview, { method: "HEAD" });
-                    if (res.status > 399 && res.status < 500) {
-                        errors.push({
-                            exercise: undefined,
-                            msg: `The link of the "preview" is broken: ${learnjson.preview}`,
-                        });
-                    }
-                }
-                catch (_j) {
-                    errors.push({
-                        exercise: undefined,
-                        msg: `The link of the "preview" is broken: ${learnjson.preview}`,
-                    });
-                }
-                const date = new Date();
-                learnjson.validationAt = date.getTime();
-                if (errors.length > 0)
-                    learnjson.validationStatus = "error";
-                else if (warnings.length > 0)
-                    learnjson.validationStatus = "warning";
-                else
-                    learnjson.validationStatus = "success";
-                // Writes the "learn.json" file with all the new properties
-                await fs.promises.writeFile("./learn.json", JSON.stringify(learnjson));
-            }
-            await audit_1.default.showWarnings(warnings);
-            // eslint-disable-next-line
-            await audit_1.default.showErrors(errors, undefined);
-        }
-    }
-}
-AuditCommand.description = `learnpack audit is the command in charge of creating an auditory of the repository
-...
-learnpack audit checks for the following information in a repository:
-    1. The configuration object has slug, repository and description. (Error)
-    2. The command learnpack clean has been run. (Error)
-    3. If a markdown or test file doesn't have any content. (Error)
-    4. The links are accessing to valid servers. (Error)
-    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)
-    6. The external images are working (If they are pointing to a valid server). (Error)
-    7. The exercises directory names are valid. (Error)
-    8. If an exercise doesn't have a README file. (Error)
-    9. The exercises array (Of the config file) has content. (Error)
-    10. The exercses have the same translations. (Warning)
-    11. The .gitignore file exists. (Warning)
-    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
-`;
-AuditCommand.flags = {
-// name: flags.string({char: 'n', description: 'name to print'}),
-};
-exports.default = AuditCommand;

package/lib/commands/clean.d.ts

@@ -1,8 +0,0 @@
-import SessionCommand from "../utils/SessionCommand";
-declare class CleanCommand extends SessionCommand {
-    static description: string;
-    static flags: any;
-    init(): Promise<void>;
-    run(): Promise<void>;
-}
-export default CleanCommand;

package/lib/commands/clean.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// import {flags} from '@oclif/command'
-const console_1 = require("../utils/console");
-const SessionCommand_1 = require("../utils/SessionCommand");
-class CleanCommand extends SessionCommand_1.default {
-    async init() {
-        const { flags } = this.parse(CleanCommand);
-        await this.initSession(flags);
-    }
-    async run() {
-        var _a;
-        const { flags } = this.parse(CleanCommand);
-        (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.clean();
-        console_1.default.success("Package cleaned successfully, ready to publish");
-    }
-}
-CleanCommand.description = `Clean the configuration object
-  ...
-  Extra documentation goes here
-  `;
-CleanCommand.flags = {
-// name: flags.string({char: 'n', description: 'name to print'}),
-};
-exports.default = CleanCommand;

package/lib/commands/download.d.ts

@@ -1,13 +0,0 @@
-import { Command } from "@oclif/command";
-declare class DownloadCommand extends Command {
-    static description: string;
-    static flags: any;
-    static args: {
-        name: string;
-        required: boolean;
-        description: string;
-        hidden: boolean;
-    }[];
-    run(): Promise<null | undefined>;
-}
-export default DownloadCommand;

package/lib/commands/download.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-// import fetch from 'node-fetch'
-const file_1 = require("../managers/file");
-const console_1 = require("../utils/console");
-const api_1 = require("../utils/api");
-const download_1 = require("../ui/download");
-// const BaseCommand = require('../utils/BaseCommand');
-class DownloadCommand extends command_1.Command {
-    // async init() {
-    //   const {flags} = this.parse(DownloadCommand)
-    //   await this.initSession(flags)
-    // }
-    async run() {
-        const { /* flags, */ args } = this.parse(DownloadCommand);
-        // start watching for file changes
-        let _package = args.package;
-        if (!_package) {
-            _package = (await download_1.askPackage());
-        }
-        if (!_package) {
-            return null;
-        }
-        try {
-            const packageInfo = await api_1.default.getAllPackages({ slug: _package });
-            if (packageInfo.results.length === 0)
-                console_1.default.error(`Package ${_package} not found`);
-            else
-                file_1.clone(packageInfo.results[0].repository)
-                    .then(_result => {
-                    console_1.default.success("Successfully downloaded");
-                    console_1.default.info(`You can now CD into the folder like this: $ cd ${_package}`);
-                })
-                    .catch(error => console_1.default.error(error.message || error));
-        }
-        catch (_a) { }
-    }
-}
-DownloadCommand.description = `Describe the command here
-...
-Extra documentation goes here
-`;
-DownloadCommand.flags = {
-// name: flags.string({char: 'n', description: 'name to print'}),
-};
-DownloadCommand.args = [
-    {
-        name: "package",
-        required: false,
-        description: "The unique string that identifies this package on learnpack",
-        hidden: false,
-    },
-];
-exports.default = DownloadCommand;

package/lib/commands/init.d.ts

@@ -1,9 +0,0 @@
-import BaseCommand from "../utils/BaseCommand";
-declare class InitComand extends BaseCommand {
-    static description: string;
-    static flags: {
-        grading: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-    };
-    run(): Promise<void>;
-}
-export default InitComand;