@learnpack/learnpack 1.0.0

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

@@ -0,0 +1,25 @@
+# `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

@@ -0,0 +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.
+
+Type `$ learnpack start` in your terminal to start the exercises.

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

@@ -0,0 +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.
+
+Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

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

@@ -0,0 +1,27 @@
+# `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"
+---
+```

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

@@ -0,0 +1,27 @@
+# `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

@@ -0,0 +1,5 @@
+# Welcome to <%= it.title %>
+
+You have initialized the exercises with grading=`isolated`, that basically means that your students will completed one exercise after the other with new files every time.
+
+Type `$ learnpack start` in your terminal to start the exercises.

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

@@ -0,0 +1,5 @@
+# Bienvenido a <%= it.title %>
+
+Has inicializado los ejercicios con grading=`isolated`; lo que signigica que tus estudiantes completarán un ejercicio tras otro, en archivos nuevos cada vez.
+
+Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

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

@@ -0,0 +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.
+
+Type `$ learnpack start` in your terminal to start the exercises.

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

@@ -0,0 +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.
+
+Ejecuta `$ learnpack start` en la terminal para comenzar con los ejercicios.

package/src/utils/validators.js

@@ -0,0 +1,15 @@
+
+function validURL(str) {
+
+    if(!str || !str.includes("github.com")) return false;
+    
+    var 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);
+}
+
+module.exports = { validURL }

package/src/utils/watcher.js

@@ -0,0 +1,24 @@
+const chokidar = require('chokidar');
+const debounce = require('debounce');
+
+module.exports = (path) => new Promise((resolve, reject) => {
+  const watcher = chokidar.watch(path, {
+    ignored: (_path, _stats) => {
+      return _stats && !_stats.isDirectory();
+    },
+    persistent: true,
+    depth: 1,
+    ignoreInitial: true
+  });
+
+  const onChange = (eventname, filename) =>{
+    resolve(eventname, filename);
+  }
+  watcher.on('all', debounce(onChange, 500, true));
+  // watcher.on('all', onChange);
+
+  process.on('SIGINT', function() {
+      watcher.close();
+      process.exit();
+  });
+});