@learnpack/learnpack 5.0.14 → 5.0.16

package/package.json

@@ -1,152 +1,152 @@
-{
-  "name": "@learnpack/learnpack",
-  "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.14",
-  "author": "Alejandro Sanchez @alesanchezr",
-  "contributors": [
-    {
-      "name": "Alejandro Sanchez",
-      "url": "https://www.x.com/alesanchezr"
-    },
-    {
-      "name": "Charly Chacón",
-      "email": "charlyjchaconc@gmail.com",
-      "url": "https://www.linkedin.com/in/charlytoc/"
-    }
-  ],
-  "bin": {
-    "learnpack": "bin/run"
-  },
-  "bugs": {
-    "url": "https://github.com/learnpack/learnpack-cli/issues"
-  },
-  "dependencies": {
-    "@oclif/command": "^1.6.1",
-    "@oclif/config": "^1.15.1",
-    "@oclif/plugin-help": "^3.1.0",
-    "@oclif/plugin-plugins": "^1.8.0",
-    "@oclif/plugin-warn-if-update-available": "^1.7.0",
-    "@types/archiver": "^6.0.2",
-    "archiver": "^7.0.1",
-    "axios": "^1.7.7",
-    "body-parser": "^1.19.0",
-    "chalk": "^4.1.0",
-    "chokidar": "^3.4.0",
-    "cli-ux": "^5.4.6",
-    "debounce": "^1.2.0",
-    "dotenv": "^8.2.0",
-    "enquirer": "^2.3.6",
-    "eslint-plugin-unicorn": "^38.0.1",
-    "espree": "^9.3.2",
-    "eta": "^1.2.0",
-    "express": "^4.17.1",
-    "front-matter": "^4.0.2",
-    "moment": "^2.27.0",
-    "node-emoji": "^1.10.0",
-    "node-fetch": "^2.7.0",
-    "node-persist": "^3.1.0",
-    "prompts": "^2.3.2",
-    "shelljs": "^0.8.4",
-    "socket.io": "^4.4.1",
-    "targz": "^1.0.1",
-    "tslib": "^1",
-    "validator": "^13.1.1",
-    "xxhashjs": "^0.2.2"
-  },
-  "devDependencies": {
-    "@oclif/dev-cli": "^1.22.2",
-    "@oclif/test": "^1.2.6",
-    "@types/chai": "^4",
-    "@types/debounce": "^1.2.1",
-    "@types/express": "^4.17.13",
-    "@types/fs-extra": "^8.1.0",
-    "@types/mocha": "^5",
-    "@types/mock-fs": "^4.13.1",
-    "@types/node": "^10.17.60",
-    "@types/node-persist": "^3.1.2",
-    "@types/prompts": "^2.0.14",
-    "@types/shelljs": "^0.8.9",
-    "@types/socket.io": "^3.0.2",
-    "@types/targz": "^1.0.1",
-    "@types/validator": "^13.7.0",
-    "@types/xxhashjs": "^0.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
-    "chai": "^4.2.0",
-    "chai-http": "^4.3.0",
-    "eslint": "^8.12.0",
-    "eslint-config-oclif": "^4.0",
-    "eslint-config-oclif-typescript": "^1.0.2",
-    "fs-extra": "^10.0.1",
-    "globby": "^10.0.2",
-    "husky": ">=6",
-    "lint-staged": ">=10",
-    "mocha": "^5.2.0",
-    "mock-fs": "^5.1.2",
-    "nock": "^13.2.2",
-    "nyc": "^14.1.1",
-    "pre-commit": "^1.2.2",
-    "prettier": "^2.4.1",
-    "ts-node": "^8",
-    "typescript": "^5.6.2"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "files": [
-    "/bin",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json",
-    "/src",
-    "/lib"
-  ],
-  "homepage": "https://github.com/learnpack/learnpack-cli",
-  "keywords": [
-    "oclif"
-  ],
-  "license": "UNLICENSED",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "oclif": {
-    "commands": "./lib/commands",
-    "bin": "learnpack",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins",
-      "@oclif/plugin-warn-if-update-available"
-    ],
-    "permanent_plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins",
-      "@oclif/plugin-warn-if-update-available"
-    ]
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/learnpack/learnpack-cli.git"
-  },
-  "pre-commit": {
-    "silent": true,
-    "run": [
-      "pre"
-    ]
-  },
-  "scripts": {
-    "tsc": "tsc -b",
-    "postpack": "rm -f oclif.manifest.json && eslint . --ext .ts --config .eslintrc",
-    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "pre": "node ./test/precommit/index.ts",
-    "test": "NODE_ENV=test nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md",
-    "prepare": "husky install"
-  },
-  "lint-staged": {
-    "*.{js,ts}": [
-      "eslint --cache --fix"
-    ],
-    "*.{js,css,md,ts}": "prettier --write"
-  },
-  "directories": {
-    "test": "test"
-  }
-}
+{
+  "name": "@learnpack/learnpack",
+  "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
+  "version": "5.0.16",
+  "author": "Alejandro Sanchez @alesanchezr",
+  "contributors": [
+    {
+      "name": "Alejandro Sanchez",
+      "url": "https://www.x.com/alesanchezr"
+    },
+    {
+      "name": "Charly Chacón",
+      "email": "charlyjchaconc@gmail.com",
+      "url": "https://www.linkedin.com/in/charlytoc/"
+    }
+  ],
+  "bin": {
+    "learnpack": "bin/run"
+  },
+  "bugs": {
+    "url": "https://github.com/learnpack/learnpack-cli/issues"
+  },
+  "dependencies": {
+    "@oclif/command": "^1.6.1",
+    "@oclif/config": "^1.15.1",
+    "@oclif/plugin-help": "^3.1.0",
+    "@oclif/plugin-plugins": "^1.8.0",
+    "@oclif/plugin-warn-if-update-available": "^1.7.0",
+    "@types/archiver": "^6.0.2",
+    "archiver": "^7.0.1",
+    "axios": "^1.7.7",
+    "body-parser": "^1.19.0",
+    "chalk": "^4.1.0",
+    "chokidar": "^3.4.0",
+    "cli-ux": "^5.4.6",
+    "debounce": "^1.2.0",
+    "dotenv": "^8.2.0",
+    "enquirer": "^2.3.6",
+    "eslint-plugin-unicorn": "^38.0.1",
+    "espree": "^9.3.2",
+    "eta": "^1.2.0",
+    "express": "^4.17.1",
+    "front-matter": "^4.0.2",
+    "moment": "^2.27.0",
+    "node-emoji": "^1.10.0",
+    "node-fetch": "^2.7.0",
+    "node-persist": "^3.1.0",
+    "prompts": "^2.3.2",
+    "shelljs": "^0.8.4",
+    "socket.io": "^4.4.1",
+    "targz": "^1.0.1",
+    "tslib": "^1",
+    "validator": "^13.1.1",
+    "xxhashjs": "^0.2.2"
+  },
+  "devDependencies": {
+    "@oclif/dev-cli": "^1.22.2",
+    "@oclif/test": "^1.2.6",
+    "@types/chai": "^4",
+    "@types/debounce": "^1.2.1",
+    "@types/express": "^4.17.13",
+    "@types/fs-extra": "^8.1.0",
+    "@types/mocha": "^5",
+    "@types/mock-fs": "^4.13.1",
+    "@types/node": "^10.17.60",
+    "@types/node-persist": "^3.1.2",
+    "@types/prompts": "^2.0.14",
+    "@types/shelljs": "^0.8.9",
+    "@types/socket.io": "^3.0.2",
+    "@types/targz": "^1.0.1",
+    "@types/validator": "^13.7.0",
+    "@types/xxhashjs": "^0.2.2",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "chai": "^4.2.0",
+    "chai-http": "^4.3.0",
+    "eslint": "^8.12.0",
+    "eslint-config-oclif": "^4.0",
+    "eslint-config-oclif-typescript": "^1.0.2",
+    "fs-extra": "^10.0.1",
+    "globby": "^10.0.2",
+    "husky": ">=6",
+    "lint-staged": ">=10",
+    "mocha": "^5.2.0",
+    "mock-fs": "^5.1.2",
+    "nock": "^13.2.2",
+    "nyc": "^14.1.1",
+    "pre-commit": "^1.2.2",
+    "prettier": "^2.4.1",
+    "ts-node": "^8",
+    "typescript": "^5.6.2"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "/bin",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json",
+    "/src",
+    "/lib"
+  ],
+  "homepage": "https://github.com/learnpack/learnpack-cli",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "UNLICENSED",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "learnpack",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-warn-if-update-available"
+    ],
+    "permanent_plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-warn-if-update-available"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/learnpack/learnpack-cli.git"
+  },
+  "pre-commit": {
+    "silent": true,
+    "run": [
+      "pre"
+    ]
+  },
+  "scripts": {
+    "tsc": "tsc -b",
+    "postpack": "rm -f oclif.manifest.json && eslint . --ext .ts --config .eslintrc",
+    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
+    "pre": "node ./test/precommit/index.ts",
+    "test": "NODE_ENV=test nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif-dev readme && git add README.md",
+    "prepare": "husky install"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --cache --fix"
+    ],
+    "*.{js,css,md,ts}": "prettier --write"
+  },
+  "directories": {
+    "test": "test"
+  }
+}

