@learnpack/learnpack 5.0.38 → 5.0.40

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.38 win32-x64 node-v22.14.0
+@learnpack/learnpack/5.0.40 win32-x64 node-v22.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -58,6 +58,9 @@ learnpack audit is the command in charge of creating an auditory of the reposito
 USAGE
   $ learnpack audit
 
+OPTIONS
+  -s, --strict  strict mode
+
 DESCRIPTION
   ...
   learnpack audit checks for the following information in a repository:
@@ -76,7 +79,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.38/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\audit.ts)_
 
 ## `learnpack breakToken`
 
@@ -91,7 +94,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\breakToken.ts)_
+_See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\breakToken.ts)_
 
 ## `learnpack clean`
 
@@ -106,7 +109,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -124,7 +127,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -156,7 +159,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -174,7 +177,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -192,7 +195,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -320,10 +323,11 @@ USAGE
   $ learnpack publish
 
 OPTIONS
-  -h, --help  show CLI help
+  -h, --help    show CLI help
+  -s, --strict  strict mode
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -345,7 +349,7 @@ OPTIONS
   -y, --yes                           Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -362,7 +366,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -376,7 +380,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.38/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.40/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 command_1 = require("@oclif/command");
 // eslint-disable-next-line
 const fetch = require("node-fetch");
 class AuditCommand extends SessionCommand_1.default {
@@ -14,7 +15,9 @@ class AuditCommand extends SessionCommand_1.default {
         await this.initSession(flags);
     }
     async run() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+        const { flags } = this.parse(AuditCommand);
+        const strict = flags.strict;
         console_1.default.log("Running command audit...");
         // Get configuration object.
         let config = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
@@ -74,50 +77,70 @@ class AuditCommand extends SessionCommand_1.default {
                         exercise: undefined,
                         msg: "The slug property is not in the configuration object",
                     });
+                if (((_f = config.config) === null || _f === void 0 ? void 0 : _f.slug) && !audit_1.default.checkSlug((_g = config.config) === null || _g === void 0 ? void 0 : _g.slug)) {
+                    errors.push({
+                        exercise: undefined,
+                        msg: "The slug property is not a valid slug. It must start and end with a letter and be less than 50 characters.",
+                    });
+                }
                 // check if the duration property is in the configuration object
-                if (!((_f = config.config) === null || _f === void 0 ? void 0 : _f.duration))
+                if (!((_h = config.config) === null || _h === void 0 ? void 0 : _h.duration))
                     warnings.push({
                         exercise: undefined,
                         msg: "The duration property is not in the configuration object",
                     });
                 // check if the difficulty property is in the configuration object
-                if (!((_g = config.config) === null || _g === void 0 ? void 0 : _g.difficulty))
+                if (!((_j = config.config) === null || _j === void 0 ? void 0 : _j.difficulty))
                     warnings.push({
                         exercise: undefined,
                         msg: "The difficulty property is not in the configuration object",
                     });
                 // check if the bugs_link property is in the configuration object
-                if (!((_h = config.config) === null || _h === void 0 ? void 0 : _h.bugsLink))
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The bugsLink property is not in the configuration object",
-                    });
-                // check if the video_solutions property is in the configuration object
-                if (((_j = config.config) === null || _j === void 0 ? void 0 : _j.videoSolutions) === undefined)
+                if (!((_k = config.config) === null || _k === void 0 ? void 0 : _k.bugsLink)) {
+                    if (strict)
+                        errors.push({
+                            exercise: undefined,
+                            msg: "The bugsLink property is not in the configuration object",
+                        });
+                    else
+                        warnings.push({
+                            exercise: undefined,
+                            msg: "The bugsLink property is not in the configuration object",
+                        });
+                }
+                // check if the video_solutions  property is in the configuration object
+                if (((_l = config.config) === null || _l === void 0 ? void 0 : _l.videoSolutions) === undefined)
                     warnings.push({
                         exercise: undefined,
                         msg: "The videoSolutions property is not in the configuration object",
                     });
                 // These two lines check if the 'repository' property is inside the configuration object.
                 console_1.default.debug("Checking if the repository property is inside the configuration object...");
-                if (!((_k = config.config) === null || _k === void 0 ? void 0 : _k.repository))
-                    errors.push({
-                        exercise: undefined,
-                        msg: "The repository property is not in the configuration object",
-                    });
+                if (!((_m = config.config) === null || _m === void 0 ? void 0 : _m.repository)) {
+                    if (strict)
+                        errors.push({
+                            exercise: undefined,
+                            msg: "The repository property is not in the configuration object",
+                        });
+                    else
+                        warnings.push({
+                            exercise: undefined,
+                            msg: "The repository property is not in the configuration object",
+                        });
+                }
                 else
