@learnpack/learnpack 5.0.29 → 5.0.31

package/src/managers/file.ts

@@ -123,7 +123,7 @@ export const download = (url: string, dest: string) => {
         })
         file.on("error", err => {
           file.close()
-          if (err.code === "EEXIST") {
+          if (err.name === "EEXIST") {
             Console.debug("File already exists")
             resolve("File already exists")
           } else {

package/src/managers/server/routes.ts

@@ -12,7 +12,9 @@ import { IConfigManager } from "../../models/config-manager"
 import { IExercise } from "../../models/exercise-obj"
 import SessionManager from "../../managers/session"
 import TelemetryManager from "../telemetry"
-import { eventManager } from "../../utils/osOperations"
+import { saveTranslatedReadme } from "../../utils/creatorUtilities"
+import { translateExercise } from "../../utils/rigoActions"
+// import { eventManager } from "../../utils/osOperations"
 
 const withHandler =
   (func: (req: express.Request, res: express.Response) => void) =>
@@ -381,6 +383,106 @@ throw new Error("File not found: " + filePath)
     })
   )
 
+  app.delete(
+    "/exercise/:slug/delete",
+    withHandler(async (req: express.Request, res: express.Response) => {
+      const exerciseDeleted = configManager.deleteExercise(req.params.slug)
+      if (exerciseDeleted) {
+        configManager.buildIndex()
+        res.json({ status: "ok" })
+      } else {
+        res.status(500).json({ error: "Failed to delete exercise" })
+      }
+    })
+  )
+
+  app.post(
+    "/actions/translate",
+    jsonBodyParser,
+    withHandler(async (req: express.Request, res: express.Response) => {
+      const { exerciseSlugs, languages } = req.body
+
+      const session = await SessionManager.getPayload()
+      const rigoToken = session?.rigobot?.key
+
+      if (!rigoToken) {
+        return res.status(400).json({ error: "RigoToken not found" })
+      }
+
+      const languagesToTranslate: string[] = languages.split(",")
+
+      try {
+        await Promise.all(
+          exerciseSlugs.map(async (slug: string) => {
+            const exercise = configManager.getExercise(slug)
+            if (!exercise) {
+              throw new Error(`Exercise ${slug} not found`)
+            }
+
+            if (exercise.getReadme) {
+              const readme = exercise.getReadme(null)
+
+              await Promise.all(
+                languagesToTranslate.map(async (language: string) => {
+                  const response = await translateExercise(rigoToken, {
+                    text_to_translate: readme.body,
+                    output_language: language,
+                  })
+
+                  await saveTranslatedReadme(
+                    slug,
+                    response.parsed.output_language_code,
+                    response.parsed.translation
+                  )
+
+                  Console.success(
+                    `Translated ${slug} to ${language} successfully`
+                  )
+                })
+              )
+            }
+          })
+        )
+
+        configManager.buildIndex()
+
+        return res.status(200).json({ message: "Translated exercises" })
+      } catch (error) {
+        console.log(error, "ERROR")
+        return res.status(400).json({ error: (error as Error).message })
+      }
+    })
+  )
+
+  app.post(
+    "/exercise/:slug/create",
+    jsonBodyParser,
+    withHandler(async (req: express.Request, res: express.Response) => {
+      const { title, readme, language } = req.body
+      const { slug } = req.params
+
+      if (!title || !readme || !language) {
+        return res.status(400).json({ error: "Missing required fields" })
+      }
+
+      try {
+        const exerciseCreated = await configManager.createExercise(
+          slug,
+          readme,
+          language
+        )
+        if (exerciseCreated) {
+          configManager.buildIndex()
+          res.json({ status: "ok" })
+        } else {
+          res.status(500).json({ error: "Failed to create exercise" })
+        }
+      } catch {
+        res.status(500).json({ error: "Failed to create exercise" })
+      }
+    })
+  )
+
   const textBodyParser = bodyParser.text()
   app.put(
     "/exercise/:slug/file/:fileName",

package/src/managers/session.ts

@@ -163,6 +163,10 @@ const Session: ISession = {
     }
   },
   destroy: async function () {
+    if (!this.sessionStarted) {
+      await this.initialize()
+    }
+
     await storage.clear()
     this.token = null
     Console.success("You have logged out")

package/src/models/config-manager.ts

@@ -1,23 +1,25 @@
-import { IConfigObj, TGrading } from "./config"
-import { IExercise } from "./exercise-obj"
-
-export interface IConfigManagerAttributes {
-  grading: TGrading;
-  disableGrading: boolean;
-  version: string;
-  mode?: string;
-}
-
-export interface IConfigManager {
-  validLanguages?: any;
-  get: () => IConfigObj;
-  clean: () => void;
-  getExercise: (slug: string | undefined) => IExercise;
-  startExercise: (slug: string) => IExercise;
-  reset: (slug: string) => void;
-  buildIndex: () => boolean | void;
-  watchIndex: (onChange: (...args: Array<any>) => void) => void;
-  save: () => void;
-  noCurrentExercise: () => void;
-  getAllExercises: () => IExercise[];
-}
+import { IConfigObj, TGrading } from "./config"
+import { IExercise } from "./exercise-obj"
+
+export interface IConfigManagerAttributes {
+  grading: TGrading
+  disableGrading: boolean
+  version: string
+  mode?: string
+}
+
+export interface IConfigManager {
+  validLanguages?: any
+  get: () => IConfigObj
+  clean: () => void
+  getExercise: (slug: string | undefined) => IExercise
+  startExercise: (slug: string) => IExercise
+  reset: (slug: string) => void
+  createExercise: (slug: string, content: string, language: string) => boolean
+  deleteExercise: (slug: string) => boolean
+  buildIndex: () => boolean | void
+  watchIndex: (onChange: (...args: Array<any>) => void) => void
+  save: () => void
+  noCurrentExercise: () => void
+  getAllExercises: () => IExercise[]
+}

package/src/utils/console.ts

@@ -1,24 +1,24 @@
-import * as chalk from "chalk"
-
-export default {
-  // _debug: true,
-  _debug: process.env.DEBUG === "true",
-  startDebug: function () {
-    this._debug = true
-  },
-  log: (msg: string | Array<string>, ...args: Array<any>) =>
-    console.log(chalk.gray(msg), ...args),
-  error: (msg: string, ...args: Array<any>) =>
-    console.log(chalk.red("⨉ " + msg), ...args),
-  success: (msg: string, ...args: Array<any>) =>
-    console.log(chalk.green("✓ " + msg), ...args),
-  info: (msg: any, ...args: Array<any>) =>
-    console.log(chalk.blue("ⓘ " + msg), ...args),
-  help: (msg: string) =>
-    console.log(`${chalk.white.bold("⚠ help:")} ${chalk.white(msg)}`),
-  debug(...args: Array<any>) {
-    this._debug && console.log(chalk.magentaBright("⚠ debug: "), args)
-  },
-  warning: (msg: string) =>
-    console.log(`${chalk.yellow("⚠ warning:")} ${chalk.yellow(msg)}`),
-}
+import * as chalk from "chalk"
+
+export default {
+  // _debug: true,
+  _debug: process.env.DEBUG === "true",
+  startDebug: function () {
+    this._debug = true
+  },
+  log: (msg: string | Array<string>, ...args: Array<any>) =>
+    console.log(chalk.gray(msg), ...args),
+  error: (msg: string, ...args: Array<any>) =>
+    console.log(chalk.red("⨉ " + msg), ...args),
+  success: (msg: string, ...args: Array<any>) =>
+    console.log(chalk.green("✓ " + msg), ...args),
+  info: (msg: any, ...args: Array<any>) =>
+    console.log(chalk.blue("ⓘ " + msg), ...args),
+  help: (msg: string) =>
+    console.log(`${chalk.white.bold("⚠ help:")} ${chalk.white(msg)}`),
+  debug(...args: Array<any>) {
+    this._debug && console.log(chalk.magentaBright("⚠ debug: "), args)
+  },
+  warning: (msg: string) =>
+    console.log(`${chalk.yellow("⚠ warning:")} ${chalk.yellow(msg)}`),
+}

package/src/utils/creatorUtilities.ts

@@ -1,5 +1,6 @@
-// eslint-disable-next-line
+
 const frontMatter = require("front-matter")
+
 import * as path from "path"
 import * as fs from "fs"
 import { homedir } from "os"
@@ -61,11 +62,13 @@ export function checkReadingTime(
   exceedsThreshold: boolean
   minutes: number
   body: string
+  // readingEase: number
 } {
   const parsed = frontMatter(markdown)
 
   const readingTime = estimateReadingTime(parsed.body, wordsPerMinute)
 
+  // const readingEase = estimateReadingEase(parsed.body)
   let attributes = parsed.attributes ? parsed.attributes : {}
 
   if (typeof parsed.attributes !== "object") {
@@ -75,6 +78,7 @@ export function checkReadingTime(
   const updatedAttributes = {
     ...attributes,
     readingTime,
+    // readingEase,
   }
 
   let yamlFrontMatter = ""
@@ -86,6 +90,7 @@ export function checkReadingTime(
       exceedsThreshold: false,
       minutes: 0,
       body: "",
+      // readingEase: 0,
     }
   }
 
@@ -97,6 +102,7 @@ export function checkReadingTime(
     exceedsThreshold: readingTime.minutes > maxMinutes,
     minutes: readingTime.minutes,
     body: parsed.body,
+    // readingEase: 0,
   }
 }
 
@@ -189,11 +195,13 @@ export function estimateDuration(listOfSteps: string[]): number {
 const writeFilePromise = promisify(fs.writeFile)
 const execPromise = promisify(exec)
 
-const example_content = `
-00.1 - Introduction to AI [READ: Small introduction to important concepts such as AI, machine learning, and their applications]
-01.1 - Introduction to Machine Learning [READ: Small introduction to important concepts such as AI, machine learning, and their applications]
-01.2 - Introduction to Deep Learning [QUIZ: Small introduction to important concepts such as AI, machine learning, and their applications]
-02.1 - Test your knowledge [CODE: Code problem to solve]
+const example_content = `Write or paste your table of content below this line, each topic should be defined on a new line, here is an example:
+
+Introduction to AI: Explain what is AI and its applications
+Introduction to Machine Learning: Explain what is machine learning and its applications
+What is an AI Model: Explain what is an AI model and its applications
+How to use an AI Model: Different APIs, local models, etc.
+How to build an AI Model: Fine-tuning, data collection, cleaning and more.
 `
 
 export async function createFileOnDesktop() {
@@ -239,3 +247,55 @@ export function getContentIndex() {
   const content = fs.readFileSync(filePath, "utf8")
   return content
 }
+
+// export function fleschKincaidReadingEase(text: string): number {
+//   const sentences = text.split(/[.!?]/).filter((s) => s.trim().length > 0)
+//   const words = text.split(/\s+/).filter((w) => w.trim().length > 0)
+//   const totalSyllables = words.reduce((sum, word) => sum + syllable(word), 0)
+
+//   const ASL = words.length / sentences.length // Average Sentence Length
+//   const ASW = totalSyllables / words.length // Average Syllables per Word
+
+//   return Math.round(206.835 - 1.015 * ASL - 84.6 * ASW)
+// }
+
+export function extractTextFromMarkdown(mdContent: string): string {
+  let content = mdContent.replace(/!\[.*?]\(.*?\)/g, "")
+  content = content.replace(/\[.*?]\(.*?\)/g, "")
+  content = content.replace(/`.*?`/g, "")
+  content = content.replace(/```[\S\s]*?```/g, "")
+
+  return content.trim()
+}
+
+// export const estimateReadingEase = async (text: string): Promise<number> => {
+//   const cleanedText = extractTextFromMarkdown(text)
+//   // @ts-ignore
+//   const rs = (await import("text-readability")).default;
+//   // return fleschKincaidReadingEase(cleanedText)
+//   // const score = readability(cleanedText)
+//   // console.log(score)
+//   // return score.fleschKincaid ?? 0
+//   const score = rs.fleschReadingEase(cleanedText)
+//   console.log(score, "SCORE FLESCH READING EASE")
+//   return score
+// }
+
+const cleanReadme = (readme: string) => {
+  // Replace <text> and </text> with nothing
+  return readme.replace(/<text>/g, "").replace(/<\/text>/g, "")
+}
+
+export 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))
+}

package/src/utils/rigoActions.ts

@@ -62,7 +62,7 @@ return false
     Console.debug("The user is a creator! 🎉")
     return true
   } catch (error) {
-    Console.debug(error)
+    Console.error(error as string)
     return false
   }
 }
@@ -323,3 +323,15 @@ export async function reduceReadme(
     return null
   }
 }
+
+export const isValidRigoToken = async (rigobotToken: string) => {
+  const rigoUrl = `${RIGOBOT_HOST}/v1/auth/token/${rigobotToken}`
+  const rigoResp = await fetch(rigoUrl)
+  if (!rigoResp.ok) {
+    Console.debug("Invalid Rigobot token", rigoResp.status)
+    Console.debug(rigoResp.statusText)
+    return false
+  }
+
+  return true
+}

package/src/utils/templates/incremental/.github/workflows/learnpack-audit.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Learnpack audit
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install @learnpack/learnpack@latest -g
+    - run: learnpack audit

package/src/utils/templates/isolated/.github/workflows/learnpack-audit.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Learnpack audit
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install @learnpack/learnpack@latest -g
+    - run: learnpack audit