@learnpack/learnpack 2.1.39 → 2.1.40

package/lib/models/front-matter.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/gitpod-data.d.ts

@@ -1,16 +1,16 @@
-import { Server } from 'socket.io';
-import { IConfigObj } from './config';
-export declare type TFile = string;
-export interface IGitpodData {
-    files: Array<TFile>;
-}
-export interface IGitpod {
-    socket: Server | null;
-    config: IConfigObj | null;
-    initialized: boolean;
-    hasGPCommand: boolean;
-    init: (config?: IConfigObj) => void;
-    openFiles: (files: Array<TFile>) => Promise<boolean | undefined>;
-    setup: (config?: IConfigObj) => void;
-    autosave: (value: string) => void;
-}
+import { Server } from 'socket.io';
+import { IConfigObj } from './config';
+export declare type TFile = string;
+export interface IGitpodData {
+    files: Array<TFile>;
+}
+export interface IGitpod {
+    socket: Server | null;
+    config: IConfigObj | null;
+    initialized: boolean;
+    hasGPCommand: boolean;
+    init: (config?: IConfigObj) => void;
+    openFiles: (files: Array<TFile>) => Promise<boolean | undefined>;
+    setup: (config?: IConfigObj) => void;
+    autosave: (value: string) => void;
+}

package/lib/models/gitpod-data.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/language.d.ts

@@ -1,4 +1,4 @@
-export interface ILanguage {
-    title: string;
-    slug: string;
-}
+export interface ILanguage {
+    title: string;
+    slug: string;
+}

package/lib/models/language.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/package.d.ts

@@ -1,7 +1,7 @@
-export interface IPackage {
-    title: string;
-    slug: string;
-    difficulty: string;
-    downloads: string;
-    skills: Array<any>;
-}
+export interface IPackage {
+    title: string;
+    slug: string;
+    difficulty: string;
+    downloads: string;
+    skills: Array<any>;
+}

package/lib/models/package.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/plugin-config.d.ts

@@ -1,16 +1,16 @@
-import { IConfig } from "./config";
-import { IExercise } from "./exercise-obj";
-export interface IPluginConfig {
-    language: string;
-    compile?: {
-        run: () => void;
-        validate: (args: IValidate) => boolean;
-        dependencies: string[];
-    };
-    test?: () => void;
-}
-interface IValidate {
-    exercise: IExercise;
-    configuration: IConfig;
-}
-export {};
+import { IConfig } from "./config";
+import { IExercise } from "./exercise-obj";
+export interface IPluginConfig {
+    language: string;
+    compile?: {
+        run: () => void;
+        validate: (args: IValidate) => boolean;
+        dependencies: string[];
+    };
+    test?: () => void;
+}
+interface IValidate {
+    exercise: IExercise;
+    configuration: IConfig;
+}
+export {};

package/lib/models/plugin-config.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/session.d.ts

@@ -1,31 +1,31 @@
-import { IConfig, IConfigObj } from "./config";
-export interface IPayload {
-    email: string;
-}
-export interface IStartProps {
-    token: string;
-    payload: IPayload | null;
-}
-declare type TLoginResponse = {
-    token: string;
-    user_id: string;
-    email: string;
-};
-export interface ISession {
-    sessionStarted: boolean;
-    token: string | null;
-    config: IConfig | null;
-    currentCohort: null;
-    initialize: () => Promise<boolean>;
-    setRigoToken: (token: string) => Promise<boolean>;
-    setPayload: (value: IPayload) => Promise<boolean>;
-    getPayload: () => Promise<any>;
-    isActive: () => boolean;
-    get: (config?: IConfigObj) => Promise<any>;
-    login: () => Promise<void>;
-    loginWeb: (email: string, password: string) => Promise<TLoginResponse>;
-    sync: () => Promise<void>;
-    start: ({ token, payload }: IStartProps) => Promise<void>;
-    destroy: () => Promise<void>;
-}
-export {};
+import { IConfig, IConfigObj } from "./config";
+export interface IPayload {
+    email: string;
+}
+export interface IStartProps {
+    token: string;
+    payload: IPayload | null;
+}
+declare type TLoginResponse = {
+    token: string;
+    user_id: string;
+    email: string;
+};
+export interface ISession {
+    sessionStarted: boolean;
+    token: string | null;
+    config: IConfig | null;
+    currentCohort: null;
+    initialize: () => Promise<boolean>;
+    setRigoToken: (token: string) => Promise<boolean>;
+    setPayload: (value: IPayload) => Promise<boolean>;
+    getPayload: () => Promise<any>;
+    isActive: () => boolean;
+    get: (config?: IConfigObj) => Promise<any>;
+    login: () => Promise<void>;
+    loginWeb: (email: string, password: string) => Promise<TLoginResponse>;
+    sync: () => Promise<void>;
+    start: ({ token, payload }: IStartProps) => Promise<void>;
+    destroy: () => Promise<void>;
+}
+export {};

