@learnpack/learnpack 5.0.30 → 5.0.31

package/src/commands/publish.ts

@@ -1,312 +1,312 @@
-/* eslint-disable arrow-parens */
-/* eslint-disable unicorn/no-array-for-each */
-import { execSync } from "child_process"
-import { flags } from "@oclif/command"
-import SessionCommand from "../utils/SessionCommand"
-import SessionManager from "../managers/session"
-import * as fs from "fs"
-import * as path from "path"
-import * as archiver from "archiver"
-import axios from "axios"
-import FormData = require("form-data")
-import Console from "../utils/console"
-import {
-  decompress,
-  downloadEditor,
-  checkIfDirectoryExists,
-} from "../managers/file"
-import api, { TAcademy } from "../utils/api"
-import * as prompts from "prompts"
-
-const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
-// const RIGOBOT_HOST =
-//   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
-const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
-
-const runAudit = () => {
-  try {
-    Console.info("Running learnpack audit before publishing...")
-    execSync("learnpack audit", { stdio: "inherit" })
-  } catch (error) {
-    Console.error("Failed to audit with learnpack")
-
-    // Si `execSync` lanza un error, capturamos el mensaje de error
-    if (error instanceof Error) {
-      Console.error(error.message)
-    } else {
-      Console.error("Unknown error occurred")
-    }
-
-    // Detener la ejecución del comando si `learnpack publish` falla
-    process.exit(1)
-  }
-
-  // Continuar con el proceso de build solo si `learnpack publish` fue exitoso
-  Console.info(
-    "Learnpack publish completed successfully. Proceeding with build..."
-  )
-}
-
-const selectAcademy = async (academies: TAcademy[]) => {
-  if (academies.length === 0) {
-    return null
-  }
-
-  if (academies.length === 1) {
-    return academies[0]
-  }
-
-  // prompts the user to  select an academy to upload the assets
-  Console.info("In which academy do you want to publish the asset?")
-  const response = await prompts({
-    type: "select",
-    name: "academy",
-    message: "Select an academy",
-    choices: academies.map((academy) => ({
-      title: academy.name,
-      value: academy,
-    })),
-  })
-  return response.academy
-}
-
-export default class BuildCommand extends SessionCommand {
-  static description =
-    "Builds the project by copying necessary files and directories into a zip file"
-
-  static flags = {
-    help: flags.help({ char: "h" }),
-  }
-
-  async init() {
-    const { flags } = this.parse(BuildCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    const buildDir = path.join(process.cwd(), "build")
-    // this.configManager?.clean()
-
-    const configObject = this.configManager?.get()
-
-    let sessionPayload = await SessionManager.getPayload()
-    if (
-      !sessionPayload ||
-      !sessionPayload.rigobot ||
-      (sessionPayload.token && !(await api.validateToken(sessionPayload.token)))
-    ) {
-      Console.error("You must be logged in to upload a LearnPack package")
-      try {
-        sessionPayload = await SessionManager.login()
-      } catch (error) {
-        Console.error("Error trying to authenticate")
-        Console.error((error as TypeError).message || (error as string))
-      }
-    }
-
-    const rigoToken = sessionPayload.rigobot.key
-
-    if (configObject) {
-      Console.info("Cleaning configuration files")
-      this.configManager?.clean()
-      // build exerises
-      runAudit()
-
-      Console.debug("Building exercises")
-      this.configManager?.buildIndex()
-    }
-
-    // const academies = await api.listUserAcademies(sessionPayload.token)
-    // // console.log(academies, "academies")
-    // const academy = await selectAcademy(academies)
-    // console.log(academy, "academy")
-
-    // Read learn.json to get the slug
-    const learnJsonPath = path.join(process.cwd(), "learn.json")
-    if (!fs.existsSync(learnJsonPath)) {
-      this.error("learn.json not found")
-    }
-
-    const learnJson = JSON.parse(fs.readFileSync(learnJsonPath, "utf-8"))
-
-    const zipFilePath = path.join(process.cwd(), `${learnJson.slug}.zip`)
-
-    // Ensure build directory exists
-    if (!fs.existsSync(buildDir)) {
-      fs.mkdirSync(buildDir)
-    }
-
-    if (configObject) {
-      const { config } = configObject
-      const appAlreadyExists = checkIfDirectoryExists(`${config?.dirPath}/_app`)
-
-      if (!appAlreadyExists) {
-        // download app and decompress
-        await downloadEditor(
-          config?.editor.version,
-          `${config?.dirPath}/app.tar.gz`
-        )
-
-        Console.info("Decompressing LearnPack UI, this may take a minute...")
-        await decompress(
-          `${config?.dirPath}/app.tar.gz`,
-          `${config?.dirPath}/_app/`
-        )
-      }
-    }
-
-    // Copy config.json
-    const configPath = path.join(process.cwd(), ".learn", "config.json")
-    if (fs.existsSync(configPath)) {
-      fs.copyFileSync(configPath, path.join(buildDir, "config.json"))
-    } else {
-      this.error("config.json not found")
-    }
-
-    // Copy .learn/assets directory, if it exists else create it
-    const assetsDir = path.join(process.cwd(), ".learn", "assets")
-    if (fs.existsSync(assetsDir)) {
-      this.copyDirectory(assetsDir, path.join(buildDir, ".learn", "assets"))
-    } else {
-      fs.mkdirSync(path.join(buildDir, ".learn", "assets"), { recursive: true })
-    }
-
-    // Copy .learn/_app directory files to the same level as config.json
-    const appDir = path.join(process.cwd(), ".learn", "_app")
-    if (fs.existsSync(appDir)) {
-      this.copyDirectory(appDir, buildDir)
-    } else {
-      this.error(".learn/_app directory not found")
-    }
-
-    // After copying the _app directory
-    const indexHtmlPath = path.join(appDir, "index.html")
-    const buildIndexHtmlPath = path.join(buildDir, "index.html")
-
-    if (fs.existsSync(indexHtmlPath)) {
-      let indexHtmlContent = fs.readFileSync(indexHtmlPath, "utf-8")
-
-      const description = learnJson.description.us || "LearnPack is awesome!"
-      const title =
-        learnJson.title.us || "LearnPack: Interactive Learning as a Service"
-
-      const previewUrl =
-        learnJson.preview ||
-        "https://raw.githubusercontent.com/learnpack/ide/refs/heads/master/public/learnpack.svg"
-      // Replace placeholders and the <title>Old title </title> tag for a new tag with the title
-      indexHtmlContent = indexHtmlContent
-        .replace(/{{description}}/g, description)
-        .replace(/<title>.*<\/title>/, `<title>${title}</title>`)
-        .replace(/{{title}}/g, title)
-        .replace(/{{preview}}/g, previewUrl)
-
-      // Write the modified content to the build directory
-      fs.writeFileSync(buildIndexHtmlPath, indexHtmlContent)
-    } else {
-      this.error("index.html not found in _app directory")
-    }
-
-    // Copy exercises directory
-    const exercisesDir = path.join(process.cwd(), "exercises")
-    const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
-
-    if (fs.existsSync(exercisesDir)) {
-      this.copyDirectory(exercisesDir, path.join(buildDir, "exercises"))
-    } else if (fs.existsSync(learnExercisesDir)) {
-      this.copyDirectory(learnExercisesDir, path.join(buildDir, "exercises"))
-    } else {
-      this.error("exercises directory not found in either location")
-    }
-
-    // Copy learn.json
-    fs.copyFileSync(learnJsonPath, path.join(buildDir, "learn.json"))
-
-    // Create zip file
-    const output = fs.createWriteStream(zipFilePath)
-    const archive = archiver("zip", {
-      zlib: { level: 9 },
-    })
-
-    output.on("close", async () => {
-      this.log(
-        `Build completed: ${zipFilePath} (${archive.pointer()} total bytes)`
-      )
-      // Remove build directory after zip is created
-
-      Console.debug("Zip file saved in project root")
-
-      const formData = new FormData()
-      formData.append("file", fs.createReadStream(zipFilePath))
-      formData.append("config", JSON.stringify(learnJson))
-
-      try {
-        const res = await axios.post(uploadZipEndpont, formData, {
-          headers: {
-            ...formData.getHeaders(),
-            Authorization: `Token ${rigoToken}`,
-          },
-        })
-        console.log(res.data)
-        // Remove the zip file after uploading
-        fs.unlinkSync(zipFilePath)
-        this.removeDirectory(buildDir)
-      } catch (error) {
-        if (axios.isAxiosError(error)) {
-          if (error.response && error.response.status === 403) {
-            console.error("Error 403:", error.response.data.error)
-          } else if (error.response && error.response.status === 400) {
-            console.error(error.response.data.error)
-          } else {
-            console.error("Error uploading file:", error)
-          }
-        } else {
-          console.error("Error uploading file:", error)
-        }
-
-        fs.unlinkSync(zipFilePath)
-        this.removeDirectory(buildDir)
-      }
-    })
-
-    archive.on("error", (err: any) => {
-      throw err
-    })
-
-    archive.pipe(output)
-    archive.directory(buildDir, false)
-    await archive.finalize()
-  }
-
-  copyDirectory(src: string, dest: string) {
-    if (!fs.existsSync(dest)) {
-      fs.mkdirSync(dest, { recursive: true })
-    }
-
-    const entries = fs.readdirSync(src, { withFileTypes: true })
-
-    for (const entry of entries) {
-      const srcPath = path.join(src, entry.name)
-      const destPath = path.join(dest, entry.name)
-
-      if (entry.isDirectory()) {
-        this.copyDirectory(srcPath, destPath)
-      } else {
-        fs.copyFileSync(srcPath, destPath)
-      }
-    }
-  }
-
-  removeDirectory(dir: string) {
-    if (fs.existsSync(dir)) {
-      fs.readdirSync(dir).forEach((file) => {
-        const currentPath = path.join(dir, file)
-        if (fs.lstatSync(currentPath).isDirectory()) {
-          this.removeDirectory(currentPath)
-        } else {
-          fs.unlinkSync(currentPath)
-        }
-      })
-      fs.rmdirSync(dir)
-    }
-  }
-}
+/* eslint-disable arrow-parens */
+/* eslint-disable unicorn/no-array-for-each */
+import { execSync } from "child_process"
+import { flags } from "@oclif/command"
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+import * as fs from "fs"
+import * as path from "path"
+import * as archiver from "archiver"
+import axios from "axios"
+import FormData = require("form-data")
+import Console from "../utils/console"
+import {
+  decompress,
+  downloadEditor,
+  checkIfDirectoryExists,
+} from "../managers/file"
+import api, { TAcademy } from "../utils/api"
+import * as prompts from "prompts"
+
+const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
+// const RIGOBOT_HOST =
+//   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
+const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
+
+const runAudit = () => {
+  try {
+    Console.info("Running learnpack audit before publishing...")
+    execSync("learnpack audit", { stdio: "inherit" })
+  } catch (error) {
+    Console.error("Failed to audit with learnpack")
+
+    // Si `execSync` lanza un error, capturamos el mensaje de error
+    if (error instanceof Error) {
+      Console.error(error.message)
+    } else {
+      Console.error("Unknown error occurred")
+    }
+
+    // Detener la ejecución del comando si `learnpack publish` falla
+    process.exit(1)
+  }
+
+  // Continuar con el proceso de build solo si `learnpack publish` fue exitoso
+  Console.info(
+    "Learnpack publish completed successfully. Proceeding with build..."
+  )
+}
+
+const selectAcademy = async (academies: TAcademy[]) => {
+  if (academies.length === 0) {
+    return null
+  }
+
+  if (academies.length === 1) {
+    return academies[0]
+  }
+
+  // prompts the user to  select an academy to upload the assets
+  Console.info("In which academy do you want to publish the asset?")
+  const response = await prompts({
+    type: "select",
+    name: "academy",
+    message: "Select an academy",
+    choices: academies.map((academy) => ({
+      title: academy.name,
+      value: academy,
+    })),
+  })
+  return response.academy
+}
+
+export default class BuildCommand extends SessionCommand {
+  static description =
+    "Builds the project by copying necessary files and directories into a zip file"
+
+  static flags = {
+    help: flags.help({ char: "h" }),
+  }
+
+  async init() {
+    const { flags } = this.parse(BuildCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const buildDir = path.join(process.cwd(), "build")
+    // this.configManager?.clean()
+
+    const configObject = this.configManager?.get()
+
+    let sessionPayload = await SessionManager.getPayload()
+    if (
+      !sessionPayload ||
+      !sessionPayload.rigobot ||
+      (sessionPayload.token && !(await api.validateToken(sessionPayload.token)))
+    ) {
+      Console.error("You must be logged in to upload a LearnPack package")
+      try {
+        sessionPayload = await SessionManager.login()
+      } catch (error) {
+        Console.error("Error trying to authenticate")
+        Console.error((error as TypeError).message || (error as string))
+      }
+    }
+
+    const rigoToken = sessionPayload.rigobot.key
+
+    if (configObject) {
+      Console.info("Cleaning configuration files")
+      this.configManager?.clean()
+      // build exerises
+      runAudit()
+
+      Console.debug("Building exercises")
+      this.configManager?.buildIndex()
+    }
+
+    // const academies = await api.listUserAcademies(sessionPayload.token)
+    // // console.log(academies, "academies")
+    // const academy = await selectAcademy(academies)
+    // console.log(academy, "academy")
+
+    // Read learn.json to get the slug
+    const learnJsonPath = path.join(process.cwd(), "learn.json")
+    if (!fs.existsSync(learnJsonPath)) {
+      this.error("learn.json not found")
+    }
+
+    const learnJson = JSON.parse(fs.readFileSync(learnJsonPath, "utf-8"))
+
+    const zipFilePath = path.join(process.cwd(), `${learnJson.slug}.zip`)
+
+    // Ensure build directory exists
+    if (!fs.existsSync(buildDir)) {
+      fs.mkdirSync(buildDir)
+    }
+
+    if (configObject) {
+      const { config } = configObject
+      const appAlreadyExists = checkIfDirectoryExists(`${config?.dirPath}/_app`)
+
+      if (!appAlreadyExists) {
+        // download app and decompress
+        await downloadEditor(
+          config?.editor.version,
+          `${config?.dirPath}/app.tar.gz`
+        )
+
+        Console.info("Decompressing LearnPack UI, this may take a minute...")
+        await decompress(
+          `${config?.dirPath}/app.tar.gz`,
+          `${config?.dirPath}/_app/`
+        )
+      }
+    }
+
+    // Copy config.json
+    const configPath = path.join(process.cwd(), ".learn", "config.json")
+    if (fs.existsSync(configPath)) {
+      fs.copyFileSync(configPath, path.join(buildDir, "config.json"))
+    } else {
+      this.error("config.json not found")
+    }
+
+    // Copy .learn/assets directory, if it exists else create it
+    const assetsDir = path.join(process.cwd(), ".learn", "assets")
+    if (fs.existsSync(assetsDir)) {
+      this.copyDirectory(assetsDir, path.join(buildDir, ".learn", "assets"))
+    } else {
+      fs.mkdirSync(path.join(buildDir, ".learn", "assets"), { recursive: true })
+    }
+
+    // Copy .learn/_app directory files to the same level as config.json
+    const appDir = path.join(process.cwd(), ".learn", "_app")
+    if (fs.existsSync(appDir)) {
+      this.copyDirectory(appDir, buildDir)
+    } else {
+      this.error(".learn/_app directory not found")
+    }
+
+    // After copying the _app directory
+    const indexHtmlPath = path.join(appDir, "index.html")
+    const buildIndexHtmlPath = path.join(buildDir, "index.html")
+
+    if (fs.existsSync(indexHtmlPath)) {
+      let indexHtmlContent = fs.readFileSync(indexHtmlPath, "utf-8")
+
+      const description = learnJson.description.us || "LearnPack is awesome!"
+      const title =
+        learnJson.title.us || "LearnPack: Interactive Learning as a Service"
+
+      const previewUrl =
+        learnJson.preview ||
+        "https://raw.githubusercontent.com/learnpack/ide/refs/heads/master/public/learnpack.svg"
+      // Replace placeholders and the <title>Old title </title> tag for a new tag with the title
+      indexHtmlContent = indexHtmlContent
+        .replace(/{{description}}/g, description)
+        .replace(/<title>.*<\/title>/, `<title>${title}</title>`)
+        .replace(/{{title}}/g, title)
+        .replace(/{{preview}}/g, previewUrl)
+
+      // Write the modified content to the build directory
+      fs.writeFileSync(buildIndexHtmlPath, indexHtmlContent)
+    } else {
+      this.error("index.html not found in _app directory")
+    }
+
+    // Copy exercises directory
+    const exercisesDir = path.join(process.cwd(), "exercises")
+    const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
+
+    if (fs.existsSync(exercisesDir)) {
+      this.copyDirectory(exercisesDir, path.join(buildDir, "exercises"))
+    } else if (fs.existsSync(learnExercisesDir)) {
+      this.copyDirectory(learnExercisesDir, path.join(buildDir, "exercises"))
+    } else {
+      this.error("exercises directory not found in either location")
+    }
+
+    // Copy learn.json
+    fs.copyFileSync(learnJsonPath, path.join(buildDir, "learn.json"))
+
+    // Create zip file
+    const output = fs.createWriteStream(zipFilePath)
+    const archive = archiver("zip", {
+      zlib: { level: 9 },
+    })
+
+    output.on("close", async () => {
+      this.log(
+        `Build completed: ${zipFilePath} (${archive.pointer()} total bytes)`
+      )
+      // Remove build directory after zip is created
+
+      Console.debug("Zip file saved in project root")
+
+      const formData = new FormData()
+      formData.append("file", fs.createReadStream(zipFilePath))
+      formData.append("config", JSON.stringify(learnJson))
+
+      try {
+        const res = await axios.post(uploadZipEndpont, formData, {
+          headers: {
+            ...formData.getHeaders(),
+            Authorization: `Token ${rigoToken}`,
+          },
+        })
+        console.log(res.data)
+        // Remove the zip file after uploading
+        fs.unlinkSync(zipFilePath)
+        this.removeDirectory(buildDir)
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          if (error.response && error.response.status === 403) {
+            console.error("Error 403:", error.response.data.error)
+          } else if (error.response && error.response.status === 400) {
+            console.error(error.response.data.error)
+          } else {
+            console.error("Error uploading file:", error)
+          }
+        } else {
+          console.error("Error uploading file:", error)
+        }
+
+        fs.unlinkSync(zipFilePath)
+        this.removeDirectory(buildDir)
+      }
+    })
+
+    archive.on("error", (err: any) => {
+      throw err
+    })
+
+    archive.pipe(output)
+    archive.directory(buildDir, false)
+    await archive.finalize()
+  }
+
+  copyDirectory(src: string, dest: string) {
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true })
+    }
+
+    const entries = fs.readdirSync(src, { withFileTypes: true })
+
+    for (const entry of entries) {
+      const srcPath = path.join(src, entry.name)
+      const destPath = path.join(dest, entry.name)
+
+      if (entry.isDirectory()) {
+        this.copyDirectory(srcPath, destPath)
+      } else {
+        fs.copyFileSync(srcPath, destPath)
+      }
+    }
+  }
+
+  removeDirectory(dir: string) {
+    if (fs.existsSync(dir)) {
+      fs.readdirSync(dir).forEach((file) => {
+        const currentPath = path.join(dir, file)
+        if (fs.lstatSync(currentPath).isDirectory()) {
+          this.removeDirectory(currentPath)
+        } else {
+          fs.unlinkSync(currentPath)
+        }
+      })
+      fs.rmdirSync(dir)
+    }
+  }
+}

