@learnpack/learnpack 2.1.42 → 2.1.44

package/README.md

@@ -1,36 +1,55 @@
-# 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 -->
-
-# Usage
-
+<!-- tocstop -->
+
+- [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.1.42 win32-x64 node-v20.10.0
+@learnpack/learnpack/2.1.44 win32-x64 node-v20.10.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
 ...
 ```
-<!-- usagestop -->
-
-# Commands
-
+<!-- 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
+
 <!-- commands -->
 * [`learnpack audit`](#learnpack-audit)
 * [`learnpack clean`](#learnpack-clean)
@@ -74,7 +93,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.42/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -89,7 +108,7 @@ 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)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -107,7 +126,7 @@ 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)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -138,7 +157,7 @@ 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)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -156,7 +175,7 @@ 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)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -174,7 +193,7 @@ 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)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -309,7 +328,7 @@ 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)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -330,7 +349,7 @@ OPTIONS
   -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)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.44/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,7 +363,323 @@ 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.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 -->
+
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.42","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":"[preview, extension]","options":["extension","preview"]},"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.44","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":"[preview, extension]","options":["extension","preview"]},"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.42",
+  "version": "2.1.44",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"