@learnpack/learnpack 5.0.21 → 5.0.23

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.21","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}
+{"version":"5.0.23","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.21",
+  "version": "5.0.23",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/init.ts

@@ -13,13 +13,15 @@ import { ValidationError } from "../utils/errors"
 import * as path from "path"
 import {
   hasCreatorPermission,
-  createReadme,
-  getExercisesNames,
   generateImage,
   downloadImage,
   generateCourseIntroduction,
+  interactiveCreation,
+  createCodeFile,
+  readmeCreator,
 } from "../utils/rigoActions"
 import { getConsumables } from "../utils/api"
+
 const slugify = (text: string) => {
   return text
     .toString()
@@ -31,8 +33,26 @@ const slugify = (text: string) => {
     .replace(/[^\w-]+/g, "")
 }
 
-const getExNumber = (index: number) => {
-  return index < 10 ? `0${index}` : `${index}`
+const getExInfo = (title: string) => {
+  // Example title: '1.0 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]'
+  let [exNumber, exTitle] = title.split(" - ")
+
+  // Extract kind and description
+  const kindMatch = exTitle.match(/\[(.*?):(.*?)]/)
+  const kind = kindMatch ? kindMatch[1].trim().toLowerCase() : "read"
+  const description = kindMatch ? kindMatch[2].trim() : ""
+
+  exNumber = exNumber.trim()
+  // Clean title
+  exTitle = exTitle.replace(kindMatch?.[0] || "", "").trim()
+  exTitle = slugify(exTitle)
+
+  return {
+    exNumber,
+    kind,
+    description,
+    exTitle,
+  }
 }
 
 function extractImagesFromMarkdown(markdown: string) {
@@ -99,6 +119,47 @@ type PackageInfo = {
   }
 }
 
+const initializeInteractiveCreation = async (
+  rigoToken: string,
+  courseInfo: string
+): Promise<{
+  currentSteps: string[]
+  prevInteractions: string
+}> => {
+  let prevInteractions = ""
+  let isReady = false
+  let currentSteps = []
+  while (!isReady) {
+    // eslint-disable-next-line
+    const res = await interactiveCreation(rigoToken, {
+      courseInfo: courseInfo,
+      prevInteractions: prevInteractions,
+    })
+    currentSteps = res.parsed.listOfSteps
+    isReady = res.parsed.ready
+
+    if (!isReady) {
+      console.log(currentSteps)
+      Console.info(`AI: ${res.parsed.aiMessage}`)
+      prevInteractions += `\nAI: ${res.parsed.aiMessage}`
+      // eslint-disable-next-line
+      const userMessage = await prompts([
+        {
+          type: "text",
+          name: "userMessage",
+          message: "Your message: ",
+        },
+      ])
+      prevInteractions += `\nUser: ${userMessage.userMessage}`
+    }
+  }
+
+  return {
+    currentSteps,
+    prevInteractions,
+  }
+}
+
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   Console.info(
     "Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators"
@@ -158,26 +219,6 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   Console.success("🎉 Let's begin this learning journey!")
 
-  const aiChoices = await prompts([
-    {
-      type: "text",
-      name: "tutorialAbout",
-      message:
-        "What kind of tutorial do you want to create? Please expand a little on the content, the outcome and the goal of the tutorial",
-      initial: "",
-    },
-    {
-      type: "text",
-      name: "exercisesNumber",
-      message:
-        "How many steps or exercises do you want? Please provide a number",
-      validate: (value: string) => {
-        const n = Math.floor(Number(value))
-        return n !== Number.POSITIVE_INFINITY && String(n) === value && n > 0
-      },
-    },
-  ])
-
   const packageContext = `
   \n
   The following information comes from user inputs 
@@ -190,36 +231,33 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   Use it to generate more relevant exercises
   `
 
-  const inputs = {
-    tutorial_about: aiChoices.tutorialAbout + packageContext,
-    number_of_exercises: aiChoices.exercisesNumber,
-  }
-  Console.info("Creating lessons...")
-  const res = await getExercisesNames(rigoToken, inputs)
+  const { currentSteps } = await initializeInteractiveCreation(
+    rigoToken,
+    packageContext
+  )
 
   const exercisesDir = path.join(tutorialDir, "exercises")
   fs.ensureDirSync(exercisesDir)
 
-  for (const [index, exercise] of res.parsed.exercises.entries()) {
-    const exerciseDir = path.join(
-      exercisesDir,
-      `${getExNumber(index)}-${slugify(exercise)}`
-    )
+  Console.info("Creating lessons...")
+  for (const [index, exercise] of currentSteps.entries()) {
+    const { exNumber, exTitle } = getExInfo(exercise)
+    const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`)
     fs.ensureDirSync(exerciseDir)
   }
 
-  const exercisePromises = res.parsed.exercises.map(
+  const exercisePromises = currentSteps.map(
     async (exercise: any, index: number) => {
-      const exerciseDir = path.join(
-        exercisesDir,
-        `${getExNumber(index)}-${slugify(exercise)}`
-      )
+      const { exNumber, exTitle, kind, description } = getExInfo(exercise)
+      const exerciseDir = path.join(exercisesDir, `${exNumber}-${exTitle}`)
 
-      const readme = await createReadme(rigoToken, {
-        title: `\`${getExNumber(index)}\` ${exercise}`,
+      const readme = await readmeCreator(rigoToken, {
+        title: `${exNumber} - ${exTitle}`,
         output_lang: "en",
-        list_of_exercises: res.parsed.exercises.join(","),
-        tutorial_description: aiChoices.tutorialAbout,
+        list_of_exercises: currentSteps.join(","),
+        tutorial_description: packageContext,
+        lesson_description: description,
+        kind: kind.toLowerCase(),
       })
 
       const readmeFilename = "README.md"
@@ -228,6 +266,21 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
         path.join(exerciseDir, readmeFilename),
         readme.parsed.content
       )
+
+      if (kind.toLowerCase() === "code") {
+        const codeFile = await createCodeFile(rigoToken, {
+          readme: readme.parsed.content,
+        })
+
+        fs.writeFileSync(
+          path.join(
+            exerciseDir,
+            `app.${codeFile.parsed.extension.replace(".", "")}`
+          ),
+          codeFile.parsed.content
+        )
+      }
+
       return readme.parsed.content
     }
   )

package/src/commands/translate.ts

@@ -1,4 +1,3 @@
-import { getExercisesNames } from "../utils/rigoActions"
 import SessionCommand from "../utils/SessionCommand"
 import * as fs from "fs"
 import * as path from "path"