@learnpack/learnpack 2.1.25 → 2.1.26

package/src/utils/fileQueue.ts

@@ -1,198 +1,198 @@
-import logger from "../utils/console";
-import * as fs from "fs";
-// import em from "events"
-import * as XXH from "xxhashjs";
-
-// possible events to dispatch
-const events = {
-  START_EXERCISE: "start_exercise",
-  INIT: "initializing",
-  RUNNING: "configuration_loaded",
-  END: "connection_ended",
-  RESET_EXERCISE: "reset_exercise",
-  OPEN_FILES: "open_files",
-  OPEN_WINDOW: "open_window",
-  INSTRUCTIONS_CLOSED: "instructions_closed",
-};
-
-let options = {
-  path: null,
-  create: false,
-};
-let lastHash: any = null;
-let watcher: any = null; // subscribe to file and listen to changes
-let actions: any = null; // action queue
-
-const loadDispatcher = (opts: any) => {
-  actions = [{ name: "initializing", time: now() }];
-  logger.debug(`Loading from ${opts.path}`);
-
-  let exists = fs.existsSync(opts.path);
-  if (opts.create) {
-    if (exists) 
-actions.push({ name: "reset", time: now() });
-    fs.writeFileSync(opts.path, JSON.stringify(actions), { flag: "w" });
-    exists = true;
-  }
-
-  if (!exists)
-    throw new Error(`Invalid queue path, missing file at: ${opts.path}`);
-
-  let incomingActions = [];
-  try {
-    const content = fs.readFileSync(opts.path, "utf-8");
-    incomingActions = JSON.parse(content);
-    if (!Array.isArray(incomingActions)) 
-incomingActions = [];
-  } catch {
-    incomingActions = [];
-    logger.debug("Error loading VSCode Actions file");
-  }
-
-  logger.debug("Actions load ", incomingActions);
-  return incomingActions;
-};
-
-// eslint-disable-next-line
-const enqueue = (name: string, data: any | undefined = undefined) => {
-  if (!Object.values(events).includes(name)) {
-    logger.debug(`Invalid event ${name}`);
-    throw new Error(`Invalid action ${name}`);
-  }
-
-  if (!actions) 
-actions = [];
-
-  actions.push({ name, time: now(), data: data });
-  logger.debug(`EMIT -> ${name}:Exporting changes to ${options.path}`);
-
-  return fs.writeFileSync(options.path || "", JSON.stringify(actions));
-};
-
-const now = () => {
-  const hrTime = process.hrtime();
-  // eslint-disable-next-line
-  const htTime0 = hrTime[0] * 1000000;
-  return (htTime0 + hrTime[1]) / 1000;
-};
-
-const loadFile = (filePath: string) => {
-  if (!fs.existsSync(filePath))
-    throw new Error(`No queue.json file to load on ${filePath}`);
-
-  const content = fs.readFileSync(filePath, "utf8");
-  const newHash = XXH.h32(content, 0xAB_CD).toString(16);
-  const isUpdated = lastHash !== newHash;
-  lastHash = newHash;
-  const incomingActions = JSON.parse(content);
-  return { isUpdated, incomingActions };
-};
-
-const dequeue = () => {
-  // first time dequeue loads
-  if (!actions) 
-actions = [];
-
-  const { isUpdated, incomingActions } = loadFile(options.path || "");
-
-  if (!isUpdated) {
-    /**
-     * make sure no tasks are executed from the queue by matching both
-     * queues (the incoming with current one)
-     */
-    actions = incomingActions;
-    logger.debug(
-      `No new actions to process: ${actions.length}/${incomingActions.length}`
-    );
-    return null;
-  }
-
-  // do i need to reset actions to zero?
-  if (actions.length > 0 && actions[0].time !== incomingActions[0].time) {
-    actions = [];
-  }
-
-  const action = incomingActions[incomingActions.length - 1];
-  logger.debug("Dequeing action ", action);
-  actions.push(action);
-  return action;
-};
-
-const pull = (callback: (T: any) => any) => {
-  logger.debug("Pulling actions");
-  let incoming = dequeue();
-  while (incoming) {
-    callback(incoming);
-    incoming = dequeue();
-  }
-};
-
-const reset = (callback: (T?: any) => any) => {
-  logger.debug("Queue reseted");
-  actions = [];
-  if (fs.existsSync(options.path || "")) {
-    fs.writeFileSync(options.path || "", "[]");
-    callback();
-  }
-};
-
-const onPull = (callback: (T?: any) => any) => {
-  // eslint-disable-next-line
-  const chokidar = require("chokidar");
-
-  logger.debug("Starting to listen...");
-  try {
-    loadFile(options.path || "");
-  } catch {
-    logger.debug("No previoues queue file, waiting for it to be created...");
-  }
-
-  if (!watcher) {
-    logger.debug(`Watching ${options.path}`);
-    watcher = chokidar.watch(`${options.path}`, {
-      persistent: true,
-    });
-  } else 
-logger.debug("Already watching queue path");
-
-  watcher.on("add", () => pull(callback)).on("change", () => pull(callback));
-
-  return true;
-};
-
-const onReset = (callback: (T?: any) => any) => {
-  // eslint-disable-next-line
-  const chokidar = require("chokidar");
-
-  if (!watcher) {
-    logger.debug(`Watching ${options.path}`);
-    watcher = chokidar.watch(`${options.path}`, {
-      persistent: true,
-    });
-  }
-
-  watcher.on("unlink", () => reset(callback));
-
-  return true;
-};
-
-export default {
-  events,
-  dispatcher: (opts: any = {}) => {
-    if (!actions) {
-      options = { ...options, ...opts };
-      logger.debug("Initializing queue dispatcher", options);
-      actions = loadDispatcher(options);
-    }
-
-    return { enqueue, events };
-  },
-  listener: (opts: any = {}) => {
-    if (!actions) {
-      options = { ...options, ...opts };
-      logger.debug("Initializing queue listener", options);
-    }
-
-    return { onPull, onReset, events };
-  },
-};
+import logger from "../utils/console";
+import * as fs from "fs";
+// import em from "events"
+import * as XXH from "xxhashjs";
+
+// possible events to dispatch
+const events = {
+  START_EXERCISE: "start_exercise",
+  INIT: "initializing",
+  RUNNING: "configuration_loaded",
+  END: "connection_ended",
+  RESET_EXERCISE: "reset_exercise",
+  OPEN_FILES: "open_files",
+  OPEN_WINDOW: "open_window",
+  INSTRUCTIONS_CLOSED: "instructions_closed",
+};
+
+let options = {
+  path: null,
+  create: false,
+};
+let lastHash: any = null;
+let watcher: any = null; // subscribe to file and listen to changes
+let actions: any = null; // action queue
+
+const loadDispatcher = (opts: any) => {
+  actions = [{ name: "initializing", time: now() }];
+  logger.debug(`Loading from ${opts.path}`);
+
+  let exists = fs.existsSync(opts.path);
+  if (opts.create) {
+    if (exists) 
+actions.push({ name: "reset", time: now() });
+    fs.writeFileSync(opts.path, JSON.stringify(actions), { flag: "w" });
+    exists = true;
+  }
+
+  if (!exists)
+    throw new Error(`Invalid queue path, missing file at: ${opts.path}`);
+
+  let incomingActions = [];
+  try {
+    const content = fs.readFileSync(opts.path, "utf-8");
+    incomingActions = JSON.parse(content);
+    if (!Array.isArray(incomingActions)) 
+incomingActions = [];
+  } catch {
+    incomingActions = [];
+    logger.debug("Error loading VSCode Actions file");
+  }
+
+  logger.debug("Actions load ", incomingActions);
+  return incomingActions;
+};
+
+// eslint-disable-next-line
+const enqueue = (name: string, data: any | undefined = undefined) => {
+  if (!Object.values(events).includes(name)) {
+    logger.debug(`Invalid event ${name}`);
+    throw new Error(`Invalid action ${name}`);
+  }
+
+  if (!actions) 
+actions = [];
+
+  actions.push({ name, time: now(), data: data });
+  logger.debug(`EMIT -> ${name}:Exporting changes to ${options.path}`);
+
+  return fs.writeFileSync(options.path || "", JSON.stringify(actions));
+};
+
+const now = () => {
+  const hrTime = process.hrtime();
+  // eslint-disable-next-line
+  const htTime0 = hrTime[0] * 1000000;
+  return (htTime0 + hrTime[1]) / 1000;
+};
+
+const loadFile = (filePath: string) => {
+  if (!fs.existsSync(filePath))
+    throw new Error(`No queue.json file to load on ${filePath}`);
+
+  const content = fs.readFileSync(filePath, "utf8");
+  const newHash = XXH.h32(content, 0xAB_CD).toString(16);
+  const isUpdated = lastHash !== newHash;
+  lastHash = newHash;
+  const incomingActions = JSON.parse(content);
+  return { isUpdated, incomingActions };
+};
+
+const dequeue = () => {
+  // first time dequeue loads
+  if (!actions) 
+actions = [];
+
+  const { isUpdated, incomingActions } = loadFile(options.path || "");
+
+  if (!isUpdated) {
+    /**
+     * make sure no tasks are executed from the queue by matching both
+     * queues (the incoming with current one)
+     */
+    actions = incomingActions;
+    logger.debug(
+      `No new actions to process: ${actions.length}/${incomingActions.length}`
+    );
+    return null;
+  }
+
+  // do i need to reset actions to zero?
+  if (actions.length > 0 && actions[0].time !== incomingActions[0].time) {
+    actions = [];
+  }
+
+  const action = incomingActions[incomingActions.length - 1];
+  logger.debug("Dequeing action ", action);
+  actions.push(action);
+  return action;
+};
+
+const pull = (callback: (T: any) => any) => {
+  logger.debug("Pulling actions");
+  let incoming = dequeue();
+  while (incoming) {
+    callback(incoming);
+    incoming = dequeue();
+  }
+};
+
+const reset = (callback: (T?: any) => any) => {
+  logger.debug("Queue reseted");
+  actions = [];
+  if (fs.existsSync(options.path || "")) {
+    fs.writeFileSync(options.path || "", "[]");
+    callback();
+  }
+};
+
+const onPull = (callback: (T?: any) => any) => {
+  // eslint-disable-next-line
+  const chokidar = require("chokidar");
+
+  logger.debug("Starting to listen...");
+  try {
+    loadFile(options.path || "");
+  } catch {
+    logger.debug("No previoues queue file, waiting for it to be created...");
+  }
+
+  if (!watcher) {
+    logger.debug(`Watching ${options.path}`);
+    watcher = chokidar.watch(`${options.path}`, {
+      persistent: true,
+    });
+  } else 
+logger.debug("Already watching queue path");
+
+  watcher.on("add", () => pull(callback)).on("change", () => pull(callback));
+
+  return true;
+};
+
+const onReset = (callback: (T?: any) => any) => {
+  // eslint-disable-next-line
+  const chokidar = require("chokidar");
+
+  if (!watcher) {
+    logger.debug(`Watching ${options.path}`);
+    watcher = chokidar.watch(`${options.path}`, {
+      persistent: true,
+    });
+  }
+
+  watcher.on("unlink", () => reset(callback));
+
+  return true;
+};
+
+export default {
+  events,
+  dispatcher: (opts: any = {}) => {
+    if (!actions) {
+      options = { ...options, ...opts };
+      logger.debug("Initializing queue dispatcher", options);
+      actions = loadDispatcher(options);
+    }
+
+    return { enqueue, events };
+  },
+  listener: (opts: any = {}) => {
+    if (!actions) {
+      options = { ...options, ...opts };
+      logger.debug("Initializing queue listener", options);
+    }
+
+    return { onPull, onReset, events };
+  },
+};

