@learnpack/learnpack 2.1.6 → 2.1.8

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.6 win32-x64 node-v16.14.0
+@learnpack/learnpack/2.1.8 win32-x64 node-v16.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -74,7 +74,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/v2.1.6/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -89,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -107,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -138,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -156,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -309,7 +309,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -330,7 +330,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,5 +344,5 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.8/src\commands\test.ts)_
 <!-- commandsstop -->

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) || "", onChange)
+            watcher_1.default(((_a = configObj === null || configObj === void 0 ? void 0 : configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath) || "", this, onChange)
                 .then(( /* eventname, filename */) => {
                 console_1.default.debug("Changes detected on your exercises");
                 this.buildIndex();

package/lib/models/config.d.ts

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

package/lib/utils/watcher.d.ts

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

package/lib/utils/watcher.js

@@ -3,16 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const chokidar = require("chokidar");
 const console_1 = require("./console");
 const debounce = require("debounce");
-exports.default = (path, reloadSocket) => new Promise((resolve /* , reject */) => {
+exports.default = (path, configManager, 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 */);
-        reloadSocket();
+        if (!/^(?=.*(\\\w+)$).*$/gm.test(_filename) ||
+            !/^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm.test(_filename)) {
+            configManager.buildIndex();
+            reloadSocket();
+        }
     };
     watcher.on("all", debounce(onChange, 500, true));
     // watcher.on('all', onChange)

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.6","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.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":"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.6",
+  "version": "2.1.8",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"

package/src/managers/config/defaults.ts

@@ -1,34 +1,34 @@
-export default {
-  config: {
-    port: 3000,
-    editor: {
-      mode: null, // [standalone, preview]
-      agent: null, // [vscode, gitpod, localhost]
-      version: null,
-    },
-    dirPath: "./.learn",
-    configPath: "./learn.json",
-    outputPath: "./.learn/dist",
-    publicPath: "/preview",
-    publicUrl: null,
-    language: "auto",
-    autoPlay: true,
-    grading: "isolated", // [isolated, incremental]
-    exercisesPath: "./", // path to the folder that contains the exercises
-    webpackTemplate: null, // if you want webpack to use an HTML template
-    disableGrading: false,
-    disabledActions: [], // Possible: 'build', 'test' or 'reset'
-    actions: [], // ⚠️ deprecated, leave empty )
-    entries: {
-      html: "index.html",
-      vanillajs: "index.js",
-      react: "app.jsx",
-      node: "app.js",
-      python3: "app.py",
-      java: "app.java",
-    },
-  },
-  address: "http://localhost",
-  currentExercise: null,
-  exercises: [],
-};
+export default {
+  config: {
+    port: 3000,
+    editor: {
+      mode: null, // [standalone, preview]
+      agent: null, // [vscode, gitpod, localhost]
+      version: null,
+    },
+    dirPath: "./.learn",
+    configPath: "./learn.json",
+    outputPath: "./.learn/dist",
+    publicPath: "/preview",
+    publicUrl: null,
+    language: "auto",
+    autoPlay: true,
+    grading: "isolated", // [isolated, incremental]
+    exercisesPath: "./", // path to the folder that contains the exercises
+    webpackTemplate: null, // if you want webpack to use an HTML template
+    disableGrading: false,
+    disabledActions: [], // Possible: 'build', 'test' or 'reset'
+    actions: [], // ⚠️ deprecated, leave empty )
+    entries: {
+      html: "index.html",
+      vanillajs: "index.js",
+      react: "app.jsx",
+      node: "app.js",
+      python3: "app.py",
+      java: "app.java",
+    },
+  },
+  address: "http://localhost",
+  currentExercise: null,
+  exercises: [],
+};

package/src/managers/config/index.ts

@@ -350,7 +350,7 @@ fs.mkdirSync(confPath.base);
         );
 
       this.buildIndex();
-      watch(configObj?.config?.exercisesPath || "", onChange)
+      watch(configObj?.config?.exercisesPath || "", this, onChange)
         .then((/* eventname, filename */) => {
           Console.debug("Changes detected on your exercises");
           this.buildIndex();

package/src/models/config.ts

@@ -1,75 +1,76 @@
-import { IExercise } from "./exercise-obj";
-
-export type TGrading = "isolated" | "incremental" | "no-grading";
-
-export type TMode = "preview" | "standalone";
-
-export type TConfigAction = "test" | "build" | "tutorial" | "reset";
-
-export type TConfigObjAttributes = "config" | "exercises" | "grading";
-
-export type TCompiler =
-  | "webpack"
-  | "vanillajs"
-  | "vue"
-  | "react"
-  | "css"
-  | "html";
-
-export interface IConfigPath {
-  base: string;
-}
-
-export interface IEditor {
-  mode?: TMode;
-  version: string;
-  agent?: string;
-}
-
-export interface TEntries {
-  python3?: string;
-  html?: string;
-  node?: string;
-  react?: string;
-  java?: string;
-}
-
-export interface IConfig {
-  port?: string;
-  repository?: string;
-  description?: string;
-  slug?: string;
-  dirPath: string;
-  preview?: string; // Picture thumbnail
-  entries: TEntries;
-  grading: TGrading;
-  configPath: string;
-  translations: Array<string>;
-  outputPath?: string;
-  editor: IEditor;
-  language: string;
-  title: string;
-  duration: number;
-  difficulty?: string;
-  exercisesPath: string;
-  disableGrading: boolean; // TODO: Deprecate
-  actions: Array<string>; // TODO: Deprecate
-  autoPlay: boolean;
-  // TODO: nameExerciseValidation
-  disabledActions?: Array<TConfigAction>;
-  compiler: TCompiler;
-  publicPath: string;
-  publicUrl?: string;
-  skills: Array<string>;
-  runHook: (...agrs: Array<any>) => void;
-  testingFinishedCallback: (arg: any | undefined) => void;
-}
-
-export interface IConfigObj {
-  session?: number;
-  currentExercise?: any;
-  config?: IConfig;
-  exercises?: Array<IExercise>;
-  confPath?: IConfigPath;
-  address?: string; // Maybe
-}
+import { IExercise } from "./exercise-obj";
+
+export type TGrading = "isolated" | "incremental" | "no-grading";
+
+export type TMode = "preview" | "standalone";
+
+export type TConfigAction = "test" | "build" | "tutorial" | "reset";
+
+export type TConfigObjAttributes = "config" | "exercises" | "grading";
+
+export type TCompiler =
+  | "webpack"
+  | "vanillajs"
+  | "vue"
+  | "react"
+  | "css"
+  | "html";
+
+export interface IConfigPath {
+  base: string;
+}
+
+export interface IEditor {
+  mode?: TMode;
+  version: string;
+  agent?: string;
+}
+
+export interface TEntries {
+  python3?: string;
+  html?: string;
+  node?: string;
+  react?: string;
+  java?: string;
+}
+
+export interface IConfig {
+  port?: string;
+  repository?: string;
+  description?: string;
+  slug?: string;
+  dirPath: string;
+  preview?: string; // Picture thumbnail
+  entries: TEntries;
+  grading: TGrading;
+  configPath: string;
+  translations: Array<string>;
+  outputPath?: string;
+  editor: IEditor;
+  language: string;
+  title: string;
+  duration: number;
+  difficulty?: string;
+  exercisesPath: string;
+  disableGrading: boolean; // TODO: Deprecate
+  actions: Array<string>; // TODO: Deprecate
+  autoPlay: boolean;
+  // TODO: nameExerciseValidation
+  contact?: string;
+  disabledActions?: Array<TConfigAction>;
+  compiler: TCompiler;
+  publicPath: string;
+  publicUrl?: string;
+  skills: Array<string>;
+  runHook: (...agrs: Array<any>) => void;
+  testingFinishedCallback: (arg: any | undefined) => void;
+}
+
+export interface IConfigObj {
+  session?: number;
+  currentExercise?: any;
+  config?: IConfig;
+  exercises?: Array<IExercise>;
+  confPath?: IConfigPath;
+  address?: string; // Maybe
+}

package/src/utils/watcher.ts

@@ -1,25 +1,35 @@
-import * as chokidar from "chokidar";
-import Console from "./console";
-import * as debounce from "debounce";
-
-export default (path: string, reloadSocket: () => void) =>
-  new Promise((resolve /* , reject */) => {
-    Console.debug("PATH:", path);
-    const watcher = chokidar.watch(path, {
-      // TODO: This watcher is not ready yet
-      ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
-      ignoreInitial: true,
-    });
-    const onChange = (eventname: string, _filename: string) => {
-      resolve(eventname /* , filename */);
-      reloadSocket();
-    };
-
-    watcher.on("all", debounce(onChange, 500, true));
-    // watcher.on('all', onChange)
-
-    process.on("SIGINT", function () {
-      watcher.close();
-      process.exit();
-    });
-  });
+import * as chokidar from "chokidar";
+import Console from "./console";
+import * as debounce from "debounce";
+import { IConfigManager } from "../models/config-manager";
+
+export default (
+  path: string,
+  configManager: IConfigManager,
+  reloadSocket: () => void
+) =>
+  new Promise((resolve /* , reject */) => {
+    Console.debug("PATH:", path);
+    const watcher = chokidar.watch(path, {
+      // TODO: This watcher is not ready yet
+      ignoreInitial: true,
+    });
+    const onChange = (eventname: string, _filename: string) => {
+      resolve(eventname /* , filename */);
+      if (
+        !/^(?=.*(\\\w+)$).*$/gm.test(_filename) ||
+        !/^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm.test(_filename)
+      ) {
+        configManager.buildIndex();
+        reloadSocket();
+      }
+    };
+
+    watcher.on("all", debounce(onChange, 500, true));
+    // watcher.on('all', onChange)
+
+    process.on("SIGINT", function () {
+      watcher.close();
+      process.exit();
+    });
+  });