@learnpack/learnpack 4.0.10 → 4.0.13

package/lib/commands/clean.d.ts

@@ -1,8 +1,8 @@
-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;
+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 +1,25 @@
-"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");
-    }
-}
+"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;
+  `;
+CleanCommand.flags = {
+// name: flags.string({char: 'n', description: 'name to print'}),
+};
+exports.default = CleanCommand;

package/lib/commands/download.d.ts

@@ -1,13 +1,13 @@
-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;
+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 +1,55 @@
-"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) { }
-    }
-}
+"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 (0, 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
+                (0, 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;
+`;
+DownloadCommand.flags = {
+// name: flags.string({char: 'n', description: 'name to print'}),
+};
+DownloadCommand.args = [
+    {
+        name: "package", // name of arg to show in help and reference with args[name]
+        required: false, // make the arg required with `required: true`
+        description: "The unique string that identifies this package on learnpack", // help description
+        hidden: false, // hide this arg from help
+    },
+];
+exports.default = DownloadCommand;

package/lib/commands/init.d.ts

@@ -1,9 +1,9 @@
-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;
+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;

package/lib/commands/init.js

@@ -1,127 +1,127 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const BaseCommand_1 = require("../utils/BaseCommand");
-// eslint-disable-next-line
-const fs = require("fs-extra");
-const prompts = require("prompts");
-const cli_ux_1 = require("cli-ux");
-const eta = require("eta");
-const console_1 = require("../utils/console");
-const errors_1 = require("../utils/errors");
-const path = require("path");
-class InitComand extends BaseCommand_1.default {
-    async run() {
-        const { flags } = this.parse(InitComand);
-        // if the folder/file .learn or .breathecode aleady exists
-        await alreadyInitialized();
-        const choices = await prompts([
-            {
-                type: "select",
-                name: "grading",
-                message: "Is the auto-grading going to be isolated or incremental?",
-                choices: [
-                    {
-                        title: "Incremental: Build on top of each other like a tutorial",
-                        value: "incremental",
-                    },
-                    { title: "Isolated: Small separated exercises", value: "isolated" },
-                    {
-                        title: "No grading: No feedback or testing whatsoever",
-                        value: null,
-                    },
-                ],
-            },
-            {
-                type: "text",
-                name: "title",
-                initial: "My Interactive Tutorial",
-                message: "Title for your tutorial? Press enter to leave as it is",
-            },
-            {
-                type: "text",
-                name: "description",
-                initial: "",
-                message: "Description for your tutorial? Press enter to leave blank",
-            },
-            {
-                type: "select",
-                name: "difficulty",
-                message: "How difficulty will be to complete the tutorial?",
-                choices: [
-                    { title: "Begginer (no previous experience)", value: "beginner" },
-                    { title: "Easy (just a bit of experience required)", value: "easy" },
-                    {
-                        title: "Intermediate (you need experience)",
-                        value: "intermediate",
-                    },
-                    { title: "Hard (master the topic)", value: "hard" },
-                ],
-            },
-            {
-                type: "text",
-                name: "duration",
-                initial: "1",
-                message: "How many hours avg it takes to complete (number)?",
-                validate: (value) => {
-                    const n = Math.floor(Number(value));
-                    return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0;
-                },
-            },
-        ]);
-        const packageInfo = {
-            grading: choices.grading,
-            difficulty: choices.difficulty,
-            duration: parseInt(choices.duration),
-            description: choices.description,
-            title: choices.title,
-            slug: choices.title
-                .toLowerCase()
-                .replace(/ /g, "-")
-                .replace(/[^\w-]+/g, ""),
-        };
-        const tutorialDir = `./${packageInfo.slug}`;
-        fs.ensureDirSync(tutorialDir); // Ensure the directory exists
-        cli_ux_1.default.action.start("Initializing package");
-        const languages = ["en", "es"];
-        const templatesDir = path.resolve(__dirname, "../../src/utils/templates/" + (choices.grading || "no-grading"));
-        if (!fs.existsSync(templatesDir))
-            throw errors_1.ValidationError(`Template ${templatesDir} does not exists`);
-        await fs.copySync(templatesDir, tutorialDir);
-        // Creating README files
-        for (const language of languages) {
-            const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`;
-            const readmeTemplatePath = path.resolve(templatesDir, `${readmeFilename}.ejs`);
-            const readmeContent = eta.render(fs.readFileSync(readmeTemplatePath, "utf-8"), packageInfo);
-            fs.writeFileSync(path.join(tutorialDir, `${readmeFilename}.md`), readmeContent);
-            if (fs.existsSync(path.join(tutorialDir, `${readmeFilename}.ejs`)))
-                fs.removeSync(path.join(tutorialDir, `${readmeFilename}.ejs`));
-        }
-        if (!fs.existsSync(path.join(tutorialDir, ".gitignore")))
-            fs.copyFile(path.resolve(__dirname, "../../src/utils/templates/gitignore.txt"), path.join(tutorialDir, ".gitignore"));
-        fs.writeFileSync(path.join(tutorialDir, "learn.json"), JSON.stringify(packageInfo, null, 2));
-        cli_ux_1.default.action.stop();
-        console_1.default.success(`😋 Package initialized successfully in ${tutorialDir}`);
-        console_1.default.help(`Get inside the tutorial with the command: $ cd ${tutorialDir}`);
-        console_1.default.help(`Start the exercises by running the following command on your terminal: $ learnpack start`);
-    }
-}
-InitComand.description = "Create a new learning package: Book, Tutorial or Exercise";
-InitComand.flags = Object.assign(Object.assign({}, BaseCommand_1.default.flags), { grading: command_1.flags.help({ char: "h" }) });
-const alreadyInitialized = () => new Promise((resolve, reject) => {
-    fs.readdir("./", function (err, files) {
-        files = files.filter((f) => [".learn", "learn.json", "bc.json", ".breathecode"].includes(f));
-        if (err) {
-            reject(errors_1.ValidationError(err.message));
-            throw errors_1.ValidationError(err.message);
-        }
-        else if (files.length > 0) {
-            reject(errors_1.ValidationError("It seems the package is already initialized because we've found the following files: " +
-                files.join(",")));
-            throw errors_1.ValidationError("It seems the package is already initialized because we've found the following files: " +
-                files.join(","));
-        }
-        resolve(false);
-    });
-});
-exports.default = InitComand;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const BaseCommand_1 = require("../utils/BaseCommand");
+// eslint-disable-next-line
+const fs = require("fs-extra");
+const prompts = require("prompts");
+const cli_ux_1 = require("cli-ux");
+const eta = require("eta");
+const console_1 = require("../utils/console");
+const errors_1 = require("../utils/errors");
+const path = require("path");
+class InitComand extends BaseCommand_1.default {
+    async run() {
+        const { flags } = this.parse(InitComand);
+        // if the folder/file .learn or .breathecode aleady exists
+        await alreadyInitialized();
+        const choices = await prompts([
+            {
+                type: "select",
+                name: "grading",
+                message: "Is the auto-grading going to be isolated or incremental?",
+                choices: [
+                    {
+                        title: "Incremental: Build on top of each other like a tutorial",
+                        value: "incremental",
+                    },
+                    { title: "Isolated: Small separated exercises", value: "isolated" },
+                    {
+                        title: "No grading: No feedback or testing whatsoever",
+                        value: null,
+                    },
+                ],
+            },
+            {
+                type: "text",
+                name: "title",
+                initial: "My Interactive Tutorial",
+                message: "Title for your tutorial? Press enter to leave as it is",
+            },
+            {
+                type: "text",
+                name: "description",
+                initial: "",
+                message: "Description for your tutorial? Press enter to leave blank",
+            },
+            {
+                type: "select",
+                name: "difficulty",
+                message: "How difficulty will be to complete the tutorial?",
+                choices: [
+                    { title: "Begginer (no previous experience)", value: "beginner" },
+                    { title: "Easy (just a bit of experience required)", value: "easy" },
+                    {
+                        title: "Intermediate (you need experience)",
+                        value: "intermediate",
+                    },
+                    { title: "Hard (master the topic)", value: "hard" },
+                ],
+            },
+            {
+                type: "text",
+                name: "duration",
+                initial: "1",
+                message: "How many hours avg it takes to complete (number)?",
+                validate: (value) => {
+                    const n = Math.floor(Number(value));
+                    return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0;
+                },
+            },
+        ]);
+        const packageInfo = {
+            grading: choices.grading,
+            difficulty: choices.difficulty,
+            duration: parseInt(choices.duration),
+            description: choices.description,
+            title: choices.title,
+            slug: choices.title
+                .toLowerCase()
+                .replace(/ /g, "-")
+                .replace(/[^\w-]+/g, ""),
+        };
+        const tutorialDir = `./${packageInfo.slug}`;
+        fs.ensureDirSync(tutorialDir); // Ensure the directory exists
+        cli_ux_1.default.action.start("Initializing package");
+        const languages = ["en", "es"];
+        const templatesDir = path.resolve(__dirname, "../../src/utils/templates/" + (choices.grading || "no-grading"));
+        if (!fs.existsSync(templatesDir))
+            throw (0, errors_1.ValidationError)(`Template ${templatesDir} does not exists`);
+        await fs.copySync(templatesDir, tutorialDir);
+        // Creating README files
+        for (const language of languages) {
+            const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`;
+            const readmeTemplatePath = path.resolve(templatesDir, `${readmeFilename}.ejs`);
+            const readmeContent = eta.render(fs.readFileSync(readmeTemplatePath, "utf-8"), packageInfo);
+            fs.writeFileSync(path.join(tutorialDir, `${readmeFilename}.md`), readmeContent);
+            if (fs.existsSync(path.join(tutorialDir, `${readmeFilename}.ejs`)))
+                fs.removeSync(path.join(tutorialDir, `${readmeFilename}.ejs`));
+        }
+        if (!fs.existsSync(path.join(tutorialDir, ".gitignore")))
+            fs.copyFile(path.resolve(__dirname, "../../src/utils/templates/gitignore.txt"), path.join(tutorialDir, ".gitignore"));
+        fs.writeFileSync(path.join(tutorialDir, "learn.json"), JSON.stringify(packageInfo, null, 2));
+        cli_ux_1.default.action.stop();
+        console_1.default.success(`😋 Package initialized successfully in ${tutorialDir}`);
+        console_1.default.help(`Get inside the tutorial with the command: $ cd ${tutorialDir}`);
+        console_1.default.help(`Start the exercises by running the following command on your terminal: $ learnpack start`);
+    }
+}
+InitComand.description = "Create a new learning package: Book, Tutorial or Exercise";
+InitComand.flags = Object.assign(Object.assign({}, BaseCommand_1.default.flags), { grading: command_1.flags.help({ char: "h" }) });
+const alreadyInitialized = () => new Promise((resolve, reject) => {
+    fs.readdir("./", function (err, files) {
+        files = files.filter((f) => [".learn", "learn.json", "bc.json", ".breathecode"].includes(f));
+        if (err) {
+            reject((0, errors_1.ValidationError)(err.message));
+            throw (0, errors_1.ValidationError)(err.message);
+        }
+        else if (files.length > 0) {
+            reject((0, errors_1.ValidationError)("It seems the package is already initialized because we've found the following files: " +
+                files.join(",")));
+            throw (0, errors_1.ValidationError)("It seems the package is already initialized because we've found the following files: " +
+                files.join(","));
+        }
+        resolve(false);
+    });
+});
+exports.default = InitComand;

