@learnpack/learnpack 2.1.25 → 2.1.27

package/src/commands/download.ts

@@ -1,62 +1,62 @@
-import { Command /* , flags */ } from "@oclif/command";
-// import fetch from 'node-fetch'
-import { clone } from "../managers/file";
-import Console from "../utils/console";
-import api from "../utils/api";
-import { askPackage } from "../ui/download";
-// const BaseCommand = require('../utils/BaseCommand');
-
-class DownloadCommand extends Command {
-  static description = `Describe the command here
-...
-Extra documentation goes here
-`;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  static 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
-    },
-  ];
-  // 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: string = args.package;
-    if (!_package) {
-      _package = (await askPackage()) as string;
-    }
-
-    if (!_package) {
-      return null;
-    }
-
-    try {
-      const packageInfo = await api.getAllPackages({ slug: _package });
-      if (packageInfo.results.length === 0)
-        Console.error(`Package ${_package} not found`);
-      else
-        clone(packageInfo.results[0].repository)
-          .then(_result => {
-            Console.success("Successfully downloaded");
-            Console.info(
-              `You can now CD into the folder like this: $ cd ${_package}`
-            );
-          })
-          .catch(error => Console.error(error.message || error));
-    } catch {}
-  }
-}
-
-export default DownloadCommand;
+import { Command /* , flags */ } from "@oclif/command"
+// import fetch from 'node-fetch'
+import { clone } from "../managers/file"
+import Console from "../utils/console"
+import api from "../utils/api"
+import { askPackage } from "../ui/download"
+// const BaseCommand = require('../utils/BaseCommand');
+
+class DownloadCommand extends Command {
+  static description = `Describe the command here
+...
+Extra documentation goes here
+`
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static 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
+    },
+  ]
+  // 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: string = args.package
+    if (!_package) {
+      _package = (await askPackage()) as string
+    }
+
+    if (!_package) {
+      return null
+    }
+
+    try {
+      const packageInfo = await api.getAllPackages({ slug: _package })
+      if (packageInfo.results.length === 0)
+        Console.error(`Package ${_package} not found`)
+      else
+        clone(packageInfo.results[0].repository)
+          .then(_result => {
+            Console.success("Successfully downloaded")
+            Console.info(
+              `You can now CD into the folder like this: $ cd ${_package}`
+            )
+          })
+          .catch(error => Console.error(error.message || error))
+    } catch {}
+  }
+}
+
+export default DownloadCommand

package/src/commands/init.ts

@@ -1,31 +1,31 @@
-import { flags } from "@oclif/command";
-import BaseCommand from "../utils/BaseCommand";
+import { flags } from "@oclif/command"
+import BaseCommand from "../utils/BaseCommand"
 
 // eslint-disable-next-line
 import * as fs from "fs-extra";
-import * as prompts from "prompts";
-import cli from "cli-ux";
-import * as eta from "eta";
+import * as prompts from "prompts"
+import cli from "cli-ux"
+import * as eta from "eta"
 
-import Console from "../utils/console";
-import { ValidationError } from "../utils/errors";
+import Console from "../utils/console"
+import { ValidationError } from "../utils/errors"
 
-import * as path from "path";
+import * as path from "path"
 
 class InitComand extends BaseCommand {
   static description =
-    "Create a new learning package: Book, Tutorial or Exercise";
+    "Create a new learning package: Book, Tutorial or Exercise"
 
   static flags = {
     ...BaseCommand.flags,
     grading: flags.help({ char: "h" }),
-  };
+  }
 
   async run() {
-    const { flags } = this.parse(InitComand);
+    const { flags } = this.parse(InitComand)
 
     // if the folder/file .learn or .breathecode aleady exists
-    await alreadyInitialized();
+    await alreadyInitialized()
 
     const choices = await prompts([
       {
@@ -76,13 +76,13 @@ class InitComand extends BaseCommand {
         initial: "1",
         message: "How many hours avg it takes to complete (number)?",
         validate: (value: string) => {
-          const n = Math.floor(Number(value));
+          const n = Math.floor(Number(value))
           return (
             n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
-          );
+          )
         },
       },
-    ]);
+    ])
 
     const packageInfo = {
       grading: choices.grading,
@@ -94,24 +94,24 @@ class InitComand extends BaseCommand {
         .toLowerCase()
         .replace(/ /g, "-")
         .replace(/[^\w-]+/g, ""),
-    };
+    }
 
-    cli.action.start("Initializing package");
+    cli.action.start("Initializing package")
 
