@learnpack/learnpack 2.1.0 → 2.1.3

package/src/commands/init.ts

@@ -1,172 +1,172 @@
-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 Console from "../utils/console";
-import { ValidationError } from "../utils/errors";
-import defaults from "../managers/config/defaults";
-
-import * as path from "path";
-
-class InitComand extends BaseCommand {
-  static description =
-    "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);
-
-    // 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: string) => {
-          const n = Math.floor(Number(value));
-          return (
-            n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
-          );
-        },
-      },
-    ]);
-
-    const packageInfo = {
-      ...defaults.config,
-      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, ""),
-    };
-
-    cli.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 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}` : ""}`;
-      fs.writeFileSync(
-        `./${readmeFilename}.md`,
-        eta.render(
-          fs.readFileSync(
-            path.resolve(__dirname, `${templatesDir}/${readmeFilename}.ejs`),
-            "utf-8"
-          ),
-          packageInfo
-        )
-      );
-      if (fs.existsSync(`./${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));
-
-    cli.action.stop();
-    Console.success(`😋 Package initialized successfully`);
-    Console.help(
-      `Start the exercises by running the following command on your terminal: $ learnpack start`
-    );
-  }
-}
-
-const alreadyInitialized = () =>
-  new Promise((resolve, reject) => {
-    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);
-      } 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);
-    });
-  });
-
-export default InitComand;
+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 Console from "../utils/console";
+import { ValidationError } from "../utils/errors";
+import defaults from "../managers/config/defaults";
+
+import * as path from "path";
+
+class InitComand extends BaseCommand {
+  static description =
+    "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);
+
+    // 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: string) => {
+          const n = Math.floor(Number(value));
+          return (
+            n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
+          );
+        },
+      },
+    ]);
+
+    const packageInfo = {
+      ...defaults.config,
+      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, ""),
+    };
+
+    cli.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 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}` : ""}`;
+      fs.writeFileSync(
+        `./${readmeFilename}.md`,
+        eta.render(
+          fs.readFileSync(
+            path.resolve(__dirname, `${templatesDir}/${readmeFilename}.ejs`),
+            "utf-8"
+          ),
+          packageInfo
+        )
+      );
+      if (fs.existsSync(`./${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));
+
+    cli.action.stop();
+    Console.success(`😋 Package initialized successfully`);
+    Console.help(
+      `Start the exercises by running the following command on your terminal: $ learnpack start`
+    );
+  }
+}
+
+const alreadyInitialized = () =>
+  new Promise((resolve, reject) => {
+    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);
+      } 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);
+    });
+  });
+
+export default InitComand;

package/src/managers/config/defaults.ts

@@ -1,33 +1,34 @@
-export default {
-  config: {
-    port: 3000,
-    editor: {
-      mode: null, // [standalone, preview]
-      agent: null, // [vscode, theia]
-      version: null,
-    },
-    dirPath: './.learn',
-    configPath: './learn.json',
-    outputPath: './.learn/dist',
-    publicPath: '/preview',
-    publicUrl: null,
-    language: 'auto',
-    grading: 'isolated', // [isolated, incremental]
-    exercisesPath: './', // path to the folder that contains the exercises
-    webpackTemplate: null, // if you want webpack to use an HTML template
-    disableGrading: false,
-    disabledActions: [], // Possible: 'build', 'test' or 'reset'
-    actions: [], // ⚠️ deprecated, leave empty )
-    entries: {
-      html: 'index.html',
-      vanillajs: 'index.js',
-      react: 'app.jsx',
-      node: 'app.js',
-      python3: 'app.py',
-      java: 'app.java',
-    },
-  },
-  address: 'http://localhost',
-  currentExercise: null,
-  exercises: [],
-}
+export default {
+  config: {
+    port: 3000,
+    editor: {
+      mode: null, // [standalone, preview]
+      agent: null, // [vscode, gitpod, localhost]
+      version: null,
+    },
+    dirPath: "./.learn",
+    configPath: "./learn.json",
+    outputPath: "./.learn/dist",
+    publicPath: "/preview",
+    publicUrl: null,
+    language: "auto",
+    autoPlay: true,
+    grading: "isolated", // [isolated, incremental]
+    exercisesPath: "./", // path to the folder that contains the exercises
+    webpackTemplate: null, // if you want webpack to use an HTML template
+    disableGrading: false,
+    disabledActions: [], // Possible: 'build', 'test' or 'reset'
+    actions: [], // ⚠️ deprecated, leave empty )
+    entries: {
+      html: "index.html",
+      vanillajs: "index.js",
+      react: "app.jsx",
+      node: "app.js",
+      python3: "app.py",
+      java: "app.java",
+    },
+  },
+  address: "http://localhost",
+  currentExercise: null,
+  exercises: [],
+};

package/src/managers/config/index.ts

@@ -30,12 +30,7 @@ const chalk = require("chalk");
 /* exercise folder name standard */
 
 const getConfigPath = () => {
-  const possibleFileNames = [
-    "learn.json",
-    ".learn/learn.json",
-    "bc.json",
-    ".breathecode/bc.json",
-  ];
+  const possibleFileNames = ["learn.json", ".learn/learn.json"];
   const config = possibleFileNames.find(file => fs.existsSync(file)) || null;
   if (config && fs.existsSync(".breathecode"))
     return { config, base: ".breathecode" };
@@ -75,7 +70,6 @@ export default async ({
 
   if (confPath) {
     const bcContent = fs.readFileSync(confPath.config);
-
     let hiddenBcContent = {};
     if (fs.existsSync(confPath.base + "/config.json")) {
       hiddenBcContent = fs.readFileSync(confPath.base + "/config.json");
@@ -131,7 +125,6 @@ export default async ({
 
   // auto detect agent (if possible)
   if (shell.which("gp") && configObj && configObj.config) {
-    configObj.config.editor.agent = "gitpod";
     configObj.address = getGitpodAddress();
     configObj.config.publicUrl = `https://${
       configObj.config.port
@@ -144,8 +137,8 @@ export default async ({
     configObj.config.publicUrl = `${configObj.address}:${configObj.config.port}`;
 
   // Assign default editor mode if not set already
-  if (configObj.config && mode !== null) {
-    configObj.config.editor.mode = (mode as TMode) || ("vscode" as TMode);
+  if (configObj.config && !mode) {
+    configObj.config.editor.mode = mode as TMode;
   }
 
   if (configObj.config && !configObj.config.editor.mode)
@@ -160,7 +153,7 @@ configObj.config.editor.version = version;
       "https://raw.githubusercontent.com/learnpack/coding-ide/learnpack/package.json"
     );
     const packageJSON = await resp.json();
-    configObj.config.editor.version = packageJSON.version || "1.0.72";
+    configObj.config.editor.version = packageJSON.version || "1.0.73";
   }
 
   if (configObj.config) {

package/src/models/config.ts

@@ -54,6 +54,7 @@ export interface IConfig {
   exercisesPath: string;
   disableGrading: boolean; // TODO: Deprecate
   actions: Array<string>; // TODO: Deprecate
+  autoPlay: boolean;
   // TODO: nameExerciseValidation
   disabledActions?: Array<TConfigAction>;
   compiler: TCompiler;