@learnpack/learnpack 5.0.8 → 5.0.9

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.8 darwin-arm64 node-v16.20.0
+@learnpack/learnpack/5.0.9 darwin-arm64 node-v16.20.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src/commands/audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/audit.ts)_
+_See code: [src/commands/audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src/commands/clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src/commands/download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/download.ts)_
+_See code: [src/commands/download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -139,7 +139,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src/commands/init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -157,7 +157,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src/commands/login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -175,7 +175,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/logout.ts)_
 
 ## `learnpack plugins`
 
@@ -306,7 +306,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src/commands/publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/publish.ts)_
+_See code: [src/commands/publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/publish.ts)_
 
 ## `learnpack start`
 
@@ -327,7 +327,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src/commands/start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/start.ts)_
+_See code: [src/commands/start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -341,7 +341,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src/commands/test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/test.ts)_
+_See code: [src/commands/test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/test.ts)_
 
 ## `learnpack translate`
 
@@ -352,7 +352,7 @@ USAGE
   $ learnpack translate
 ```
 
-_See code: [src/commands/translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.8/src/commands/translate.ts)_
+_See code: [src/commands/translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.9/src/commands/translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/audit.js

@@ -6,6 +6,7 @@ const console_1 = require("../utils/console");
 const audit_1 = require("../utils/audit");
 const SessionCommand_1 = require("../utils/SessionCommand");
 const path = require("path");
+const index_1 = require("../managers/config/index");
 // eslint-disable-next-line
 const fetch = require("node-fetch");
 class AuditCommand extends SessionCommand_1.default {
@@ -16,6 +17,17 @@ class AuditCommand extends SessionCommand_1.default {
     async run() {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         console_1.default.log("Running command audit...");
+        // Checking the "learn.json" file:
+        let learnjson;
+        try {
+            const configPath = (0, index_1.getConfigPath)().config;
+            const learnJsonContent = fs.readFileSync(configPath);
+            learnjson = JSON.parse(learnJsonContent.toString());
+        }
+        catch (_error) {
+            console_1.default.error("Invalid JSON syntax in learn.json file:", _error.message);
+            process.exit(1);
+        }
         // Get configuration object.
         let config = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         if (config) {
@@ -236,15 +248,6 @@ class AuditCommand extends SessionCommand_1.default {
             }
             else {
                 // This is the audit code for Projects
-                // Checking the "learn.json" file:
-                let learnjson;
-                try {
-                    learnjson = JSON.parse(fs.readFileSync("./learn.json").toString());
-                }
-                catch (_error) {
-                    console_1.default.error("Invalid JSON syntax in learn.json file:", _error.message);
-                    process.exit(1);
-                }
                 if (!learnjson) {
                     console_1.default.error("There is no learn.json file located in the root of the project.");
                     process.exit(1);

package/lib/managers/config/index.d.ts

@@ -1,3 +1,13 @@
 import { IConfigManagerAttributes, IConfigManager } from "../../models/config-manager";
+/**
+ * Retrieves the configuration path for the learnpack package.
+ *
+ * @returns An object containing the configuration file path and the base directory.
+ * @throws NotFoundError if the learn.json file is not found in the current folder.
+ */
+export declare const getConfigPath: () => {
+    config: string;
+    base: string;
+};
 declare const _default: ({ grading, mode, disableGrading, version, }: IConfigManagerAttributes) => Promise<IConfigManager>;
 export default _default;

package/lib/managers/config/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfigPath = void 0;
 const path = require("path");
 const fs = require("fs");
 const shell = require("shelljs");
@@ -33,6 +34,7 @@ const getConfigPath = () => {
         throw (0, errors_1.NotFoundError)("learn.json file not found on current folder, is this a learnpack package?");
     return { config, base: ".learn" };
 };
+exports.getConfigPath = getConfigPath;
 const getExercisesPath = (base) => {
     const possibleFileNames = ["./exercises", base + "/exercises", "./"];
     return possibleFileNames.find(file => fs.existsSync(file)) || null;
@@ -61,7 +63,7 @@ const getCodespacesNamespace = () => {
 };
 exports.default = async ({ grading, mode, disableGrading, version, }) => {
     var _a, _b, _c, _d, _e, _f;
-    const confPath = getConfigPath();
+    const confPath = (0, exports.getConfigPath)();
     console_1.default.debug("This is the config path: ", confPath);
     let configObj = {};
     if (confPath) {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.8","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"5.0.9","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "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.8",
+  "version": "5.0.9",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/audit.ts

@@ -10,6 +10,7 @@ import { IFrontmatter } from "../models/front-matter"
 import { IAuditErrors } from "../models/audit"
 import { ICounter } from "../models/counter"
 import { IFindings } from "../models/findings"
+import { getConfigPath } from "../managers/config/index"
 
 // eslint-disable-next-line
 const fetch = require("node-fetch");
@@ -23,6 +24,17 @@ class AuditCommand extends SessionCommand {
   async run() {
     Console.log("Running command audit...")
 
+    // Checking the "learn.json" file:
+    let learnjson
+    try {
+      const configPath: string = getConfigPath().config
+      const learnJsonContent: Buffer = fs.readFileSync(configPath)
+      learnjson = JSON.parse(learnJsonContent.toString())
+    } catch (_error: any) {
+      Console.error("Invalid JSON syntax in learn.json file:", _error.message)
+      process.exit(1)
+    }
+
     // Get configuration object.
     let config = this.configManager?.get()
 
@@ -305,18 +317,6 @@ files.push(` ${item.exercise}`)
       } else {
         // This is the audit code for Projects
 
-        // Checking the "learn.json" file:
-        let learnjson
-        try {
-          learnjson = JSON.parse(fs.readFileSync("./learn.json").toString())
-        } catch (_error: any) {
-          Console.error(
-            "Invalid JSON syntax in learn.json file:",
-            _error.message
-          )
-          process.exit(1)
-        }
-
         if (!learnjson) {
           Console.error(
             "There is no learn.json file located in the root of the project."

package/src/managers/config/index.ts

@@ -32,9 +32,9 @@ import { IFile } from "../../models/file"
 const execAsync = promisify(exec)
 
 // eslint-disable-next-line
-const fetch = require("node-fetch")
+const fetch = require("node-fetch");
 // eslint-disable-next-line
-const chalk = require("chalk")
+const chalk = require("chalk");
 
 /* exercise folder name standard */
 
@@ -44,7 +44,7 @@ const chalk = require("chalk")
  * @returns An object containing the configuration file path and the base directory.
  * @throws NotFoundError if the learn.json file is not found in the current folder.
  */
-const getConfigPath = () => {
+export const getConfigPath = () => {
   const possibleFileNames = ["learn.json", ".learn/learn.json"]
   const config = possibleFileNames.find(file => fs.existsSync(file)) || null
   if (config && fs.existsSync(".breathecode"))
@@ -444,7 +444,9 @@ fs.unlinkSync(_path)
         ex => ex.slug === slug
       )
       if (!exercise)
-        throw ValidationError(`Exercise ${slug} not found on the configuration`)
+        throw ValidationError(
+          `Exercise ${slug} not found on the configuration`
+        )
 
       if (configObj.config) {
         for (const fileName of fs.readdirSync(