package/src/utils/misc.ts

@@ -1,23 +1,23 @@
-export const prioritizeHTMLFile = (entryFiles: string[]) => {
-  let files = []
-
-  // Find the html file and put it as latest in the files array
-  // in order to keep the html file opened in vscode plugin
-  const index = entryFiles.findIndex(file => {
-    return /.*\.html$/.test(file)
-  })
-
-  if (index !== -1) {
-    for (const [i, entryFile] of entryFiles.entries()) {
-      if (i !== index) {
-        files.push(entryFile)
-      }
-    }
-
-    files.push(entryFiles[index])
-  } else {
-    files = entryFiles
-  }
-
-  return files
-}
+export const prioritizeHTMLFile = (entryFiles: string[]) => {
+  let files = []
+
+  // Find the html file and put it as latest in the files array
+  // in order to keep the html file opened in vscode plugin
+  const index = entryFiles.findIndex(file => {
+    return /.*\.html$/.test(file)
+  })
+
+  if (index !== -1) {
+    for (const [i, entryFile] of entryFiles.entries()) {
+      if (i !== index) {
+        files.push(entryFile)
+      }
+    }
+
+    files.push(entryFiles[index])
+  } else {
+    files = entryFiles
+  }
+
+  return files
+}

package/src/utils/templates/gitignore.txt