-    const languages = ["en", "es"];
+    const languages = ["en", "es"]
 
     const templatesDir = path.resolve(
       __dirname,
       "../../src/utils/templates/" + choices.grading || "no-grading"
-    );
+    )
     if (!fs.existsSync(templatesDir))
-      throw ValidationError(`Template ${templatesDir} does not exists`);
-    await fs.copySync(templatesDir, "./");
+      throw ValidationError(`Template ${templatesDir} does not exists`)
+    await fs.copySync(templatesDir, "./")
 
     // Creating README files
     // eslint-disable-next-line
     languages.forEach((language) => {
-      const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`;
+      const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`
       fs.writeFileSync(
         `./${readmeFilename}.md`,
         eta.render(
@@ -121,23 +121,23 @@ class InitComand extends BaseCommand {
           ),
           packageInfo
         )
-      );
+      )
       if (fs.existsSync(`./${readmeFilename}.ejs`))
-        fs.removeSync(`./${readmeFilename}.ejs`);
-    });
+        fs.removeSync(`./${readmeFilename}.ejs`)
+    })
 
     if (!fs.existsSync("./.gitignore"))
       fs.copyFile(
         path.resolve(__dirname, "../../src/utils/templates/gitignore.txt"),
         "./.gitignore"
-      );
-    fs.writeFileSync("./learn.json", JSON.stringify(packageInfo, null, 2));
+      )
+    fs.writeFileSync("./learn.json", JSON.stringify(packageInfo, null, 2))
 
-    cli.action.stop();
-    Console.success(`😋 Package initialized successfully`);
+    cli.action.stop()
+    Console.success(`😋 Package initialized successfully`)
     Console.help(
       `Start the exercises by running the following command on your terminal: $ learnpack start`
-    );
+    )
   }
 }
 
@@ -146,25 +146,25 @@ const alreadyInitialized = () =>
     fs.readdir("./", function (err: any, files: any) {
       files = files.filter((f: any) =>
         [".learn", "learn.json", "bc.json", ".breathecode"].includes(f)
-      );
+      )
       if (err) {
-        reject(ValidationError(err.message));
-        throw ValidationError(err.message);
+        reject(ValidationError(err.message))
+        throw ValidationError(err.message)
       } else if (files.length > 0) {
         reject(
           ValidationError(
             "It seems the package is already initialized because we've found the following files: " +
               files.join(",")
           )
-        );
+        )
         throw ValidationError(
           "It seems the package is already initialized because we've found the following files: " +
             files.join(",")
-        );
+        )
       }
 
-      resolve(false);
-    });
-  });
+      resolve(false)
+    })
+  })
 
-export default InitComand;
+export default InitComand

package/src/commands/login.ts

@@ -1,42 +1,42 @@
-import SessionCommand from "../utils/SessionCommand";
-import SessionManager from "../managers/session";
-import Console from "../utils/console";
-
-class LoginCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  static 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
-    },
-  ];
-
-  async init() {
-    const { flags } = this.parse(LoginCommand);
-    await this.initSession(flags);
-  }
-
-  async run() {
-    /* const {flags, args} = */ this.parse(LoginCommand);
-
-    try {
-      await SessionManager.login();
-    } catch (error) {
-      Console.error("Error trying to authenticate");
-      Console.error((error as TypeError).message || (error as string));
-    }
-  }
-}
-
-export default LoginCommand;
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+import Console from "../utils/console"
+
+class LoginCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static 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
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(LoginCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    /* const {flags, args} = */ this.parse(LoginCommand)
+
+    try {
+      await SessionManager.login()
+    } catch (error) {
+      Console.error("Error trying to authenticate")
+      Console.error((error as TypeError).message || (error as string))
+    }
+  }
+}
+
+export default LoginCommand

package/src/commands/logout.ts

@@ -1,43 +1,43 @@
-// import  {Command, flags} from '@oclif/command'
-// import { prompt } from "enquirer"
-// import fetch from 'node-fetch'
-import SessionCommand from "../utils/SessionCommand";
-import SessionManager from "../managers/session";
-// import Console from '../utils/console'
-// import { replace } from 'node-emoji'
-// import { validURL } from "../utils/validators"
-// const BaseCommand from '../utils/BaseCommand');
-
-class LogoutCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  static 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
-    },
-  ];
-
-  async init() {
-    const { flags } = this.parse(LogoutCommand);
-    await this.initSession(flags);
-  }
-
-  async run() {
-    // const {flags, args} = this.parse(LogoutCommand)
-
-    SessionManager.destroy();
-  }
-}
-
-export default LogoutCommand;
+// import  {Command, flags} from '@oclif/command'
+// import { prompt } from "enquirer"
+// import fetch from 'node-fetch'
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+// import Console from '../utils/console'
+// import { replace } from 'node-emoji'
+// import { validURL } from "../utils/validators"
+// const BaseCommand from '../utils/BaseCommand');
+
+class LogoutCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static 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
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(LogoutCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    // const {flags, args} = this.parse(LogoutCommand)
+
+    SessionManager.destroy()
+  }
+}
+
+export default LogoutCommand

