@learnpack/learnpack 5.0.30 → 5.0.32

package/src/managers/telemetry.ts

@@ -1,5 +1,6 @@
 import { IFile } from "../models/file"
 import API from "../utils/api"
+const packageInfo = require("../../package.json")
 import Console from "../utils/console"
 
 const fs = require("fs")
@@ -77,6 +78,7 @@ type TStudent = {
 
 export interface ITelemetryJSONSchema {
   telemetry_id?: string
+  version: string
   user_id?: number | string
   slug: string
   agent?: string
@@ -111,6 +113,7 @@ interface ITelemetryManager {
   user: TUser
   urls: TTelemetryUrls
   started: boolean
+  version: string
   salute: (message: string) => void
   start: (
     agent: string,
@@ -136,6 +139,7 @@ interface ITelemetryManager {
 const TelemetryManager: ITelemetryManager = {
   current: null,
   urls: {},
+  version: packageInfo.version,
   user: {
     token: "",
     id: "",
@@ -160,6 +164,8 @@ const TelemetryManager: ITelemetryManager = {
             this.current = {
               telemetry_id: createUUID(),
               slug: tutorialSlug,
+              version: `CLI:${this.version}`,
+              user_id: 0,
               agent,
               tutorial_started_at: Date.now(),
               last_interaction_at: Date.now(),
@@ -176,6 +182,10 @@ const TelemetryManager: ITelemetryManager = {
             this.user.id = this.current.user_id.toString()
           }
 
+          if (!this.current.version) {
+            this.current.version = `CLI:${this.version}`
+          }
+
           this.save()
 
           this.started = true

package/src/models/action.ts

@@ -1,12 +1,12 @@
-export type TAction =
-  | "test"
-  | "log"
-  | "reload"
-  | "ready"
-  | "clean"
-  | "ask"
-  | "file_change"
-  | "dialog"
-  | "session-refreshed"
-
-export type ICallback = (...agrs: any[]) => any
+export type TAction =
+  | "test"
+  | "log"
+  | "reload"
+  | "ready"
+  | "clean"
+  | "ask"
+  | "file_change"
+  | "dialog"
+  | "session-refreshed"
+
+export type ICallback = (...agrs: any[]) => any

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
+}