@@ -1,20 +1,20 @@
-# configuration and readme
-!.gitignore
-!.gitpod.yml
-!.gitpod.Dockerfile
-!learn.json
-!README.md
-
-# exercises
-!.learn/
-!.learn/*
-.learn/_app
-.learn/.session
-.learn/dist
-.learn/app.tar.gz
-.learn/config.json
-
-# python compiled files
-*.pyc
-__pycache__/
+# configuration and readme
+!.gitignore
+!.gitpod.yml
+!.gitpod.Dockerfile
+!learn.json
+!README.md
+
+# exercises
+!.learn/
+!.learn/*
+.learn/_app
+.learn/.session
+.learn/dist
+.learn/app.tar.gz
+.learn/config.json
+
+# python compiled files
+*.pyc
+__pycache__/
 .pytest_cache/

package/src/utils/templates/incremental/.learn/exercises/01-hello-world/README.es.md

@@ -1,24 +1,24 @@
-# `01` Hello World
-
-Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
-
-También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
-
-## Inserta videos
-
-Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
-
-Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
-tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
+# `01` Hello World
+
+Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
+
+También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
+
+## Inserta videos
+
+Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```

package/src/utils/templates/incremental/.learn/exercises/01-hello-world/README.md

@@ -1,24 +1,24 @@
-# `01` Hello World
-
-You can have just a README file and it will be like a page in a book, no code files.
-
-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` Hello World
+
+You can have just a README file and it will be like a page in a book, no code files.
+
+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/incremental/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/incremental/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/isolated/01-hello-world/README.es.md

@@ -1,26 +1,26 @@
-# `01` Primer Ejercicio
-
-Hemos creado este primer ejercicio como ejemplo. Lo puedes ubicar en la carpeta `./01-hello-world`.
-
-1. Cada ejercicio debe estar ubicado en carpetas separadas y debe tener un archivo README.md con las instrucciones del ejercicio escrito en markdown.
-2. Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
-3. También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
-
-## Inserta videos
-
-Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
-
-Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
-
-```markdown
----
-intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
-tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
----
-```
+# `01` Primer Ejercicio
+
+Hemos creado este primer ejercicio como ejemplo. Lo puedes ubicar en la carpeta `./01-hello-world`.
+
+1. Cada ejercicio debe estar ubicado en carpetas separadas y debe tener un archivo README.md con las instrucciones del ejercicio escrito en markdown.
+2. Puedes tener un archivo README el cual será como una página de un libro, sin archivos de código.
+3. También puedes agregar un archivo `README.[lenguaje].md` para traducciones, por ejemplo `README.es.md` para español.
+
+## Inserta videos
+
+Si quieres incluir algún video introductorio para cada ejercicio, agrega la propiedad `intro` en el inicio del README.md para ese ejercicio en particular:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```
+
+Tambien puedes agregar un video explicando la solución para cada ejercicio agregando la propiedad `tutorial` al inicio del markdown del README.md correspondiente:
+
+```markdown
+---
+intro: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+tutorial: "https://www.youtube.com/watch?v=YkgkThdzX-8"
+---
+```