package/src/commands/init.ts

@@ -19,7 +19,7 @@ import {
   downloadImage,
   generateCourseIntroduction,
 } from "../utils/rigoActions"
-
+import { getConsumables } from "../utils/api"
 const slugify = (text: string) => {
   return text
     .toString()
@@ -53,6 +53,25 @@ function getFilenameFromUrl(url: string) {
   return path.basename(url)
 }
 
+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
+}
+
 async function createPreviewReadme(
   tutorialDir: string,
   packageInfo: PackageInfo,
@@ -81,7 +100,9 @@ type PackageInfo = {
 }
 
 const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
-  Console.info("Almost there! First you need to login to use the AI creator")
+  Console.info(
+    "Almost there! First you need to login with 4Geeks.com to use AI Generation tool for creators. You can create a new account here: https://4geeks.com/creators"
+  )
 
   fs.removeSync(path.join(tutorialDir, "exercises", "01-hello-world"))
 
@@ -115,12 +136,23 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
 
   const rigoToken = sessionPayload.rigobot.key
 
+  const consumables = await getConsumables(sessionPayload.token)
+
+  if (consumables.ai_tutorial_generation === 0) {
+    Console.error(
+      "It seems you cannot generate tutorials with AI. Make sure you creator subscription is up to date here: https://4geeks.com/profile/subscriptions?token=" +
+        sessionPayload.token +
+        ". If you believe there is an issue you can always contact support@4geeks.com"
+    )
+    process.exit(1)
+  }
+
   const isCreator = await hasCreatorPermission(rigoToken)
   if (!isCreator) {
     Console.error(
       "👀 Oops! You need to be a creator to use our specialized AI. Please contact support"
     )
-    return
+    process.exit(1)
   }
 
   Console.success("🎉 Let's begin this learning journey!")
@@ -236,6 +268,91 @@ const handleAILogic = async (tutorialDir: string, packageInfo: PackageInfo) => {
   return true
 }
 
+const getChoices = async (empty: boolean) => {
+  const defaultChoices = {
+    title: "My Interactive Tutorial",
+    description: "",
+    difficulty: "beginner",
+    duration: 1,
+    useAI: "no",
+    grading: "isolated",
+  }
+
+  if (empty) {
+    return defaultChoices
+  }
+
+  const choices = await prompts([
+    {
+      type: "select",
+      name: "grading",
+      message: "Is the auto-grading going to be isolated or incremental?",
+      choices: [
+        {
+          title: "Incremental: Build on top of each other like a tutorial",
+          value: "incremental",
+        },
+        { title: "Isolated: Small separated exercises", value: "isolated" },
+        {
+          title: "No grading: No feedback or testing whatsoever",
+          value: null,
+        },
+      ],
+    },
+    {
+      type: "text",
+      name: "title",
+      initial: "My Interactive Tutorial",
+      message: "Title for your tutorial? Press enter to leave as it is",
+    },
+    {
+      type: "text",
+      name: "description",
+      initial: "",
+      message: "Description for your tutorial? Press enter to leave blank",
+    },
+    {
+      type: "select",
+      name: "difficulty",
+      message: "How difficulty will be to complete the tutorial?",
+      choices: [
+        { title: "Begginer (no previous experience)", value: "beginner" },
+        { title: "Easy (just a bit of experience required)", value: "easy" },
+        {
+          title: "Intermediate (you need experience)",
+          value: "intermediate",
+        },
+        { title: "Hard (master the topic)", value: "hard" },
+      ],
+    },
+    {
+      type: "text",
+      name: "duration",
+      initial: "1",
+      message: "How many hours avg it takes to complete (number)?",
+      validate: (value: string) => {
+        const n = Math.floor(Number(value))
+        return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
+      },
+    },
+    {
+      type: "select",
+      name: "useAI",
+      message:
+        "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
+      choices: [
+        {
+          title: "Yes, please help me",
+          value: "yes",
+        },
+        { title: "No, thanks, I prefer to do it manually", value: "no" },
+      ],
+    },
+  ])
+
+  return choices
+}
+
 class InitComand extends BaseCommand {
   static description =
     "Create a new learning package: Book, Tutorial or Exercise"
@@ -250,89 +367,9 @@ class InitComand extends BaseCommand {
 
     await alreadyInitialized()
 
-    const choices = await prompts([
-      {
-        type: "select",
-        name: "grading",
-        message: "Is the auto-grading going to be isolated or incremental?",
-        choices: [
-          {
-            title: "Incremental: Build on top of each other like a tutorial",
-            value: "incremental",
-          },
-          { title: "Isolated: Small separated exercises", value: "isolated" },
-          {
-            title: "No grading: No feedback or testing whatsoever",
-            value: null,
-          },
-        ],
-      },
-      {
-        type: "text",
-        name: "title",
-        initial: "My Interactive Tutorial",
-        message: "Title for your tutorial? Press enter to leave as it is",
-      },
-      {
-        type: "text",
-        name: "description",
-        initial: "",
-        message: "Description for your tutorial? Press enter to leave blank",
-      },
-      {
-        type: "select",
-        name: "difficulty",
-        message: "How difficulty will be to complete the tutorial?",
-        choices: [
-          { title: "Begginer (no previous experience)", value: "beginner" },
-          { title: "Easy (just a bit of experience required)", value: "easy" },
-          {
-            title: "Intermediate (you need experience)",
-            value: "intermediate",
-          },
-          { title: "Hard (master the topic)", value: "hard" },
-        ],
-      },
-      {
-        type: "text",
-        name: "duration",
-        initial: "1",
-        message: "How many hours avg it takes to complete (number)?",
-        validate: (value: string) => {
-          const n = Math.floor(Number(value))
-          return n !== Number.POSITIVE_INFINITY && String(n) === value && n >= 0
-        },
-      },
-      {
-        type: "select",
-        name: "useAI",
-        message:
-          "Want a little bit of AI magic to help you? Our AI can craft the tutorial for you",
-        choices: [
-          {
-            title: "Yes, please help me",
-            value: "yes",
-          },
-          { title: "No, thanks, I prefer to do it manually", value: "no" },
-        ],
-      },
-    ])
-
-    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, ""),
-    }
+    const choices = await getChoices(flags.yes)
+
+    const packageInfo = makePackageInfo(choices)
 
     const tutorialDir = `./${packageInfo.slug}`
     fs.ensureDirSync(tutorialDir)
@@ -354,26 +391,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 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
-      // )
+      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`))
     }
@@ -398,6 +435,7 @@ class InitComand extends BaseCommand {
     Console.help(
       `Start the exercises by running the following command on your terminal: $ learnpack start`
     )
+    process.exit(0)
   }
 }