@learnpack/learnpack 2.1.15 → 2.1.20

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

@@ -14,6 +14,7 @@ declare const _default: {
         contact: string;
         language: string;
         autoPlay: boolean;
+        projectType: string;
         grading: string;
         exercisesPath: string;
         webpackTemplate: null;

package/lib/managers/config/defaults.js

@@ -16,6 +16,7 @@ exports.default = {
         contact: "https://github.com/learnpack/learnpack/issues/new",
         language: "auto",
         autoPlay: true,
+        projectType: "tutorial",
         grading: "isolated",
         exercisesPath: "./",
         webpackTemplate: null,

package/lib/managers/config/index.js

@@ -254,7 +254,7 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
             if (configObj.config && !configObj.config.exercisesPath)
                 throw errors_1.ValidationError("No exercises directory to watch: " + configObj.config.exercisesPath);
             this.buildIndex();
-            watcher_1.default(((_a = configObj === null || configObj === void 0 ? void 0 : configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath) || "", this, onChange)
+            watcher_1.default(((_a = configObj === null || configObj === void 0 ? void 0 : configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath) || "", onChange)
                 .then(( /* eventname, filename */) => {
                 console_1.default.debug("Changes detected on your exercises");
                 this.buildIndex();

package/lib/models/audit.d.ts

@@ -0,0 +1,15 @@
+export interface IAuditErrors {
+    exercise?: string;
+    msg: string;
+}
+declare type TType = "string" | "array" | "number" | "url" | "boolean";
+export interface ISchemaItem {
+    key: string;
+    mandatory: boolean;
+    type: TType;
+    max_size?: number;
+    allowed_extensions?: string[];
+    enum?: string[];
+    max_item_size?: number;
+}
+export {};

package/lib/models/config.d.ts

@@ -40,6 +40,7 @@ export interface IConfig {
     disableGrading: boolean;
     actions: Array<string>;
     autoPlay: boolean;
+    projectType?: string;
     contact?: string;
     disabledActions?: Array<TConfigAction>;
     compiler: TCompiler;

package/lib/utils/audit.d.ts

@@ -1,13 +1,13 @@
-import { IAuditErrors } from '../models/audit-errors';
-import { IConfigObj } from '../models/config';
-import { ICounter } from '../models/counter';
-import { IFindings } from '../models/findings';
+import { IAuditErrors } from "../models/audit";
+import { IConfigObj } from "../models/config";
+import { ICounter } from "../models/counter";
+import { IFindings } from "../models/findings";
 declare const _default: {
     isUrl: (url: string, errors: IAuditErrors[], counter: ICounter) => Promise<boolean>;
     checkForEmptySpaces: (str: string) => boolean;
     checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
     findInFile: (types: string[], content: string) => IFindings;
-    showErrors: (errors: IAuditErrors[], counter: ICounter) => Promise<unknown>;
+    showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
     showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
 };
 export default _default;

package/lib/utils/audit.js

@@ -17,7 +17,7 @@ exports.default = {
             });
             return false;
         }
-        const res = await fetch(url, { method: 'HEAD' });
+        const res = await fetch(url, { method: "HEAD" });
         if (!res.ok) {
             counter.links.error++;
             errors.push({
@@ -30,7 +30,7 @@ exports.default = {
     checkForEmptySpaces: (str) => {
         const isEmpty = true;
         for (const letter of str) {
-            if (letter !== ' ') {
+            if (letter !== " ") {
                 return false;
             }
         }
@@ -48,7 +48,7 @@ exports.default = {
             fs.existsSync(`${(_h = configObj.config) === null || _h === void 0 ? void 0 : _h.dirPath}/vscode_queue.json`)) {
             errors.push({
                 exercise: undefined,
-                msg: 'You have to run learnpack clean command',
+                msg: "You have to run learnpack clean command",
             });
         }
     },
@@ -66,7 +66,7 @@ exports.default = {
         const findings = {};
         for (const type of types) {
             if (!validTypes.includes(type))
-                throw new Error('Invalid type: ' + type);
+                throw new Error("Invalid type: " + type);
             else
                 findings[type] = {};
         }
@@ -94,19 +94,29 @@ exports.default = {
         return new Promise((resolve, reject) => {
             if (errors) {
                 if (errors.length > 0) {
-                    console_1.default.log('Checking for errors...');
+                    console_1.default.log("Checking for errors...");
                     for (const [i, error] of errors.entries())
-                        console_1.default.error(`${i + 1}) ${error.msg} ${error.exercise ? `(Exercise: ${error.exercise})` : ''}`);
-                    console_1.default.error(` We found ${errors.length} errors among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
+                        console_1.default.error(`${i + 1}) ${error.msg} ${error.exercise ? `(Exercise: ${error.exercise})` : ""}`);
+                    if (counter) {
+                        console_1.default.error(` We found ${errors.length} error${errors.length > 1 ? "s" : ""} among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
+                    }
+                    else {
+                        console_1.default.error(` We found ${errors.length} error${errors.length > 1 ? "s" : ""} related with the project integrity.`);
+                    }
                     process.exit(1);
                 }
                 else {
-                    console_1.default.success(`We didn't find any errors in this repository among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
+                    if (counter) {
+                        console_1.default.success(`We didn't find any errors in this repository among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`);
+                    }
+                    else {
+                        console_1.default.success(`We didn't find any errors in this repository.`);
+                    }
                     process.exit(0);
                 }
             }
             else {
-                reject('Failed');
+                reject("Failed");
             }
         });
     },
@@ -115,14 +125,14 @@ exports.default = {
         return new Promise((resolve, reject) => {
             if (warnings) {
                 if (warnings.length > 0) {
-                    console_1.default.log('Checking for warnings...');
+                    console_1.default.log("Checking for warnings...");
                     for (const [i, warning] of warnings.entries())
-                        console_1.default.warning(`${i + 1}) ${warning.msg} ${warning.exercise ? `File: ${warning.exercise}` : ''}`);
+                        console_1.default.warning(`${i + 1}) ${warning.msg} ${warning.exercise ? `File: ${warning.exercise}` : ""}`);
                 }
-                resolve('SUCCESS');
+                resolve("SUCCESS");
             }
             else {
-                reject('Failed');
+                reject("Failed");
             }
         });
     },

package/lib/utils/watcher.d.ts

@@ -1,3 +1,2 @@
-import { IConfigManager } from "../models/config-manager";
-declare const _default: (path: string, configManager: IConfigManager, reloadSocket: () => void) => Promise<unknown>;
+declare const _default: (path: string, reloadSocket: () => void) => Promise<unknown>;
 export default _default;

package/lib/utils/watcher.js

@@ -3,22 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const chokidar = require("chokidar");
 const console_1 = require("./console");
 const debounce = require("debounce");
-exports.default = (path, configManager, reloadSocket) => new Promise((resolve /* , reject */) => {
+exports.default = (path, reloadSocket) => new Promise((resolve /* , reject */) => {
     console_1.default.debug("PATH:", path);
     const watcher = chokidar.watch(path, {
         // TODO: This watcher is not ready yet
+        ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
         ignoreInitial: true,
     });
     const onChange = (eventname, _filename) => {
         resolve(eventname /* , filename */);
-        console_1.default.log(_filename);
-        if (/^(?=.*(\\\w+)$).*$/gm.test(_filename) === false ||
-            /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm.test(_filename) === false) {
-            configManager.buildIndex();
-        }
-        else {
-            reloadSocket();
-        }
+        reloadSocket();
     };
     watcher.on("all", debounce(onChange, 500, true));
     // watcher.on('all', onChange)

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.15","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":"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}]},"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":"[standalone, gitpod]","options":["standalone","gitpod"]},"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}]}}}
+{"version":"2.1.20","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":"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}]},"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":"[standalone, gitpod]","options":["standalone","gitpod"]},"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}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Create, sell or download and take learning amazing learning packages",
-  "version": "2.1.15",
+  "version": "2.1.20",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"