@learnpack/learnpack 4.0.9 → 4.0.12

package/lib/commands/test.js

@@ -1,62 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const SessionCommand_1 = require("../utils/SessionCommand");
-const socket_1 = require("../managers/socket");
-const server_1 = require("../managers/server");
-const exercisesQueue_1 = require("../utils/exercisesQueue");
-class TestCommand extends SessionCommand_1.default {
-    async init() {
-        const { flags } = this.parse(TestCommand);
-        await this.initSession(flags);
-    }
-    async run() {
-        var _a, _b, _c;
-        const { args: { exerciseSlug }, } = this.parse(TestCommand);
-        // Build exercises index
-        (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.buildIndex();
-        let exercises = [];
-        // test all exercises
-        !exerciseSlug ?
-            (exercises = (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.getAllExercises()) :
-            (exercises = [this.configManager.getExercise(exerciseSlug)]);
-        const exercisesQueue = new exercisesQueue_1.default(exercises);
-        const configObject = (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.get();
-        let hasFailed = false;
-        let failedTestsCount = 0;
-        let successTestsCount = 0;
-        const testsToRunCount = exercisesQueue.size();
-        configObject.config.testingFinishedCallback = ({ result }) => {
-            if (result === "failed") {
-                hasFailed = true;
-                failedTestsCount++;
-            }
-            else {
-                successTestsCount++;
-            }
-            if (exercisesQueue.isEmpty()) {
-                console_1.default.info(`${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`);
-                console_1.default.success(`${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`);
-                console_1.default.error(`${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`);
-                process.exit(hasFailed ? 1 : 0);
-            }
-            else {
-                exercisesQueue.pop().test(this.config, config, socket_1.default);
-            }
-        };
-        const config = configObject === null || configObject === void 0 ? void 0 : configObject.config;
-        const server = await server_1.default(configObject, this.configManager, true);
-        socket_1.default.start(config, server, true);
-        exercisesQueue.pop().test(this.config, config, socket_1.default);
-    }
-}
-TestCommand.description = `Test exercises`;
-TestCommand.args = [
-    {
-        name: "exerciseSlug",
-        required: false,
-        description: "The name of the exercise to test",
-        hidden: false,
-    },
-];
-exports.default = TestCommand;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const console_1 = require("../utils/console");
+const SessionCommand_1 = require("../utils/SessionCommand");
+const socket_1 = require("../managers/socket");
+const server_1 = require("../managers/server");
+const exercisesQueue_1 = require("../utils/exercisesQueue");
+class TestCommand extends SessionCommand_1.default {
+    async init() {
+        const { flags } = this.parse(TestCommand);
+        await this.initSession(flags);
+    }
+    async run() {
+        var _a, _b, _c;
+        const { args: { exerciseSlug }, } = this.parse(TestCommand);
+        // Build exercises index
+        (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.buildIndex();
+        let exercises = [];
+        // test all exercises
+        !exerciseSlug ?
+            (exercises = (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.getAllExercises()) :
+            (exercises = [this.configManager.getExercise(exerciseSlug)]);
+        const exercisesQueue = new exercisesQueue_1.default(exercises);
+        const configObject = (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.get();
+        let hasFailed = false;
+        let failedTestsCount = 0;
+        let successTestsCount = 0;
+        const testsToRunCount = exercisesQueue.size();
+        configObject.config.testingFinishedCallback = ({ result }) => {
+            if (result === "failed") {
+                hasFailed = true;
+                failedTestsCount++;
+            }
+            else {
+                successTestsCount++;
+            }
+            if (exercisesQueue.isEmpty()) {
+                console_1.default.info(`${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`);
+                console_1.default.success(`${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`);
+                console_1.default.error(`${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`);
+                process.exit(hasFailed ? 1 : 0);
+            }
+            else {
+                exercisesQueue.pop().test(this.config, config, socket_1.default);
+            }
+        };
+        const config = configObject === null || configObject === void 0 ? void 0 : configObject.config;
+        const server = await (0, server_1.default)(configObject, this.configManager, true);
+        socket_1.default.start(config, server, true);
+        exercisesQueue.pop().test(this.config, config, socket_1.default);
+    }
+}
+TestCommand.description = `Test exercises`;
+TestCommand.args = [
+    {
+        name: "exerciseSlug",
+        required: false,
+        description: "The name of the exercise to test",
+        hidden: false,
+    },
+];
+exports.default = TestCommand;

package/lib/index.d.ts

@@ -1 +1 @@
-export * from '@oclif/command';
+export * from '@oclif/command';

package/lib/index.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("@oclif/command"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("@oclif/command"), exports);

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

@@ -1,5 +1,5 @@
-declare const extensions: {
-    extensions: string[];
-    names: string[];
-};
-export default extensions;
+declare const extensions: {
+    extensions: string[];
+    names: string[];
+};
+export default extensions;

package/lib/managers/config/allowed_files.js

@@ -1,30 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const extensions = {
-    extensions: [
-        "py",
-        "java",
-        "py",
-        "ruby",
-        "html",
-        "css",
-        "htm",
-        "php",
-        "js",
-        "jsx",
-        "ts",
-        "sh",
-        "bash",
-        "json",
-        "yml",
-        "yaml",
-        "csv",
-        "xml",
-        "txt",
-        "text",
-        "markdown",
-        "readme",
-    ],
-    names: ["package.json", "package-lock.json"],
-};
-exports.default = extensions;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const extensions = {
+    extensions: [
+        "py",
+        "java",
+        "py",
+        "ruby",
+        "html",
+        "css",
+        "htm",
+        "php", // images
+        "js",
+        "jsx",
+        "ts", // images
+        "sh",
+        "bash", // images
+        "json",
+        "yml",
+        "yaml",
+        "csv",
+        "xml", // file storage extensions
+        "txt",
+        "text",
+        "markdown",
+        "readme", // compressed files
+    ],
+    names: ["package.json", "package-lock.json"],
+};
+exports.default = extensions;

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

@@ -1,48 +1,47 @@
-/// <reference types="node" />
-declare const _default: {
-    config: {
-        port: number;
-        os: NodeJS.Platform;
-        editor: {
-            mode: null;
-            agent: null;
-            version: null;
-        };
-        dirPath: string;
-        configPath: string;
-        outputPath: string;
-        publicPath: string;
-        publicUrl: null;
-        contact: string;
-        language: string;
-        autoPlay: boolean;
-        projectType: string;
-        grading: string;
-        exercisesPath: string;
-        webpackTemplate: null;
-        disableGrading: boolean;
-        disabledActions: never[];
-        actions: never[];
-        entries: {
-            html: string;
-            vanillajs: string;
-            react: string;
-            node: string;
-            python3: string;
-            java: string;
-        };
-        suggestions: {
-            agent: null;
-        };
-        warnings: {
-            agent: null;
-        };
-    };
-    address: string;
-    currentExercise: null;
-    exercises: never[];
-    bugsLink: null;
-    videoSolutions: boolean;
-    localhostOnly: boolean;
-};
-export default _default;
+declare const _default: {
+    config: {
+        port: number;
+        os: NodeJS.Platform;
+        editor: {
+            mode: null;
+            agent: null;
+            version: null;
+        };
+        dirPath: string;
+        configPath: string;
+        outputPath: string;
+        publicPath: string;
+        publicUrl: null;
+        contact: string;
+        language: string;
+        autoPlay: boolean;
+        projectType: string;
+        grading: string;
+        exercisesPath: string;
+        webpackTemplate: null;
+        disableGrading: boolean;
+        disabledActions: never[];
+        actions: never[];
+        entries: {
+            html: string;
+            vanillajs: string;
+            react: string;
+            node: string;
+            python3: string;
+            java: string;
+        };
+        suggestions: {
+            agent: null;
+        };
+        warnings: {
+            agent: null;
+        };
+    };
+    address: string;
+    currentExercise: null;
+    exercises: never[];
+    bugsLink: null;
+    videoSolutions: boolean;
+    localhostOnly: boolean;
+};
+export default _default;

package/lib/managers/config/defaults.js

@@ -1,51 +1,51 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const os = require("os");
-exports.default = {
-    config: {
-        port: 3000,
-        os: (function () {
-            return os.platform();
-        })(),
-        editor: {
-            mode: null,
-            agent: null,
-            version: null,
-        },
-        dirPath: "./.learn",
-        configPath: "./learn.json",
-        outputPath: "./.learn/dist",
-        publicPath: "/preview",
-        publicUrl: null,
-        contact: "https://github.com/learnpack/learnpack/issues/new",
-        language: "auto",
-        autoPlay: true,
-        projectType: "tutorial",
-        grading: "isolated",
-        exercisesPath: "./",
-        webpackTemplate: null,
-        disableGrading: false,
-        disabledActions: [],
-        actions: [],
-        entries: {
-            html: "index.html",
-            vanillajs: "index.js",
-            react: "app.jsx",
-            node: "app.js",
-            python3: "app.py",
-            java: "app.java",
-        },
-        suggestions: {
-            agent: null,
-        },
-        warnings: {
-            agent: null,
-        },
-    },
-    address: "http://localhost",
-    currentExercise: null,
-    exercises: [],
-    bugsLink: null,
-    videoSolutions: false,
-    localhostOnly: false,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const os = require("os");
+exports.default = {
+    config: {
+        port: 3000,
+        os: (function () {
+            return os.platform();
+        })(),
+        editor: {
+            mode: null, // [extension, preview]
+            agent: null, // ["vscode", "os"] ("os" is the agent when running outside a coding editor
+            version: null, // By default downloads the latest version
+        },
+        dirPath: "./.learn",
+        configPath: "./learn.json",
+        outputPath: "./.learn/dist",
+        publicPath: "/preview",
+        publicUrl: null,
+        contact: "https://github.com/learnpack/learnpack/issues/new",
+        language: "auto",
+        autoPlay: true,
+        projectType: "tutorial", // [tutorial, project]
+        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",
+        },
+        suggestions: {
+            agent: null,
+        },
+        warnings: {
+            agent: null,
+        },
+    },
+    address: "http://localhost",
+    currentExercise: null,
+    exercises: [],
+    bugsLink: null,
+    videoSolutions: false,
+    localhostOnly: false, // if true, the exercise should not run on gitpod or codespaces but show an error message encouraging the user to run locally
+};

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

@@ -1,36 +1,36 @@
-import { IConfigObj } from "../../models/config";
-import { IFile } from "../../models/file";
-import { IExercise } from "../../models/exercise-obj";
-export declare const exercise: (path: string, position: number, configObject: IConfigObj) => IExercise;
-export declare const validateExerciseDirectoryName: (str: string) => boolean;
-export declare const isCodable: (str: string) => boolean;
-export declare const shouldBeVisible: (file: IFile) => boolean;
-export declare const isDirectory: (source: string) => boolean;
-export declare const detect: (configObject: IConfigObj | undefined, files: Array<string>) => {
-    language: string;
-    entry: string | undefined;
-} | {
-    language: null;
-    entry: null;
-} | undefined;
-export declare const filterFiles: (files: Array<string>, basePath?: string) => {
-    path: string;
-    name: string;
-    hidden: boolean;
-}[];
-declare const _default: {
-    exercise: (path: string, position: number, configObject: IConfigObj) => IExercise;
-    detect: (configObject: IConfigObj | undefined, files: string[]) => {
-        language: string;
-        entry: string | undefined;
-    } | {
-        language: null;
-        entry: null;
-    } | undefined;
-    filterFiles: (files: string[], basePath?: string) => {
-        path: string;
-        name: string;
-        hidden: boolean;
-    }[];
-};
-export default _default;
+import { IConfigObj } from "../../models/config";
+import { IFile } from "../../models/file";
+import { IExercise } from "../../models/exercise-obj";
+export declare const exercise: (path: string, position: number, configObject: IConfigObj) => IExercise;
+export declare const validateExerciseDirectoryName: (str: string) => boolean;
+export declare const isCodable: (str: string) => boolean;
+export declare const shouldBeVisible: (file: IFile) => boolean;
+export declare const isDirectory: (source: string) => boolean;
+export declare const detect: (configObject: IConfigObj | undefined, files: Array<string>) => {
+    language: string;
+    entry: string | undefined;
+} | {
+    language: null;
+    entry: null;
+} | undefined;
+export declare const filterFiles: (files: Array<string>, basePath?: string) => {
+    path: string;
+    name: string;
+    hidden: boolean;
+}[];
+declare const _default: {
+    exercise: (path: string, position: number, configObject: IConfigObj) => IExercise;
+    detect: (configObject: IConfigObj | undefined, files: Array<string>) => {
+        language: string;
+        entry: string | undefined;
+    } | {
+        language: null;
+        entry: null;
+    } | undefined;
+    filterFiles: (files: Array<string>, basePath?: string) => {
+        path: string;
+        name: string;
+        hidden: boolean;
+    }[];
+};
+export default _default;