package/lib/models/session.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/socket.d.ts

@@ -1,32 +1,36 @@
-import { IConfig } from "./config";
-import { Server } from "socket.io";
-import { DefaultEventsMap } from "socket.io/dist/typed-events";
-import { TAction, ICallback } from "./action";
-import { TStatus } from "./status";
-export declare type TPossibleActions = "build" | "test" | "reset" | "tutorial" | "generate";
-export interface ISocket {
-    socket: Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | null;
-    config: IConfig | null;
-    allowedActions: Array<TPossibleActions>;
-    actionCallBacks: {
-        [key: string]: ICallback;
-    };
-    possibleActions: Array<TPossibleActions>;
-    isTestingEnvironment: boolean;
-    addAllowed: (actions: any) => void;
-    removeAllowed: (actions: any) => void;
-    start: (config: IConfig, server: any, isTestingEnvironment: boolean) => void;
-    on: (action: any, callBack: any) => void;
-    clean: (_: string, logs: Array<any>) => void;
-    complete: () => void;
-    ask: (questions: Array<string>) => void;
-    reload: (files: Array<string> | null, exercises: Array<string>) => void;
-    openWindow: (id: string) => void;
-    log: (status: TStatus, messages?: string | Array<string>, report?: Array<string>, data?: any) => void;
-    emit: (action: TAction, status: TStatus | string, logs: string | Array<string>, inputs?: Array<string>, report?: Array<string>, data?: any) => void;
-    ready: (message: string) => void;
-    error: (type: any, stdout: string) => void;
-    fatal: (msg: string) => void;
-    success: (type: any, stdout: string) => void;
-    onTestingFinished: (obj: any) => void;
-}
+import { IConfig } from "./config";
+import { Server } from "socket.io";
+import { DefaultEventsMap } from "socket.io/dist/typed-events";
+import { TAction, ICallback } from "./action";
+import { TStatus } from "./status";
+export declare type TPossibleActions = "build" | "test" | "reset" | "tutorial" | "generate";
+export interface ISocket {
+    socket: Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | null;
+    config: IConfig | null;
+    allowedActions: Array<TPossibleActions>;
+    actionCallBacks: {
+        [key: string]: ICallback;
+    };
+    possibleActions: Array<TPossibleActions>;
+    isTestingEnvironment: boolean;
+    addAllowed: (actions: any) => void;
+    removeAllowed: (actions: any) => void;
+    start: (config: IConfig, server: any, isTestingEnvironment: boolean) => void;
+    on: (action: any, callBack: any) => void;
+    clean: (_: string, logs: Array<any>) => void;
+    complete: () => void;
+    ask: (questions: Array<string>) => void;
+    reload: (files: Array<string> | null, exercises: Array<string>) => void;
+    openWindow: (id: string) => void;
+    log: (status: TStatus, messages?: string | Array<string>, report?: Array<string>, data?: any) => void;
+    emit: (action: TAction, status: TStatus | string, logs: string | Array<string>, inputs?: Array<string>, report?: Array<string>, data?: any) => void;
+    ready: (message: string) => void;
+    error: (type: any, stdout: string) => void;
+    fatal: (msg: string) => void;
+    success: (type: any, stdout: string) => void;
+    onTestingFinished: (obj: any) => void;
+}
+export declare type TOpenWindowData = {
+    url: string;
+    exerciseSlug: string;
+};

package/lib/models/socket.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/status.d.ts

