@learnpack/learnpack 5.0.6 → 5.0.8

package/src/commands/clean.ts

@@ -1,29 +1,29 @@
-// import {flags} from '@oclif/command'
-import Console from "../utils/console"
-import SessionCommand from "../utils/SessionCommand"
-
-class CleanCommand extends SessionCommand {
-  static description = `Clean the configuration object
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  async init() {
-    const { flags } = this.parse(CleanCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    const { flags } = this.parse(CleanCommand)
-
-    this.configManager?.clean()
-
-    Console.success("Package cleaned successfully, ready to publish")
-  }
-}
-
-export default CleanCommand
+// import {flags} from '@oclif/command'
+import Console from "../utils/console"
+import SessionCommand from "../utils/SessionCommand"
+
+class CleanCommand extends SessionCommand {
+  static description = `Clean the configuration object
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  async init() {
+    const { flags } = this.parse(CleanCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const { flags } = this.parse(CleanCommand)
+
+    this.configManager?.clean()
+
+    Console.success("Package cleaned successfully, ready to publish")
+  }
+}
+
+export default CleanCommand

package/src/commands/download.ts

@@ -1,61 +1,61 @@
-import { Command /* , flags */ } from "@oclif/command"
-// import fetch from 'node-fetch'
-import { clone } from "../managers/file"
-import Console from "../utils/console"
-import api from "../utils/api"
-import { askPackage } from "../ui/download"
-// const BaseCommand = require('../utils/BaseCommand');
-
-class DownloadCommand extends Command {
-  static description = `Describe the command here
-...
-Extra documentation goes here
-`
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-  // async init() {
-  //   const {flags} = this.parse(DownloadCommand)
-  //   await this.initSession(flags)
-  // }
-
-  async run() {
-    const { /* flags, */ args } = this.parse(DownloadCommand)
-    // start watching for file changes
-    let _package: string = args.package
-    if (!_package) {
-      _package = (await askPackage()) as string
-    }
-
-    if (!_package) {
-      return null
-    }
-
-    try {
-      const packageInfo = await api.getAllPackages({ slug: _package })
-      if (packageInfo.results.length === 0)
-        Console.error(`Package ${_package} not found`)
-      else
-        clone(packageInfo.results[0].repository)
-          .then(_result => {
-            Console.success("Successfully downloaded")
-            Console.info(
-              `You can now CD into the folder like this: $ cd ${_package}`
-            )
-          })
-          .catch(error => Console.error(error.message || error))
-    } catch {}
-  }
-}
-
-export default DownloadCommand
+import { Command /* , flags */ } from "@oclif/command"
+// import fetch from 'node-fetch'
+import { clone } from "../managers/file"
+import Console from "../utils/console"
+import api from "../utils/api"
+import { askPackage } from "../ui/download"
+// const BaseCommand = require('../utils/BaseCommand');
+
+class DownloadCommand extends Command {
+  static description = `Describe the command here
+...
+Extra documentation goes here
+`
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ]
+  // async init() {
+  //   const {flags} = this.parse(DownloadCommand)
+  //   await this.initSession(flags)
+  // }
+
+  async run() {
+    const { /* flags, */ args } = this.parse(DownloadCommand)
+    // start watching for file changes
+    let _package: string = args.package
+    if (!_package) {
+      _package = (await askPackage()) as string
+    }
+
+    if (!_package) {
+      return null
+    }
+
+    try {
+      const packageInfo = await api.getAllPackages({ slug: _package })
+      if (packageInfo.results.length === 0)
+        Console.error(`Package ${_package} not found`)
+      else
+        clone(packageInfo.results[0].repository)
+          .then(_result => {
+            Console.success("Successfully downloaded")
+            Console.info(
+              `You can now CD into the folder like this: $ cd ${_package}`
+            )
+          })
+          .catch(error => Console.error(error.message || error))
+    } catch {}
+  }
+}
+
+export default DownloadCommand

package/src/commands/init.ts

@@ -17,6 +17,7 @@ import {
   getExercisesNames,
   generateImage,
   downloadImage,
+  generateCourseIntroduction,
 } from "../utils/rigoActions"
 
 const slugify = (text: string) => {
@@ -52,6 +53,21 @@ function getFilenameFromUrl(url: string) {
   return path.basename(url)
 }
 
+async function createPreviewReadme(
+  tutorialDir: string,
+  packageInfo: PackageInfo,
+  rigoToken: string,
+  readmeContents: string[]
+) {
+  const readmeFilename = `README.md`
+
+  const readmeContent = await generateCourseIntroduction(rigoToken, {
+    course_title: packageInfo.title.us,
+    lessons_context: readmeContents.join("\n"),
+  })
+  fs.writeFileSync(path.join(tutorialDir, readmeFilename), readmeContent.answer)
+}
+
 type PackageInfo = {
   grading: string
   difficulty: string
@@ -213,6 +229,10 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
     "Images generated successfully! 🎉 Your tutorial will be ready soon!"
   )
 
+  Console.info("Creating preview readme...")
+
+  await createPreviewReadme(tutorialDir, packageInfo, rigoToken, readmeContents)
+
   return true
 }
 