package/src/commands/translate.ts

@@ -5,6 +5,7 @@ import * as prompts from "prompts"
 import { translateExercise } from "../utils/rigoActions"
 import SessionManager from "../managers/session"
 import Console from "../utils/console"
+import { saveTranslatedReadme } from "../utils/creatorUtilities"
 
 // This function list the names of the exercise directories inside the ./exercises folder, if the exercises folder doesn't exist, it will look for the ./.learn/exercises folder
 const listExercises = async () => {
@@ -24,11 +25,6 @@ const listExercises = async () => {
   })
 }
 
-const cleanReadme = (readme: string) => {
-  // Replace <text> and </text> with nothing
-  return readme.replace(/<text>/g, "").replace(/<\/text>/g, "")
-}
-
 const getReadmeForExercise = async (exercise: string) => {
   const readmePath = path.join(
     process.cwd(),
@@ -39,20 +35,6 @@ const getReadmeForExercise = async (exercise: string) => {
   return fs.readFileSync(readmePath, "utf8")
 }
 
-const saveTranslatedReadme = async (
-  exercise: string,
-  languageCode: string,
-  readme: string
-) => {
-  const readmePath = path.join(
-    process.cwd(),
-    "exercises",
-    exercise,
-    `README.${languageCode}.md`
-  )
-  fs.writeFileSync(readmePath, cleanReadme(readme))
-}
-
 export default class BuildCommand extends SessionCommand {
   static description =
     "List all the lessons, the user is able of select many of them to translate to the given languages"
@@ -118,7 +100,6 @@ export default class BuildCommand extends SessionCommand {
                 text_to_translate: readme,
                 output_language: language,
               })
-              console.log(response, "RESPONSE")
 
               await saveTranslatedReadme(
                 exercise,