@@ -1 +1 @@
-export declare type TStatus = "ready" | "internal-error" | "compiler-success" | "testing-success" | "compiling" | "testing" | "start_exercise" | "initializing" | "configuration_loaded" | "connection_ended" | "reset_exercise" | "open_files" | "open_window" | "instructions_closed" | "completed";
+export declare type TStatus = "ready" | "internal-error" | "compiler-success" | "testing-success" | "compiling" | "testing" | "start_exercise" | "initializing" | "configuration_loaded" | "connection_ended" | "reset_exercise" | "open_files" | "open_window" | "instructions_closed" | "completed";

package/lib/models/status.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/success-types.d.ts

@@ -1 +1 @@
-export declare type TSuccessType = 'compiler-success' | 'testing-success';
+export declare type TSuccessType = 'compiler-success' | 'testing-success';

package/lib/models/success-types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugin/command/compile.d.ts

@@ -1,6 +1,6 @@
-import { IError } from "../../models/errors";
-declare const _default: {
-    CompilationError: (messages: string) => IError;
-    default: ({ action, ...rest }: any) => Promise<any>;
-};
-export default _default;
+import { IError } from "../../models/errors";
+declare const _default: {
+    CompilationError: (messages: string) => IError;
+    default: ({ action, ...rest }: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/command/compile.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const CompilationError = (messages) => {
-    const _err = new Error(messages);
-    _err.status = 400;
-    _err.stdout = messages;
-    _err.type = "compiler-error";
-    return _err;
-};
-exports.default = {
-    CompilationError,
-    default: async (_a) => {
-        var { action } = _a, rest = tslib_1.__rest(_a, ["action"]);
-        const stdout = await action.run(rest);
-        return stdout;
-    },
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const CompilationError = (messages) => {
+    const _err = new Error(messages);
+    _err.status = 400;
+    _err.stdout = messages;
+    _err.type = "compiler-error";
+    return _err;
+};
+exports.default = {
+    CompilationError,
+    default: async (_a) => {
+        var { action } = _a, rest = tslib_1.__rest(_a, ["action"]);
+        const stdout = await action.run(rest);
+        return stdout;
+    },
+};

package/lib/plugin/command/test.d.ts

@@ -1,6 +1,6 @@
-import { IError } from "../../models/errors";
-declare const _default: {
-    TestingError: (messages: string) => IError;
-    default: (args: any) => Promise<any>;
-};
-export default _default;
+import { IError } from "../../models/errors";
+declare const _default: {
+    TestingError: (messages: string) => IError;
+    default: (args: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/command/test.js

@@ -1,25 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const TestingError = (messages) => {
-    const _err = new Error(messages);
-    _err.status = 400;
-    _err.stdout = messages;
-    _err.type = "testing-error";
-    return _err;
-};
-exports.default = {
-    TestingError,
-    default: async function (args) {
-        const { action, configuration, socket, exercise } = args;
-        if (!fs.existsSync(`${configuration.dirPath}/reports`)) {
-            // reports directory
-            fs.mkdirSync(`${configuration.dirPath}/reports`);
-        }
-        // compile
-        const stdout = await action.run(args);
-        // mark exercise as done
-        exercise.done = true;
-        return stdout;
-    },
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const TestingError = (messages) => {
+    const _err = new Error(messages);
+    _err.status = 400;
+    _err.stdout = messages;
+    _err.type = "testing-error";
+    return _err;
+};
+exports.default = {
+    TestingError,
+    default: async function (args) {
+        const { action, configuration, socket, exercise } = args;
+        if (!fs.existsSync(`${configuration.dirPath}/reports`)) {
+            // reports directory
+            fs.mkdirSync(`${configuration.dirPath}/reports`);
+        }
+        // compile
+        const stdout = await action.run(args);
+        // mark exercise as done
+        exercise.done = true;
+        return stdout;
+    },
+};

package/lib/plugin/index.d.ts

@@ -1,27 +1,27 @@
-declare const _default: {
-    CompilationError: {
-        CompilationError: (messages: string) => import("../models/errors").IError;
-        default: ({ action, ...rest }: any) => Promise<any>;
-    };
-    TestingError: {
-        TestingError: (messages: string) => import("../models/errors").IError;
-        default: (args: any) => Promise<any>;
-    };
-    Utils: {
-        getMatches: (reg: RegExp, content: string) => (string | null)[];
-        cleanStdout: (buffer: string, inputs: string[]) => string;
-        indent: (string: string, options: any, count?: number) => string;
-        Console: {
-            _debug: boolean;
-            startDebug: () => void;
-            log: (msg: string, ...args: any[]) => void;
-            error: (msg: string, ...args: any[]) => void;
-            success: (msg: string, ...args: any[]) => void;
-            info: (msg: string, ...args: any[]) => void;
-            help: (msg: string) => void;
-            debug(...args: any[]): void;
-        };
-    };
-    plugin: (pluginConfig: import("../models/plugin-config").IPluginConfig) => (args: any) => Promise<any>;
-};
-export default _default;
+declare const _default: {
+    CompilationError: {
+        CompilationError: (messages: string) => import("../models/errors").IError;
+        default: ({ action, ...rest }: any) => Promise<any>;
+    };
+    TestingError: {
+        TestingError: (messages: string) => import("../models/errors").IError;
+        default: (args: any) => Promise<any>;
+    };
+    Utils: {
+        getMatches: (reg: RegExp, content: string) => (string | null)[];
+        cleanStdout: (buffer: string, inputs: string[]) => string;
+        indent: (string: string, options: any, count?: number) => string;
+        Console: {
+            _debug: boolean;
+            startDebug: () => void;
+            log: (msg: string, ...args: any[]) => void;
+            error: (msg: string, ...args: any[]) => void;
+            success: (msg: string, ...args: any[]) => void;
+            info: (msg: string, ...args: any[]) => void;
+            help: (msg: string) => void;
+            debug(...args: any[]): void;
+        };
+    };
+    plugin: (pluginConfig: import("../models/plugin-config").IPluginConfig) => (args: any) => Promise<any>;
+};
+export default _default;

package/lib/plugin/index.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const compile_1 = require("./command/compile");
-const test_1 = require("./command/test");
-const utils_1 = require("./utils");
-const plugin_1 = require("./plugin");
-exports.default = { CompilationError: compile_1.default, TestingError: test_1.default, Utils: utils_1.default, plugin: plugin_1.default };
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const compile_1 = require("./command/compile");
+const test_1 = require("./command/test");
+const utils_1 = require("./utils");
+const plugin_1 = require("./plugin");
+exports.default = { CompilationError: compile_1.default, TestingError: test_1.default, Utils: utils_1.default, plugin: plugin_1.default };

package/lib/plugin/plugin.d.ts

@@ -1,8 +1,8 @@
-import { IPluginConfig } from "../models/plugin-config";
-declare const _default: (pluginConfig: IPluginConfig) => (args: any) => Promise<any>;
-/**
- * Main Plugin Runner, it defines the behavior of a learnpack plugin
- * dividing it in "actions" like: Compile, test, etc.
- * @param {object} pluginConfig Configuration object that must defined language and each possible action.
- */
-export default _default;
+import { IPluginConfig } from "../models/plugin-config";
+declare const _default: (pluginConfig: IPluginConfig) => (args: any) => Promise<any>;
+/**
+ * Main Plugin Runner, it defines the behavior of a learnpack plugin
+ * dividing it in "actions" like: Compile, test, etc.
+ * @param {object} pluginConfig Configuration object that must defined language and each possible action.
+ */
+export default _default;

package/lib/plugin/plugin.js

@@ -1,68 +1,68 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const shell = require("shelljs");
-/**
- * Main Plugin Runner, it defines the behavior of a learnpack plugin
- * dividing it in "actions" like: Compile, test, etc.
- * @param {object} pluginConfig Configuration object that must defined language and each possible action.
- */
-exports.default = (pluginConfig) => {
-    return async (args) => {
-        const { action, exercise, socket, configuration } = args;
-        if (pluginConfig.language === undefined)
-            throw new Error(`Missing language on the plugin configuration object`);
-        if (typeof action !== "string") {
-            throw new TypeError("Missing action property on hook details");
-        }
-        if (!exercise || exercise === undefined) {
-            throw new Error("Missing exercise information");
-        }
-        // if the action does not exist I don't do anything
-        if (pluginConfig[action] === undefined) {
-            console.log(`Ignoring ${action}`);
-            return () => null;
-        }
-        // ignore if the plugin language its not the same as the exercise language
-        if (exercise.language !== pluginConfig.language) {
-            return () => null;
-        }
-        if (!exercise.files || exercise.files.length === 0) {
-            throw new Error(`No files to process`);
-        }
-        try {
-            const _action = pluginConfig[action];
-            if (_action === null || typeof _action !== "object")
-                throw new Error(`The ${pluginConfig.language} ${action} module must export an object configuration`);
-            if (_action.validate === undefined)
-                throw new Error(`Missing validate method for ${pluginConfig.language} ${action}`);
-            if (_action.run === undefined)
-                throw new Error(`Missing run method for ${pluginConfig.language} ${action}`);
-            if (_action.dependencies !== undefined) {
-                if (!Array.isArray(_action.dependencies))
-                    throw new Error(`${action}.dependencies must be an array of package names`);
-                for (const packageName of _action.dependencies) {
-                    if (!shell.which(packageName)) {
-                        throw new Error(`🚫 You need to have ${packageName} installed to run test the exercises`);
-                    }
-                }
-            }
-            const valid = await _action.validate({ exercise, configuration });
-            if (valid) {
-                // look for the command standard implementation and execute it
-                const execute = require("./command/" + action + ".js").default;
-                // no matter the command, the response must always be a stdout
-                const stdout = await execute(Object.assign(Object.assign({}, args), { action: _action, configuration }));
-                // Map the action names to socket messaging standards
-                const actionToSuccessMapper = { compile: "compiler", test: "testing" };
-                socket.success(actionToSuccessMapper[action], stdout);
-                return stdout;
-            }
-        }
-        catch (error) {
-            if (error.type === undefined)
-                socket.fatal(error);
-            else
-                socket.error(error.type, error.stdout);
-        }
-    };
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const shell = require("shelljs");
+/**
+ * Main Plugin Runner, it defines the behavior of a learnpack plugin
+ * dividing it in "actions" like: Compile, test, etc.
+ * @param {object} pluginConfig Configuration object that must defined language and each possible action.
+ */
+exports.default = (pluginConfig) => {
+    return async (args) => {
+        const { action, exercise, socket, configuration } = args;
+        if (pluginConfig.language === undefined)
+            throw new Error(`Missing language on the plugin configuration object`);
+        if (typeof action !== "string") {
+            throw new TypeError("Missing action property on hook details");
+        }
+        if (!exercise || exercise === undefined) {
+            throw new Error("Missing exercise information");
+        }
+        // if the action does not exist I don't do anything
+        if (pluginConfig[action] === undefined) {
+            console.log(`Ignoring ${action}`);
+            return () => null;
+        }
+        // ignore if the plugin language its not the same as the exercise language
+        if (exercise.language !== pluginConfig.language) {
+            return () => null;
+        }
+        if (!exercise.files || exercise.files.length === 0) {
+            throw new Error(`No files to process`);
+        }
+        try {
+            const _action = pluginConfig[action];
+            if (_action === null || typeof _action !== "object")
+                throw new Error(`The ${pluginConfig.language} ${action} module must export an object configuration`);
+            if (_action.validate === undefined)
+                throw new Error(`Missing validate method for ${pluginConfig.language} ${action}`);
+            if (_action.run === undefined)
+                throw new Error(`Missing run method for ${pluginConfig.language} ${action}`);
+            if (_action.dependencies !== undefined) {
+                if (!Array.isArray(_action.dependencies))
+                    throw new Error(`${action}.dependencies must be an array of package names`);
+                for (const packageName of _action.dependencies) {
+                    if (!shell.which(packageName)) {
+                        throw new Error(`🚫 You need to have ${packageName} installed to run test the exercises`);
+                    }
+                }
+            }
+            const valid = await _action.validate({ exercise, configuration });
+            if (valid) {
+                // look for the command standard implementation and execute it
+                const execute = require("./command/" + action + ".js").default;
+                // no matter the command, the response must always be a stdout
+                const stdout = await execute(Object.assign(Object.assign({}, args), { action: _action, configuration }));
+                // Map the action names to socket messaging standards
+                const actionToSuccessMapper = { compile: "compiler", test: "testing" };
+                socket.success(actionToSuccessMapper[action], stdout);
+                return stdout;
+            }
+        }
+        catch (error) {
+            if (error.type === undefined)
+                socket.fatal(error);
+            else
+                socket.error(error.type, error.stdout);
+        }
+    };
+};