-                    audit_1.default.isUrl((_l = config.config) === null || _l === void 0 ? void 0 : _l.repository, errors, counter);
+                    audit_1.default.isUrl((_o = config.config) === null || _o === void 0 ? void 0 : _o.repository, errors, counter);
                 // These two lines check if the 'description' property is inside the configuration object.
                 console_1.default.debug("Checking if the description property is inside the configuration object...");
-                if (!((_m = config.config) === null || _m === void 0 ? void 0 : _m.description))
+                if (!((_p = config.config) === null || _p === void 0 ? void 0 : _p.description))
                     errors.push({
                         exercise: undefined,
                         msg: "The description property is not in the configuration object",
                     });
-                if (!((_o = config.config) === null || _o === void 0 ? void 0 : _o.projectType))
+                if (!((_q = config.config) === null || _q === void 0 ? void 0 : _q.projectType))
                     errors.push({
                         exercise: undefined,
-                        msg: "The projectType property mandatory in the configuration object",
+                        msg: "The projectType property is mandatory in the configuration object",
                     });
                 if (errors.length === 0)
                     console_1.default.log("The config file is ok");
@@ -306,7 +329,7 @@ class AuditCommand extends SessionCommand_1.default {
                         });
                     }
                 }
-                catch (_p) {
+                catch (_r) {
                     errors.push({
                         exercise: undefined,
                         msg: `The link of the "preview" is broken: ${learnjson.preview}`,
@@ -346,6 +369,10 @@ learnpack audit checks for the following information in a repository:
     12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 `;
 AuditCommand.flags = {
-// name: flags.string({char: 'n', description: 'name to print'}),
+    strict: command_1.flags.boolean({
+        char: "s",
+        description: "strict mode",
+        default: false,
+    }),
 };
 exports.default = AuditCommand;

package/lib/commands/init.js

@@ -25,6 +25,7 @@ const PARAMS = {
     max_fkgl: 8,
     max_words: 200,
     max_rewrite_attempts: 3,
+    max_title_length: 50,
 };
 const whichTargetAudience = async () => {
     const res = await prompts([
@@ -133,6 +134,9 @@ const initializeInteractiveCreation = async (rigoToken, courseInfo) => {
         duration,
     };
 };
+process.emitWarning = (warning) => {
+    console_1.default.debug("A Warning was emitted by Node.js: ", warning);
+};
 const appendContentIndex = async () => {
     const choices = await prompts([
         {
@@ -292,6 +296,12 @@ const getChoices = async (empty) => {
             name: "title",
             initial: "My Interactive Tutorial",
             message: "Title for your tutorial? Press enter to leave as it is",
+            validate: (value) => {
+                if (value.length > PARAMS.max_title_length) {
+                    return `Title must be less than ${PARAMS.max_title_length} characters`;
+                }
+                return true;
+            },
         },
         {
             type: "text",

package/lib/commands/publish.d.ts

@@ -1,11 +1,13 @@
 import SessionCommand from "../utils/SessionCommand";
-export default class BuildCommand extends SessionCommand {
+declare class BuildCommand extends SessionCommand {
     static description: string;
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        strict: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     init(): Promise<void>;
     run(): Promise<void>;
     copyDirectory(src: string, dest: string): void;
     removeDirectory(dir: string): void;
 }
+export default BuildCommand;

package/lib/commands/publish.js

@@ -20,10 +20,12 @@ const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 // const RIGOBOT_HOST =
 //   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload";
-const runAudit = () => {
+const runAudit = (strict) => {
     try {
         console_1.default.info("Running learnpack audit before publishing...");
-        (0, child_process_1.execSync)("learnpack audit", { stdio: "inherit" });
+        (0, child_process_1.execSync)(`learnpack audit ${strict ? "--strict" : ""}`, {
+            stdio: "inherit",
+        });
     }
     catch (error) {
         console_1.default.error("Failed to audit with learnpack");
@@ -68,6 +70,9 @@ class BuildCommand extends SessionCommand_1.default {
     async run() {
         var _a, _b, _c;
         const buildDir = path.join(process.cwd(), "build");
+        const { flags } = this.parse(BuildCommand);
+        const strict = flags.strict;
+        console_1.default.debug("Strict mode: ", strict);
         // this.configManager?.clean()
         const configObject = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         let sessionPayload = await session_1.default.getPayload();
@@ -98,7 +103,7 @@ class BuildCommand extends SessionCommand_1.default {
             console_1.default.info("Cleaning configuration files");
             (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.clean();
             // build exerises
-            runAudit();
+            runAudit(strict);
             console_1.default.debug("Building exercises");
             (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
         }
@@ -267,5 +272,18 @@ class BuildCommand extends SessionCommand_1.default {
 BuildCommand.description = "Builds the project by copying necessary files and directories into a zip file";
 BuildCommand.flags = {
     help: command_1.flags.help({ char: "h" }),
+    strict: command_1.flags.boolean({
+        char: "s",
+        description: "strict mode",
+        default: false,
+    }),
+};
+BuildCommand.flags = {
+    strict: command_1.flags.boolean({
+        char: "s",
+        description: "strict mode",
+        default: false,
+    }),
+    help: command_1.flags.help({ char: "h" }),
 };
 exports.default = BuildCommand;

package/lib/utils/audit.d.ts

@@ -12,5 +12,6 @@ declare const _default: {
     writeFile: (filePath: string, content: string) => void;
     showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
     showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
+    checkSlug: (slug: string) => boolean;
 };
 export default _default;

package/lib/utils/audit.js

@@ -38,6 +38,20 @@ const checkForEmptySpaces = (str) => {
     }
     return isEmpty;
 };
+const checkSlug = (slug) => {
+    // Validate that the length of the slug is less than 50 characters
+    // The slug must start with a letter
+    if (slug.length > 50) {
+        return false;
+    }
+    if (!/^[A-Za-z]/.test(slug)) {
+        return false;
+    }
+    if (!/[A-Za-z]$/.test(slug)) {
+        return false;
+    }
+    return true;
+};
 const checkLearnpackClean = (configObj, errors) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     if ((((_a = configObj.config) === null || _a === void 0 ? void 0 : _a.outputPath) &&
@@ -278,4 +292,5 @@ exports.default = {
     writeFile,
     showErrors,
     showWarnings,
+    checkSlug,
 };

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.38","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":[]},"breakToken":{"id":"breakToken","description":"Break the token","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}
+{"version":"5.0.40","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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false}},"args":[]},"breakToken":{"id":"breakToken","description":"Break the token","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"strict":{"name":"strict","type":"boolean","char":"s","description":"strict mode","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"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.38",
+  "version": "5.0.40",
   "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 { flags } from "@oclif/command"
 
 // eslint-disable-next-line
 const fetch = require("node-fetch")
@@ -21,6 +22,9 @@ class AuditCommand extends SessionCommand {
   }
 
   async run() {
+    const { flags }: { flags: { strict: boolean } } = this.parse(AuditCommand)
+
+    const strict = flags.strict
     Console.log("Running command audit...")
 
     // Get configuration object.
@@ -101,6 +105,14 @@ class AuditCommand extends SessionCommand {
             exercise: undefined,
             msg: "The slug property is not in the configuration object",
           })
+
+        if (config!.config?.slug && !Audit.checkSlug(config!.config?.slug)) {
+          errors.push({
+            exercise: undefined,
+            msg: "The slug property is not a valid slug. It must start and end with a letter and be less than 50 characters.",
+          })
+        }
+
         // check if the duration property is in the configuration object
         if (!config!.config?.duration)
           warnings.push({
@@ -114,12 +126,20 @@ class AuditCommand extends SessionCommand {
             msg: "The difficulty property is not in the configuration object",
           })
         // check if the bugs_link property is in the configuration object
-        if (!config!.config?.bugsLink)
-          errors.push({
-            exercise: undefined,
-            msg: "The bugsLink property is not in the configuration object",
-          })
-        // check if the video_solutions property is in the configuration object
+        if (!config!.config?.bugsLink) {
+          if (strict)
+            errors.push({
+              exercise: undefined,
+              msg: "The bugsLink property is not in the configuration object",
+            })
+          else
+            warnings.push({
+              exercise: undefined,
+              msg: "The bugsLink property is not in the configuration object",
+            })
+        }
+
+        // check if the video_solutions  property is in the configuration object
         if (config!.config?.videoSolutions === undefined)
           warnings.push({
             exercise: undefined,
@@ -130,12 +150,18 @@ class AuditCommand extends SessionCommand {
         Console.debug(
           "Checking if the repository property is inside the configuration object..."
         )
-        if (!config!.config?.repository)
-          errors.push({
-            exercise: undefined,
-            msg: "The repository property is not in the configuration object",
-          })
-        else 
+        if (!config!.config?.repository) {
+          if (strict)
+            errors.push({
+              exercise: undefined,
+              msg: "The repository property is not in the configuration object",
+            })
+          else
+            warnings.push({
+              exercise: undefined,
+              msg: "The repository property is not in the configuration object",
+            })
+        } else 
 Audit.isUrl(config!.config?.repository, errors, counter)
 
         // These two lines check if the 'description' property is inside the configuration object.
@@ -150,7 +176,7 @@ Audit.isUrl(config!.config?.repository, errors, counter)
         if (!config!.config?.projectType)
           errors.push({
             exercise: undefined,
-            msg: "The projectType property mandatory in the configuration object",
+            msg: "The projectType property is mandatory in the configuration object",
           })
 
         if (errors.length === 0) 
@@ -443,7 +469,11 @@ learnpack audit checks for the following information in a repository:
 `
 
 AuditCommand.flags = {
-  // name: flags.string({char: 'n', description: 'name to print'}),
+  strict: flags.boolean({
+    char: "s",
+    description: "strict mode",
+    default: false,
+  }),
 }
 
 export default AuditCommand

package/src/commands/init.ts

@@ -47,6 +47,7 @@ const PARAMS = {
   max_fkgl: 8,
   max_words: 200,
   max_rewrite_attempts: 3,
+  max_title_length: 50,
 }
 
 const whichTargetAudience = async () => {
@@ -221,6 +222,10 @@ const initializeInteractiveCreation = async (
   }
 }
 
+process.emitWarning = (warning: string) => {
+  Console.debug("A Warning was emitted by Node.js: ", warning)
+}
+
 const appendContentIndex = async () => {
   const choices = await prompts([
     {
@@ -425,9 +430,17 @@ const getChoices = async (empty: boolean) => {
     },
     {
       type: "text",
+
       name: "title",
       initial: "My Interactive Tutorial",
       message: "Title for your tutorial? Press enter to leave as it is",
+      validate: (value: string) => {
+        if (value.length > PARAMS.max_title_length) {
+          return `Title must be less than ${PARAMS.max_title_length} characters`
+        }
+
+        return true
+      },
     },
     {
       type: "text",

package/src/commands/publish.ts

@@ -24,10 +24,12 @@ const RIGOBOT_HOST = "https://rigobot.herokuapp.com"
 //   "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
 
-const runAudit = () => {
+const runAudit = (strict: boolean) => {
   try {
     Console.info("Running learnpack audit before publishing...")
-    execSync("learnpack audit", { stdio: "inherit" })
+    execSync(`learnpack audit ${strict ? "--strict" : ""}`, {
+      stdio: "inherit",
+    })
   } catch (error) {
     Console.error("Failed to audit with learnpack")
 
@@ -71,12 +73,17 @@ const selectAcademy = async (academies: TAcademy[]) => {
   return response.academy
 }
 
-export default class BuildCommand extends SessionCommand {
+class BuildCommand extends SessionCommand {
   static description =
     "Builds the project by copying necessary files and directories into a zip file"
 
   static flags = {
     help: flags.help({ char: "h" }),
+    strict: flags.boolean({
+      char: "s",
+      description: "strict mode",
+      default: false,
+    }),
   }
 
   async init() {
@@ -86,6 +93,10 @@ export default class BuildCommand extends SessionCommand {
 
   async run() {
     const buildDir = path.join(process.cwd(), "build")
+
+    const { flags }: { flags: { strict: boolean } } = this.parse(BuildCommand)
+    const strict = flags.strict
+    Console.debug("Strict mode: ", strict)
     // this.configManager?.clean()
 
     const configObject = this.configManager?.get()
@@ -134,7 +145,7 @@ export default class BuildCommand extends SessionCommand {
       Console.info("Cleaning configuration files")
       this.configManager?.clean()
       // build exerises
-      runAudit()
+      runAudit(strict)
 
       Console.debug("Building exercises")
       this.configManager?.buildIndex()
@@ -334,3 +345,14 @@ export default class BuildCommand extends SessionCommand {
     }
   }
 }
+
+BuildCommand.flags = {
+  strict: flags.boolean({
+    char: "s",
+    description: "strict mode",
+    default: false,
+  }),
+  help: flags.help({ char: "h" }),
+}
+
+export default BuildCommand

package/src/utils/audit.ts

@@ -55,6 +55,25 @@ const checkForEmptySpaces = (str: string) => {
   return isEmpty
 }
 
+const checkSlug = (slug: string) => {
+  // Validate that the length of the slug is less than 50 characters
+  // The slug must start with a letter
+
+  if (slug.length > 50) {
+    return false
+  }
+
+  if (!/^[A-Za-z]/.test(slug)) {
+    return false
+  }
+
+  if (!/[A-Za-z]$/.test(slug)) {
+    return false
+  }
+
+  return true
+}
+
 const checkLearnpackClean = (configObj: IConfigObj, errors: IAuditErrors[]) => {
   if (
     (configObj.config?.outputPath &&
@@ -369,4 +388,5 @@ export default {
   writeFile,
   showErrors,
   showWarnings,
+  checkSlug,
 }

package/src/utils/templates/incremental/.github/workflows/learnpack-audit.yml

@@ -26,4 +26,4 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install @learnpack/learnpack@latest -g
-    - run: learnpack audit
+    - run: learnpack audit --strict

package/src/utils/templates/isolated/.github/workflows/learnpack-audit.yml

@@ -26,4 +26,4 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install @learnpack/learnpack@latest -g
-    - run: learnpack audit
+    - run: learnpack audit --strict