@learnpack/learnpack 2.0.2 → 2.0.5

package/README.md

@@ -8,49 +8,45 @@ Create, sell or download and take learning amazing learning packages
 [![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)
+* [learnpack](#learnpack)
+* [Usage](#usage)
+* [Commands](#commands)
 <!-- tocstop -->
 
 # Usage
 
 <!-- usage -->
-
 ```sh-session
 $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.0.2 win32-x64 node-v16.14.0
+@learnpack/learnpack/2.0.5 win32-x64 node-v16.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
 ...
 ```
-
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-
-- [`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)
+* [`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`
 
@@ -67,7 +63,7 @@ DESCRIPTION
        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
+       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)
@@ -78,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.0.2/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -93,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -111,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -142,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -160,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -178,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -218,15 +214,15 @@ DESCRIPTION
 
   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
+  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 myplugin 
   $ learnpack plugins:install https://github.com/someuser/someplugin
   $ learnpack plugins:install someuser/someplugin
 ```
@@ -251,7 +247,7 @@ OPTIONS
 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'
+  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
@@ -313,7 +309,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -334,7 +330,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.2/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -348,6 +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.0.2/src\commands\test.ts)_
-
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.0.5/src\commands\test.ts)_
 <!-- commandsstop -->

package/bin/run

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const fs = require('fs')
 const path = require('path')

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"2.0.5","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.0.2",
+  "version": "2.0.5",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"
@@ -90,7 +90,8 @@
     "oclif"
   ],
   "license": "UNLICENSED",
-  "main": "src/index.js",
+  "main": "../bin/index.js",
+  "types": "../bin/index.d.ts",
   "oclif": {
     "commands": "./src/commands",
     "bin": "learnpack",
@@ -117,6 +118,7 @@
   },
   "scripts": {
     "postpack": "rm -f oclif.manifest.json && eslint . --ext .ts --config .eslintrc",
+    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "pre": "node ./test/precommit/index.ts",
     "test": "NODE_ENV=test nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif-dev readme && git add README.md",

package/src/commands/clean.ts

@@ -1,29 +1,29 @@
-// import {flags} from '@oclif/command'
-import Console from "../utils/console";
-import SessionCommand from "../utils/SessionCommand";
-
-class CleanCommand extends SessionCommand {
-  static description = `Clean the configuration object
-  ...
-  Extra documentation goes here
-  `;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  async init() {
-    const { flags } = this.parse(CleanCommand);
-    await this.initSession(flags);
-  }
-
-  async run() {
-    const { flags } = this.parse(CleanCommand);
-
-    this.configManager?.clean();
-
-    Console.success("Package cleaned successfully, ready to publish");
-  }
-}
-
-export default CleanCommand;
+// import {flags} from '@oclif/command'
+import Console from "../utils/console";
+import SessionCommand from "../utils/SessionCommand";
+
+class CleanCommand extends SessionCommand {
+  static description = `Clean the configuration object
+  ...
+  Extra documentation goes here
+  `;
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  };
+
+  async init() {
+    const { flags } = this.parse(CleanCommand);
+    await this.initSession(flags);
+  }
+
+  async run() {
+    const { flags } = this.parse(CleanCommand);
+
+    this.configManager?.clean();
+
+    Console.success("Package cleaned successfully, ready to publish");
+  }
+}
+
+export default CleanCommand;

package/src/commands/download.ts

@@ -1,62 +1,62 @@
-import { Command /* , flags */ } from "@oclif/command";
-// import fetch from 'node-fetch'
-import { clone } from "../managers/file";
-import Console from "../utils/console";
-import api from "../utils/api";
-import { askPackage } from "../ui/download";
-// const BaseCommand = require('../utils/BaseCommand');
-
-class DownloadCommand extends Command {
-  static description = `Describe the command here
-...
-Extra documentation goes here
-`;
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  };
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ];
-  // async init() {
-  //   const {flags} = this.parse(DownloadCommand)
-  //   await this.initSession(flags)
-  // }
-
-  async run() {
-    const { /* flags, */ args } = this.parse(DownloadCommand);
-    // start watching for file changes
-    let _package: string = args.package;
-    if (!_package) {
-      _package = (await askPackage()) as string;
-    }
-
-    if (!_package) {
-      return null;
-    }
-
-    try {
-      const packageInfo = await api.getAllPackages({ slug: _package });
-      if (packageInfo.results.length === 0)
-        Console.error(`Package ${_package} not found`);
-      else
-        clone(packageInfo.results[0].repository)
-          .then(_result => {
-            Console.success("Successfully downloaded");
-            Console.info(
-              `You can now CD into the folder like this: $ cd ${_package}`
-            );
-          })
-          .catch(error => Console.error(error.message || error));
-    } catch {}
-  }
-}
-
-export default DownloadCommand;
+import { Command /* , flags */ } from "@oclif/command";
+// import fetch from 'node-fetch'
+import { clone } from "../managers/file";
+import Console from "../utils/console";
+import api from "../utils/api";
+import { askPackage } from "../ui/download";
+// const BaseCommand = require('../utils/BaseCommand');
+
+class DownloadCommand extends Command {
+  static description = `Describe the command here
+...
+Extra documentation goes here
+`;
+
+  static flags: any = {
+    // name: flags.string({char: 'n', description: 'name to print'}),
+  };
+
+  static args = [
+    {
+      name: "package", // name of arg to show in help and reference with args[name]
+      required: false, // make the arg required with `required: true`
+      description:
+        "The unique string that identifies this package on learnpack", // help description
+      hidden: false, // hide this arg from help
+    },
+  ];
+  // async init() {
+  //   const {flags} = this.parse(DownloadCommand)
+  //   await this.initSession(flags)
+  // }
+
+  async run() {
+    const { /* flags, */ args } = this.parse(DownloadCommand);
+    // start watching for file changes
+    let _package: string = args.package;
+    if (!_package) {
+      _package = (await askPackage()) as string;
+    }
+
+    if (!_package) {
+      return null;
+    }
+
+    try {
+      const packageInfo = await api.getAllPackages({ slug: _package });
+      if (packageInfo.results.length === 0)
+        Console.error(`Package ${_package} not found`);
+      else
+        clone(packageInfo.results[0].repository)
+          .then(_result => {
+            Console.success("Successfully downloaded");
+            Console.info(
+              `You can now CD into the folder like this: $ cd ${_package}`
+            );
+          })
+          .catch(error => Console.error(error.message || error));
+    } catch {}
+  }
+}
+
+export default DownloadCommand;