@learnpack/learnpack 5.0.28 → 5.0.30

package/src/managers/config/index.ts

@@ -469,6 +469,7 @@ fs.unlinkSync(_path)
         }
       }
     },
+
     buildIndex: function () {
       Console.info("Building the exercise index...")
 
@@ -511,6 +512,31 @@ fs.mkdirSync(confPath.base)
           [exercise(configObj?.config?.exercisesPath || "", 0, configObj)]
       this.save()
     },
+    createExercise: (slug: string, content: string, language: string) => {
+      try {
+        const dirPath = `${configObj.config?.exercisesPath}/${slug}`
+        if (!fs.existsSync(dirPath)) 
+fs.mkdirSync(dirPath, { recursive: true })
+        const isEnglish = language === "us" || language === "en"
+        const fileName = isEnglish ? "README.md" : `README.${language}.md`
+        fs.writeFileSync(`${dirPath}/${fileName}`, content)
+
+        return true
+      } catch (error) {
+        Console.error("Error creating exercise: ", error)
+        return false
+      }
+    },
+
+    deleteExercise: (slug: string) => {
+      const dirPath = `${configObj.config?.exercisesPath}/${slug}`
+      if (fs.existsSync(dirPath)) {
+        fs.rmSync(dirPath, { recursive: true, force: true })
+        return true
+      }
+
+      return false
+    },
     watchIndex: function (onChange: (filename: string) => void) {
       if (configObj.config && !configObj.config.exercisesPath)
         throw ValidationError(

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

@@ -279,9 +279,7 @@ throw new Error("File not found: " + filePath)
         TelemetryManager.registerStepEvent(exercise.position, "open_step", {})
       }
 
-      if (configObject.config?.editor.agent === "os") {
-        eventManager.enqueue(dispatcher.events.START_EXERCISE, exercise)
-      } else {
+      if (configObject.config?.editor.agent !== "os") {
         dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug)
       }
 
@@ -383,6 +381,48 @@ 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(
+    "/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/creatorUtilities.ts

@@ -1,147 +1,241 @@
-// eslint-disable-next-line
-const frontMatter = require("front-matter")
-import * as path from "path"
-
-import * as yaml from "js-yaml"
-
-type TEstimateReadingTimeReturns = {
-  minutes: number
-  words: number
-}
-
-export const estimateReadingTime = (
-  text: string,
-  wordsPerMinute = 150
-): TEstimateReadingTimeReturns => {
-  const words = text.trim().split(/\s+/).length
-  const minutes = words / wordsPerMinute
-
-  if (minutes < 1) {
-    if (words === 0)
-      return {
-        minutes: 1,
-        words,
-      }
-  } else {
-    return {
-      minutes,
-      words,
-    }
-  }
-
-  return {
-    minutes: 1,
-    words,
-  }
-}
-
-export type PackageInfo = {
-  grading: string
-  difficulty: string
-  duration: number
-  description: {
-    us: string
-  }
-  title: {
-    us: string
-  }
-}
-
-export function checkReadingTime(
-  markdown: string,
-  wordsPerMinute = 150
-): { newMarkdown: string; exceedsThreshold: boolean } {
-  const parsed = frontMatter(markdown)
-  const readingTime = estimateReadingTime(parsed.body, wordsPerMinute)
-  let attributes = parsed.attributes ? parsed.attributes : {}
-
-  if (typeof parsed.attributes !== "object") {
-    attributes = {}
-  }
-
-  const updatedAttributes = {
-    ...attributes,
-    readingTime,
-  }
-
-  // Convert the front matter back to a proper YAML string
-  const yamlFrontMatter = yaml.dump(updatedAttributes).trim()
-
-  // Reconstruct the markdown with the front matter
-  const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`
-
-  return {
-    newMarkdown,
-    exceedsThreshold: readingTime.minutes > wordsPerMinute,
-  }
-}
-
-const slugify = (text: string) => {
-  return text
-    .toString()
-    .normalize("NFD")
-    .replace(/[\u0300-\u036F]/g, "")
-    .toLowerCase()
-    .trim()
-    .replace(/\s+/g, "-")
-    .replace(/[^\w-]+/g, "")
-}
-
-export 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,
-  }
-}
-
-export function extractImagesFromMarkdown(markdown: string) {
-  const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g
-  const images = []
-  let match
-
-  while ((match = imageRegex.exec(markdown)) !== null) {
-    const altText = match[1]
-    const url = match[2]
-    images.push({ alt: altText, url: url })
-  }
-
-  return images
-}
-
-export function getFilenameFromUrl(url: string) {
-  return path.basename(url)
-}
-
-export const makePackageInfo = (choices: any) => {
-  const packageInfo = {
-    grading: choices.grading,
-    difficulty: choices.difficulty,
-    duration: parseInt(choices.duration),
-    description: {
-      us: choices.description,
-    },
-    title: {
-      us: choices.title,
-    },
-    slug: choices.title
-      .toLowerCase()
-      .replace(/ /g, "-")
-      .replace(/[^\w-]+/g, ""),
-  }
-  return packageInfo
-}
+// eslint-disable-next-line
+const frontMatter = require("front-matter")
+import * as path from "path"
+import * as fs from "fs"
+import { homedir } from "os"
+import { join } from "path"
+import { exec } from "child_process"
+import { promisify } from "util"
+
+import * as yaml from "js-yaml"
+
+type TEstimateReadingTimeReturns = {
+  minutes: number
+  words: number
+}
+
+export const estimateReadingTime = (
+  text: string,
+  wordsPerMinute = 150
+): TEstimateReadingTimeReturns => {
+  const words = text.trim().split(/\s+/).length
+  const minutes = words / wordsPerMinute
+
+  if (minutes < 1) {
+    if (words === 0)
+      return {
+        minutes: 1,
+        words,
+      }
+  } else {
+    return {
+      minutes,
+      words,
+    }
+  }
+
+  return {
+    minutes: 1,
+    words,
+  }
+}
+
+export type PackageInfo = {
+  grading: string
+  difficulty: string
+  duration: number
+  description: {
+    us: string
+  }
+  title: {
+    us: string
+  }
+}
+
+export function checkReadingTime(
+  markdown: string,
+  wordsPerMinute = 200,
+  maxMinutes = 1
+): {
+  newMarkdown: string
+  exceedsThreshold: boolean
+  minutes: number
+  body: string
+} {
+  const parsed = frontMatter(markdown)
+
+  const readingTime = estimateReadingTime(parsed.body, wordsPerMinute)
+
+  let attributes = parsed.attributes ? parsed.attributes : {}
+
+  if (typeof parsed.attributes !== "object") {
+    attributes = {}
+  }
+
+  const updatedAttributes = {
+    ...attributes,
+    readingTime,
+  }
+
+  let yamlFrontMatter = ""
+  try {
+    yamlFrontMatter = yaml.dump(updatedAttributes).trim()
+  } catch {
+    return {
+      newMarkdown: "",
+      exceedsThreshold: false,
+      minutes: 0,
+      body: "",
+    }
+  }
+
+  // Reconstruct the markdown with the front matter
+  const newMarkdown = `---\n${yamlFrontMatter}\n---\n\n${parsed.body}`
+
+  return {
+    newMarkdown,
+    exceedsThreshold: readingTime.minutes > maxMinutes,
+    minutes: readingTime.minutes,
+    body: parsed.body,
+  }
+}
+
+const slugify = (text: string) => {
+  return text
+    .toString()
+    .normalize("NFD")
+    .replace(/[\u0300-\u036F]/g, "")
+    .toLowerCase()
+    .trim()
+    .replace(/\s+/g, "-")
+    .replace(/[^\w-]+/g, "")
+}
+
+export 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,
+  }
+}
+
+export function extractImagesFromMarkdown(markdown: string) {
+  const imageRegex = /!\[([^\]]*)]\(([^)]+)\)/g
+  const images = []
+  let match
+
+  while ((match = imageRegex.exec(markdown)) !== null) {
+    const altText = match[1]
+    const url = match[2]
+    images.push({ alt: altText, url: url })
+  }
+
+  return images
+}
+
+export function getFilenameFromUrl(url: string) {
+  return path.basename(url)
+}
+
+export const makePackageInfo = (choices: any) => {
+  const packageInfo = {
+    grading: choices.grading,
+    difficulty: "beginner",
+    duration: 5,
+    description: {
+      us: choices.description,
+    },
+    title: {
+      us: choices.title,
+    },
+    slug: choices.title
+      .toLowerCase()
+      .replace(/ /g, "-")
+      .replace(/[^\w-]+/g, ""),
+  }
+  return packageInfo
+}
+
+export function estimateDuration(listOfSteps: string[]): number {
+  let duration = 0
+
+  for (const step of listOfSteps) {
+    if (step.includes("[READ:")) {
+      duration += 1
+    } else if (step.includes("[QUIZ:")) {
+      duration += 2
+    } else if (step.includes("[CODE:")) {
+      duration += 3
+    }
+  }
+
+  return duration
+}
+
+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]
+`
+
+export async function createFileOnDesktop() {
+  try {
+    const desktopPath = join(homedir(), "Desktop")
+    const filePath = join(desktopPath, "content_index.txt")
+
+    const content = example_content.trim()
+
+    await writeFilePromise(filePath, content)
+    console.log(`File created successfully at: ${filePath}`)
+
+    await openFile(filePath)
+  } catch (error) {
+    console.error("Error:", error)
+  }
+}
+
+async function openFile(filePath: string) {
+  const platform = process.platform
+  let command
+
+  if (platform === "win32") {
+    command = `start "" "${filePath}"`
+  } else if (platform === "darwin") {
+    command = `open "${filePath}"`
+  } else {
+    command = `xdg-open "${filePath}"`
+  }
+
+  try {
+    await execPromise(command)
+    console.log("File opened successfully.")
+  } catch (error) {
+    console.error("Error opening the file:", error)
+  }
+}
+
+export function getContentIndex() {
+  const desktopPath = join(homedir(), "Desktop")
+  const filePath = join(desktopPath, "content_index.txt")
+
+  const content = fs.readFileSync(filePath, "utf8")
+  return content
+}

package/src/utils/rigoActions.ts

@@ -293,3 +293,33 @@ export async function createPreviewReadme(
   })
   fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer)
 }
+
+// {"lesson": "The text of the lesson", "number_of_words": "Words lenght of the lesson", "expected_number_words": "The expected number of words"}
+
+type TReduceReadmeInputs = {
+  lesson: string
+  number_of_words: string
+  expected_number_words: string
+}
+export async function reduceReadme(
+  rigoToken: string,
+  inputs: TReduceReadmeInputs
+) {
+  try {
+    const response = await axios.post(
+      `${RIGOBOT_HOST}/v1/prompting/completion/588/`,
+      { inputs, include_purpose_objective: false, execute_async: false },
+      {
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: "Token " + rigoToken,
+        },
+      }
+    )
+
+    return response.data
+  } catch (error) {
+    Console.debug(error)
+    return null
+  }
+}

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