package/lib/commands/login.d.ts

@@ -1,14 +1,14 @@
-import SessionCommand from "../utils/SessionCommand";
-declare class LoginCommand extends SessionCommand {
-    static description: string;
-    static flags: any;
-    static args: {
-        name: string;
-        required: boolean;
-        description: string;
-        hidden: boolean;
-    }[];
-    init(): Promise<void>;
-    run(): Promise<void>;
-}
-export default LoginCommand;
+import SessionCommand from "../utils/SessionCommand";
+declare class LoginCommand extends SessionCommand {
+    static description: string;
+    static flags: any;
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+        hidden: boolean;
+    }[];
+    init(): Promise<void>;
+    run(): Promise<void>;
+}
+export default LoginCommand;

package/lib/commands/login.js

@@ -1,37 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const SessionCommand_1 = require("../utils/SessionCommand");
-const session_1 = require("../managers/session");
-const console_1 = require("../utils/console");
-class LoginCommand extends SessionCommand_1.default {
-    async init() {
-        const { flags } = this.parse(LoginCommand);
-        await this.initSession(flags);
-    }
-    async run() {
-        /* const {flags, args} = */ this.parse(LoginCommand);
-        try {
-            await session_1.default.login();
-        }
-        catch (error) {
-            console_1.default.error("Error trying to authenticate");
-            console_1.default.error(error.message || error);
-        }
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SessionCommand_1 = require("../utils/SessionCommand");
+const session_1 = require("../managers/session");
+const console_1 = require("../utils/console");
+class LoginCommand extends SessionCommand_1.default {
+    async init() {
+        const { flags } = this.parse(LoginCommand);
+        await this.initSession(flags);
+    }
+    async run() {
+        /* const {flags, args} = */ this.parse(LoginCommand);
+        try {
+            await session_1.default.login();
+        }
+        catch (error) {
+            console_1.default.error("Error trying to authenticate");
+            console_1.default.error(error.message || error);
+        }
+    }
+}
 LoginCommand.description = `Describe the command here
   ...
   Extra documentation goes here
-  `;
-LoginCommand.flags = {
-// name: flags.string({char: 'n', description: 'name to print'}),
-};
-LoginCommand.args = [
-    {
-        name: "package",
-        required: false,
-        description: "The unique string that identifies this package on learnpack",
-        hidden: false,
-    },
-];
-exports.default = LoginCommand;
+  `;
+LoginCommand.flags = {
+// name: flags.string({char: 'n', description: 'name to print'}),
+};
+LoginCommand.args = [
+    {
+        name: "package", // name of arg to show in help and reference with args[name]
+        required: false, // make the arg required with `required: true`
+        description: "The unique string that identifies this package on learnpack", // help description
+        hidden: false, // hide this arg from help
+    },
+];
+exports.default = LoginCommand;

package/lib/commands/logout.d.ts

@@ -1,14 +1,14 @@
-import SessionCommand from "../utils/SessionCommand";
-declare class LogoutCommand extends SessionCommand {
-    static description: string;
-    static flags: any;
-    static args: {
-        name: string;
-        required: boolean;
-        description: string;
-        hidden: boolean;
-    }[];
-    init(): Promise<void>;
-    run(): Promise<void>;
-}
-export default LogoutCommand;
+import SessionCommand from "../utils/SessionCommand";
+declare class LogoutCommand extends SessionCommand {
+    static description: string;
+    static flags: any;
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+        hidden: boolean;
+    }[];
+    init(): Promise<void>;
+    run(): Promise<void>;
+}
+export default LogoutCommand;