@@ -334,18 +354,26 @@ class InitComand extends BaseCommand {
     // Creating README files
     for (const language of languages) {
       const readmeFilename = `README${language !== "en" ? `.${language}` : ""}`
-      const readmeTemplatePath = path.resolve(
-        templatesDir,
-        `${readmeFilename}.ejs`
-      )
-      const readmeContent = eta.render(
-        fs.readFileSync(readmeTemplatePath, "utf-8"),
-        packageInfo
-      )
-      fs.writeFileSync(
-        path.join(tutorialDir, `${readmeFilename}.md`),
-        readmeContent
-      )
+      // const readmeTemplatePath = path.resolve(
+      //   templatesDir,
+      //   `${readmeFilename}.ejs`
+      // )
+
+      // const readmeObject = {
+      //   title: packageInfo.title.us,
+      //   description: packageInfo.description.us,
+      //   grading: packageInfo.grading,
+      //   difficulty: packageInfo.difficulty,
+      //   duration: packageInfo.duration,
+      // }
+      // const readmeContent = eta.render(
+      //   fs.readFileSync(readmeTemplatePath, "utf-8"),
+      //   readmeObject
+      // )
+      // fs.writeFileSync(
+      //   path.join(tutorialDir, `${readmeFilename}.md`),
+      //   readmeContent
+      // )
       if (fs.existsSync(path.join(tutorialDir, `${readmeFilename}.ejs`)))
         fs.removeSync(path.join(tutorialDir, `${readmeFilename}.ejs`))
     }

package/src/commands/login.ts

@@ -1,42 +1,42 @@
-import SessionCommand from "../utils/SessionCommand"
-import SessionManager from "../managers/session"
-import Console from "../utils/console"
-
-class LoginCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(LoginCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    /* const {flags, args} = */ this.parse(LoginCommand)
-
-    try {
-      await SessionManager.login()
-    } catch (error) {
-      Console.error("Error trying to authenticate")
-      Console.error((error as TypeError).message || (error as string))
-    }
-  }
-}
-
-export default LoginCommand
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+import Console from "../utils/console"
+
+class LoginCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(LoginCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    /* const {flags, args} = */ this.parse(LoginCommand)
+
+    try {
+      await SessionManager.login()
+    } catch (error) {
+      Console.error("Error trying to authenticate")
+      Console.error((error as TypeError).message || (error as string))
+    }
+  }
+}
+
+export default LoginCommand

package/src/commands/logout.ts

@@ -1,43 +1,43 @@
-// import  {Command, flags} from '@oclif/command'
-// import { prompt } from "enquirer"
-// import fetch from 'node-fetch'
-import SessionCommand from "../utils/SessionCommand"
-import SessionManager from "../managers/session"
-// import Console from '../utils/console'
-// import { replace } from 'node-emoji'
-// import { validURL } from "../utils/validators"
-// const BaseCommand from '../utils/BaseCommand');
-
-class LogoutCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(LogoutCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    // const {flags, args} = this.parse(LogoutCommand)
-
-    SessionManager.destroy()
-  }
-}
-
-export default LogoutCommand
+// import  {Command, flags} from '@oclif/command'
+// import { prompt } from "enquirer"
+// import fetch from 'node-fetch'
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+// import Console from '../utils/console'
+// import { replace } from 'node-emoji'
+// import { validURL } from "../utils/validators"
+// const BaseCommand from '../utils/BaseCommand');
+
+class LogoutCommand extends SessionCommand {
+  static description = `Describe the command here
+  ...
+  Extra documentation goes here
+  `
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ]
+
+  async init() {
+    const { flags } = this.parse(LogoutCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    // const {flags, args} = this.parse(LogoutCommand)
+
+    SessionManager.destroy()
+  }
+}
+
+export default LogoutCommand

package/src/commands/test.ts

