@learnpack/learnpack 2.1.44 → 2.1.46

package/README.md

@@ -1,55 +1,36 @@
-# learnpack
-
-Create, sell or download and take learning amazing learning packages.
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/learnpack.svg)](https://npmjs.org/package/learnpack)
-[![Downloads/week](https://img.shields.io/npm/dw/learnpack.svg)](https://npmjs.org/package/learnpack)
-[![License](https://img.shields.io/npm/l/learnpack.svg)](https://github.com/learnpack/learnpack-cli/blob/master/package.json)
-
+# learnpack
+
+Create, sell or download and take learning amazing learning packages.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/learnpack.svg)](https://npmjs.org/package/learnpack)
+[![Downloads/week](https://img.shields.io/npm/dw/learnpack.svg)](https://npmjs.org/package/learnpack)
+[![License](https://img.shields.io/npm/l/learnpack.svg)](https://github.com/learnpack/learnpack-cli/blob/master/package.json)
+
 <!-- toc -->
 * [learnpack](#learnpack)
 * [Usage](#usage)
 * [Commands](#commands)
-<!-- tocstop -->
-
-- [learnpack](#learnpack)
-- [Usage](#usage)
-- [Commands](#commands)
-<!-- tocstop -->
-
-# Usage
-
+<!-- tocstop -->
+
+# Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.44 win32-x64 node-v20.10.0
+@learnpack/learnpack/2.1.46 win32-x64 node-v20.10.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
 ...
 ```
-<!-- usagestop -->
-
-```sh-session
-$ npm install -g @learnpack/learnpack
-$ learnpack COMMAND
-running command...
-$ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.42 win32-x64 node-v20.10.0
-$ learnpack --help [COMMAND]
-USAGE
-  $ learnpack COMMAND
-...
-```
-
-<!-- usagestop -->
-
-# Commands
-
+<!-- usagestop -->
+
+# Commands
+
 <!-- commands -->
 * [`learnpack audit`](#learnpack-audit)
 * [`learnpack clean`](#learnpack-clean)
@@ -93,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.44/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -108,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -126,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -157,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -175,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -193,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -328,7 +309,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -349,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.44/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -363,323 +344,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\test.ts)_
-<!-- commandsstop -->
-
-- [`learnpack audit`](#learnpack-audit)
-- [`learnpack clean`](#learnpack-clean)
-- [`learnpack download [PACKAGE]`](#learnpack-download-package)
-- [`learnpack help [COMMAND]`](#learnpack-help-command)
-- [`learnpack init`](#learnpack-init)
-- [`learnpack login [PACKAGE]`](#learnpack-login-package)
-- [`learnpack logout [PACKAGE]`](#learnpack-logout-package)
-- [`learnpack plugins`](#learnpack-plugins)
-- [`learnpack plugins:install PLUGIN...`](#learnpack-pluginsinstall-plugin)
-- [`learnpack plugins:link PLUGIN`](#learnpack-pluginslink-plugin)
-- [`learnpack plugins:uninstall PLUGIN...`](#learnpack-pluginsuninstall-plugin)
-- [`learnpack plugins:update`](#learnpack-pluginsupdate)
-- [`learnpack publish [PACKAGE]`](#learnpack-publish-package)
-- [`learnpack start`](#learnpack-start)
-- [`learnpack test [EXERCISESLUG]`](#learnpack-test-exerciseslug)
-
-## `learnpack audit`
-
-learnpack audit is the command in charge of creating an auditory of the repository
-
-```
-USAGE
-  $ learnpack audit
-
-DESCRIPTION
-  ...
-  learnpack audit checks for the following information in a repository:
-       1. The configuration object has slug, repository and description. (Error)
-       2. The command learnpack clean has been run. (Error)
-       3. If a markdown or test file doesn't have any content. (Error)
-       4. The links are accessing to valid servers. (Error)
-       5. The relative images are working (If they have the shortest path to the image or if the images exists in the
-  assets). (Error)
-       6. The external images are working (If they are pointing to a valid server). (Error)
-       7. The exercises directory names are valid. (Error)
-       8. If an exercise doesn't have a README file. (Error)
-       9. The exercises array (Of the config file) has content. (Error)
-       10. The exercses have the same translations. (Warning)
-       11. The .gitignore file exists. (Warning)
-       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.42/src\commands\audit.ts)_
-
-## `learnpack clean`
-
-Clean the configuration object
-
-```
-USAGE
-  $ learnpack clean
-
-DESCRIPTION
-  ...
-     Extra documentation goes here
-```
-
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\clean.ts)_
-
-## `learnpack download [PACKAGE]`
-
-Describe the command here
-
-```
-USAGE
-  $ learnpack download [PACKAGE]
-
-ARGUMENTS
-  PACKAGE  The unique string that identifies this package on learnpack
-
-DESCRIPTION
-  ...
-  Extra documentation goes here
-```
-
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\download.ts)_
-
-## `learnpack help [COMMAND]`
-
-display help for learnpack
-
-```
-USAGE
-  $ learnpack help [COMMAND]
-
-ARGUMENTS
-  COMMAND  command to show help for
-
-OPTIONS
-  --all  see all commands in CLI
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src\commands\help.ts)_
-
-## `learnpack init`
-
-Create a new learning package: Book, Tutorial or Exercise
-
-```
-USAGE
-  $ learnpack init
-
-OPTIONS
-  -h, --grading  show CLI help
-```
-
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\init.ts)_
-
-## `learnpack login [PACKAGE]`
-
-Describe the command here
-
-```
-USAGE
-  $ learnpack login [PACKAGE]
-
-ARGUMENTS
-  PACKAGE  The unique string that identifies this package on learnpack
-
-DESCRIPTION
-  ...
-     Extra documentation goes here
-```
-
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\login.ts)_
-
-## `learnpack logout [PACKAGE]`
-
-Describe the command here
-
-```
-USAGE
-  $ learnpack logout [PACKAGE]
-
-ARGUMENTS
-  PACKAGE  The unique string that identifies this package on learnpack
-
-DESCRIPTION
-  ...
-     Extra documentation goes here
-```
-
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\logout.ts)_
-
-## `learnpack plugins`
-
-list installed plugins
-
-```
-USAGE
-  $ learnpack plugins
-
-OPTIONS
-  --core  show core plugins
-
-EXAMPLE
-  $ learnpack plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\index.ts)_
-
-## `learnpack plugins:install PLUGIN...`
-
-installs a plugin into the CLI
-
-```
-USAGE
-  $ learnpack plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN  plugin to install
-
-OPTIONS
-  -f, --force    yarn install with force flag
-  -h, --help     show CLI help
-  -v, --verbose
-
-DESCRIPTION
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
-
-ALIASES
-  $ learnpack plugins:add
-
-EXAMPLES
-  $ learnpack plugins:install myplugin
-  $ learnpack plugins:install https://github.com/someuser/someplugin
-  $ learnpack plugins:install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\install.ts)_
-
-## `learnpack plugins:link PLUGIN`
-
-links a plugin into the CLI for development
-
-```
-USAGE
-  $ learnpack plugins:link PLUGIN
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-OPTIONS
-  -h, --help     show CLI help
-  -v, --verbose
-
-DESCRIPTION
-  Installation of a linked plugin will override a user-installed or core plugin.
-
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-EXAMPLE
-  $ learnpack plugins:link myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\link.ts)_
-
-## `learnpack plugins:uninstall PLUGIN...`
-
-removes a plugin from the CLI
-
-```
-USAGE
-  $ learnpack plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN  plugin to uninstall
-
-OPTIONS
-  -h, --help     show CLI help
-  -v, --verbose
-
-ALIASES
-  $ learnpack plugins:unlink
-  $ learnpack plugins:remove
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\uninstall.ts)_
-
-## `learnpack plugins:update`
-
-update installed plugins
-
-```
-USAGE
-  $ learnpack plugins:update
-
-OPTIONS
-  -h, --help     show CLI help
-  -v, --verbose
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\update.ts)_
-
-## `learnpack publish [PACKAGE]`
-
-Describe the command here
-
-```
-USAGE
-  $ learnpack publish [PACKAGE]
-
-ARGUMENTS
-  PACKAGE  The unique string that identifies this package on learnpack
-
-DESCRIPTION
-  ...
-     Extra documentation goes here
-```
-
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\publish.ts)_
-
-## `learnpack start`
-
-Runs a small server with all the exercise instructions
-
-```
-USAGE
-  $ learnpack start
-
-OPTIONS
-  -D, --disableGrading                disble grading functionality
-  -d, --debug                         debugger mode for more verbage
-  -e, --editor=extension|preview      [preview, extension]
-  -g, --grading=isolated|incremental  [isolated, incremental]
-  -h, --host=host                     server host
-  -p, --port=port                     server port
-  -v, --version=version               E.g: 1.0.1
-  -w, --watch                         Watch for file changes
-```
-
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\start.ts)_
-
-## `learnpack test [EXERCISESLUG]`
-
-Test exercises
-
-```
-USAGE
-  $ learnpack test [EXERCISESLUG]
-
-ARGUMENTS
-  EXERCISESLUG  The name of the exercise to test
-```
-
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.42/src\commands\test.ts)_
-
-<!-- commandsstop -->
-
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.46/src\commands\test.ts)_
+<!-- commandsstop -->
+
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 // import path from "path";
 const command_1 = require("@oclif/command");
 const SessionCommand_1 = require("../utils/SessionCommand");
@@ -12,7 +11,6 @@ const fileQueue_1 = require("../utils/fileQueue");
 const file_1 = require("../managers/file");
 const misc_1 = require("../utils/misc");
 const osOperations_1 = require("../utils/osOperations");
-const cli_ux_1 = require("cli-ux");
 const checkNotInstalled_1 = require("../utils/checkNotInstalled");
 class StartCommand extends SessionCommand_1.default {
     // 🛑 IMPORTANT
@@ -22,54 +20,25 @@ class StartCommand extends SessionCommand_1.default {
         await this.initSession(flags);
     }
     async run() {
-        var e_1, _a;
-        var _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         // get configuration object
-        const configObject = (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.get();
+        const configObject = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         // TODO: console.log(this.config.platform); get the platfrom from Oclif
         const hasXDG = await osOperations_1.eventManager.checkXDGInstalled();
         const installedPlugins = this.config.plugins.map(plugin => {
             return `${plugin.pjson.name}`;
         });
-        const neededToInstallPlugins = checkNotInstalled_1.checkNotInstalledPlugins((configObject === null || configObject === void 0 ? void 0 : configObject.exercises) || [], installedPlugins);
-        if (neededToInstallPlugins.length > 0) {
-            console_1.default.error("These plugins are not installed but required: ", neededToInstallPlugins);
-            const confirmInstall = await cli_ux_1.cli.confirm("Do you want to install the needed plugins? (y/n)");
-            if (confirmInstall) {
-                console_1.default.info("Installing the needed plugins...");
-                try {
-                    for (var neededToInstallPlugins_1 = tslib_1.__asyncValues(neededToInstallPlugins), neededToInstallPlugins_1_1; neededToInstallPlugins_1_1 = await neededToInstallPlugins_1.next(), !neededToInstallPlugins_1_1.done;) {
-                        const p = neededToInstallPlugins_1_1.value;
-                        await this.config.runCommand(`plugins:install`, [p]);
-                        console_1.default.log(`Plugin ${p} installed`);
-                    }
-                }
-                catch (e_1_1) { e_1 = { error: e_1_1 }; }
-                finally {
-                    try {
-                        if (neededToInstallPlugins_1_1 && !neededToInstallPlugins_1_1.done && (_a = neededToInstallPlugins_1.return)) await _a.call(neededToInstallPlugins_1);
-                    }
-                    finally { if (e_1) throw e_1.error; }
-                }
-                console_1.default.log("All needed plugins installed, please restart LearnPack to load them.");
-                console_1.default.info("Run: $ learnpack start");
-                this.exit(0);
-            }
-            else {
-                console_1.default.error("You need to install the plugins to complete this exercise");
-                console_1.default.info("To install the plugins run each of the following commands: ");
-                for (const p of neededToInstallPlugins) {
-                    console_1.default.log(`learnpack plugins:install ${p}`);
-                }
-                this.exit(1);
-            }
-        }
         if (configObject) {
             const { config } = configObject;
             // build exerises
-            (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.buildIndex();
-            console_1.default.debug(`Grading: ${config === null || config === void 0 ? void 0 : config.grading} ${((_d = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _d === void 0 ? void 0 : _d.includes("test")) ? "(disabled)" : ""}, editor: ${config === null || config === void 0 ? void 0 : config.editor.mode} ${config === null || config === void 0 ? void 0 : config.editor.version}, for ${Array.isArray(configObject === null || configObject === void 0 ? void 0 : configObject.exercises) ? configObject === null || configObject === void 0 ? void 0 : configObject.exercises.length :
+            (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.buildIndex();
+            console_1.default.debug(`Grading: ${config === null || config === void 0 ? void 0 : config.grading} ${((_c = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _c === void 0 ? void 0 : _c.includes("test")) ? "(disabled)" : ""}, editor: ${config === null || config === void 0 ? void 0 : config.editor.mode} ${config === null || config === void 0 ? void 0 : config.editor.version}, for ${Array.isArray(configObject === null || configObject === void 0 ? void 0 : configObject.exercises) ? configObject === null || configObject === void 0 ? void 0 : configObject.exercises.length :
                 0} exercises found`);
+            const neededPlugins = await checkNotInstalled_1.checkNotInstalledPlugins((configObject === null || configObject === void 0 ? void 0 : configObject.exercises) || [], installedPlugins, this);
+            const allDepsInstalled = await checkNotInstalled_1.checkNotInstalledDependencies(neededPlugins.needed);
+            if (!allDepsInstalled) {
+                this.exit(1);
+            }
             const appAlreadyExists = file_1.checkIfDirectoryExists(`${config === null || config === void 0 ? void 0 : config.dirPath}/_app`);
             if (!appAlreadyExists) {
                 // download app and decompress
@@ -87,9 +56,9 @@ class StartCommand extends SessionCommand_1.default {
                     path: `${config.dirPath}/vscode_queue.json`,
                 });
                 if (configObject.exercises) {
-                    const agent = ((_e = configObject.config) === null || _e === void 0 ? void 0 : _e.editor.agent) || "";
-                    const path = ((_f = configObject.config) === null || _f === void 0 ? void 0 : _f.dirPath) || "";
-                    const tutorialSlug = ((_g = configObject.config) === null || _g === void 0 ? void 0 : _g.slug) || "";
+                    const agent = ((_d = configObject.config) === null || _d === void 0 ? void 0 : _d.editor.agent) || "";
+                    const path = ((_e = configObject.config) === null || _e === void 0 ? void 0 : _e.dirPath) || "";
+                    const tutorialSlug = ((_f = configObject.config) === null || _f === void 0 ? void 0 : _f.slug) || "";
                     const steps = configObject.exercises.map((e, index) => ({
                         slug: e.slug,
                         position: e.position || index,

package/lib/managers/config/index.js

@@ -51,7 +51,6 @@ const getCodespacesNamespace = () => {
     if (!codespace_name ||
         codespace_name === "" ||
         codespace_name === undefined ||
-        // ! I added this line
         codespace_name === "$CODESPACE_NAME") {
         return null;
     }
@@ -143,7 +142,7 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
         console_1.default.debug("Config version not found, downloading default.");
         const resp = await fetch("https://raw.githubusercontent.com/learnpack/ide/master/package.json");
         const packageJSON = await resp.json();
-        configObj.config.editor.version = packageJSON.version || "3.1.22";
+        configObj.config.editor.version = packageJSON.version || "3.1.23";
     }
     configObj.config.dirPath = "./" + confPath.base;
     configObj.config.exercisesPath = getExercisesPath(confPath.base) || "./";

package/lib/utils/checkNotInstalled.d.ts

@@ -1,2 +1,8 @@
 import { IExercise } from "../models/exercise-obj";
-export declare const checkNotInstalledPlugins: (exercises: IExercise[], installedPlugins: string[]) => string[];
+declare type TNeededPlugins = {
+    needed: string[];
+    notInstalled: string[];
+};
+export declare const checkNotInstalledPlugins: (exercises: IExercise[], installedPlugins: string[], command: any) => Promise<TNeededPlugins>;
+export declare const checkNotInstalledDependencies: (neededPlugins: string[]) => Promise<boolean | undefined>;
+export {};