package/src/commands/publish.ts

@@ -1,107 +1,107 @@
-import { prompt } from "enquirer";
-import SessionCommand from "../utils/SessionCommand";
-import Console from "../utils/console";
-import api from "../utils/api";
-import { validURL } from "../utils/validators";
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-
-class PublishCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  static 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
-    },
-  ];
-
-  async init() {
-    const { flags } = this.parse(PublishCommand);
-    await this.initSession(flags, true);
-  }
-
-  async run() {
-    const { flags, args } = this.parse(PublishCommand);
-
-    // avoid annonymus sessions
-    // eslint-disable-next-line
-    if (!this.session) return;
-
-    Console.info(
-      `Session found for ${this.session.payload.email}, publishing the package...`
-    );
-
-    const configObject = this.configManager?.get();
-    if (
-      configObject?.config?.slug === undefined ||
-      !configObject.config?.slug
-    ) {
-      throw new Error(
-        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
-      );
-    }
-
-    if (!validURL(configObject?.config?.repository ?? "")) {
-      throw new Error(
-        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
-      );
-    } else {
-      const validateResp = await fetch(configObject.config?.repository, {
-        method: "HEAD",
-      });
-      if (!validateResp.ok || validateResp.status !== 200) {
-        throw new Error(
-          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
-        );
-      }
-    }
-
-    // start watching for file changes
-    try {
-      await api.publish({
-        ...configObject,
-        author: this.session.payload.user_id,
-      });
-      Console.success(
-        `Package updated and published successfully: ${configObject.config?.slug}`
-      );
-    } catch (error) {
-      if ((error as any).status === 404) {
-        const answer = await prompt([
-          {
-            type: "confirm",
-            name: "create",
-            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
-          },
-        ]);
-        if (answer) {
-          await api.update({
-            ...configObject,
-            author: this.session.payload.user_id,
-          });
-          Console.success(
-            `Package created and published successfully: ${configObject.config?.slug}`
-          );
-        } else {
-          Console.error("No answer from server");
-        }
-      } else {
-        Console.error((error as TypeError).message);
-      }
-    }
-  }
-}
-
-export default PublishCommand;
+import { prompt } from "enquirer"
+import SessionCommand from "../utils/SessionCommand"
+import Console from "../utils/console"
+import api from "../utils/api"
+import { validURL } from "../utils/validators"
+
+// eslint-disable-next-line
+const fetch = require("node-fetch");
+
+class PublishCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static 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
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(PublishCommand)
+    await this.initSession(flags, true)
+  }
+
+  async run() {
+    const { flags, args } = this.parse(PublishCommand)
+
+    // avoid annonymus sessions
+    // eslint-disable-next-line
+    if (!this.session) return;
+
+    Console.info(
+      `Session found for ${this.session.payload.email}, publishing the package...`
+    )
+
+    const configObject = this.configManager?.get()
+    if (
+      configObject?.config?.slug === undefined ||
+      !configObject.config?.slug
+    ) {
+      throw new Error(
+        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
+      )
+    }
+
+    if (!validURL(configObject?.config?.repository ?? "")) {
+      throw new Error(
+        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
+      )
+    } else {
+      const validateResp = await fetch(configObject.config?.repository, {
+        method: "HEAD",
+      })
+      if (!validateResp.ok || validateResp.status !== 200) {
+        throw new Error(
+          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
+        )
+      }
+    }
+
+    // start watching for file changes
+    try {
+      await api.publish({
+        ...configObject,
+        author: this.session.payload.user_id,
+      })
+      Console.success(
+        `Package updated and published successfully: ${configObject.config?.slug}`
+      )
+    } catch (error) {
+      if ((error as any).status === 404) {
+        const answer = await prompt([
+          {
+            type: "confirm",
+            name: "create",
+            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
+          },
+        ])
+        if (answer) {
+          await api.update({
+            ...configObject,
+            author: this.session.payload.user_id,
+          })
+          Console.success(
+            `Package created and published successfully: ${configObject.config?.slug}`
+          )
+        } else {
+          Console.error("No answer from server")
+        }
+      } else {
+        Console.error((error as TypeError).message)
+      }
+    }
+  }
+}
+
+export default PublishCommand