@@ -1,85 +1,85 @@
-import Console from "../utils/console"
-import SessionCommand from "../utils/SessionCommand"
-import socket from "../managers/socket"
-
-import createServer from "../managers/server"
-import ExercisesQueue from "../utils/exercisesQueue"
-import { IExercise } from "../models/exercise-obj"
-
-class TestCommand extends SessionCommand {
-  async init() {
-    const { flags } = this.parse(TestCommand)
-    await this.initSession(flags)
-  }
-
-  async run() {
-    const {
-      args: { exerciseSlug },
-    } = this.parse(TestCommand)
-
-    // Build exercises index
-    this.configManager?.buildIndex()
-
-    let exercises: IExercise[] | undefined = []
-
-    // test all exercises
-    !exerciseSlug ?
-      (exercises = this.configManager?.getAllExercises()) :
-      (exercises = [this.configManager!.getExercise(exerciseSlug)])
-
-    const exercisesQueue = new ExercisesQueue(exercises)
-
-    const configObject = this.configManager?.get()
-
-    let hasFailed = false
-    let failedTestsCount = 0
-    let successTestsCount = 0
-    const testsToRunCount = exercisesQueue.size()
-
-    configObject!.config!.testingFinishedCallback = ({ result }) => {
-      if (result === "failed") {
-        hasFailed = true
-        failedTestsCount++
-      } else {
-        successTestsCount++
-      }
-
-      if (exercisesQueue.isEmpty()) {
-        Console.info(
-          `${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`
-        )
-        Console.success(
-          `${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`
-        )
-        Console.error(
-          `${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`
-        )
-
-        process.exit(hasFailed ? 1 : 0)
-      } else {
-        exercisesQueue.pop()!.test!(this.config, config!, socket)
-      }
-    }
-
-    const config = configObject?.config
-
-    const server = await createServer(configObject!, this.configManager!, true)
-
-    socket.start(config!, server, true)
-
-    exercisesQueue.pop()!.test!(this.config, config!, socket)
-  }
-}
-
-TestCommand.description = `Test exercises`
-
-TestCommand.args = [
-  {
-    name: "exerciseSlug",
-    required: false,
-    description: "The name of the exercise to test",
-    hidden: false,
-  },
-]
-
-export default TestCommand
+import Console from "../utils/console"
+import SessionCommand from "../utils/SessionCommand"
+import socket from "../managers/socket"
+
+import createServer from "../managers/server"
+import ExercisesQueue from "../utils/exercisesQueue"
+import { IExercise } from "../models/exercise-obj"
+
+class TestCommand extends SessionCommand {
+  async init() {
+    const { flags } = this.parse(TestCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const {
+      args: { exerciseSlug },
+    } = this.parse(TestCommand)
+
+    // Build exercises index
+    this.configManager?.buildIndex()
+
+    let exercises: IExercise[] | undefined = []
+
+    // test all exercises
+    !exerciseSlug ?
+      (exercises = this.configManager?.getAllExercises()) :
+      (exercises = [this.configManager!.getExercise(exerciseSlug)])
+
+    const exercisesQueue = new ExercisesQueue(exercises)
+
+    const configObject = this.configManager?.get()
+
+    let hasFailed = false
+    let failedTestsCount = 0
+    let successTestsCount = 0
+    const testsToRunCount = exercisesQueue.size()
+
+    configObject!.config!.testingFinishedCallback = ({ result }) => {
+      if (result === "failed") {
+        hasFailed = true
+        failedTestsCount++
+      } else {
+        successTestsCount++
+      }
+
+      if (exercisesQueue.isEmpty()) {
+        Console.info(
+          `${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`
+        )
+        Console.success(
+          `${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`
+        )
+        Console.error(
+          `${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`
+        )
+
+        process.exit(hasFailed ? 1 : 0)
+      } else {
+        exercisesQueue.pop()!.test!(this.config, config!, socket)
+      }
+    }
+
+    const config = configObject?.config
+
+    const server = await createServer(configObject!, this.configManager!, true)
+
+    socket.start(config!, server, true)
+
+    exercisesQueue.pop()!.test!(this.config, config!, socket)
+  }
+}
+
+TestCommand.description = `Test exercises`
+
+TestCommand.args = [
+  {
+    name: "exerciseSlug",
+    required: false,
+    description: "The name of the exercise to test",
+    hidden: false,
+  },
+]
+
+export default TestCommand

package/src/index.ts

@@ -1 +1 @@
-export * from '@oclif/command'
+export * from '@oclif/command'

package/src/managers/config/allowed_files.ts

@@ -1,29 +1,29 @@
-const extensions = {
-  extensions: [
-    "py",
-    "java",
-    "py",
-    "ruby",
-    "html",
-    "css",
-    "htm",
-    "php", // images
-    "js",
-    "jsx",
-    "ts", // images
-    "sh",
-    "bash", // images
-    "json",
-    "yml",
-    "yaml",
-    "csv",
-    "xml", // file storage extensions
-    "txt",
-    "text",
-    "markdown",
-    "readme", // compressed files
-  ],
-  names: ["package.json", "package-lock.json"],
-}
-
-export default extensions
+const extensions = {
+  extensions: [
+    "py",
+    "java",
+    "py",
+    "ruby",
+    "html",
+    "css",
+    "htm",
+    "php", // images
+    "js",
+    "jsx",
+    "ts", // images
+    "sh",
+    "bash", // images
+    "json",
+    "yml",
+    "yaml",
+    "csv",
+    "xml", // file storage extensions
+    "txt",
+    "text",
+    "markdown",
+    "readme", // compressed files
+  ],
+  names: ["package.json", "package-lock.json"],
+}
+
+export default extensions