@procamp/cli 0.0.1 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@procamp/cli",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Procamp CLI",
   "main": "dist/index.js",
   "files": [
@@ -22,7 +22,8 @@
   },
   "keywords": [
     "typescript",
-    "tsc"
+    "tsc",
+    "camp"
   ],
   "author": "Afrointelligence",
   "license": "ISC",
@@ -30,6 +31,7 @@
     "@types/adm-zip": "^0.5.0",
     "@types/fs-extra": "^11.0.1",
     "@types/inquirer": "^9.0.3",
+    "@types/jest": "^29.5.1",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^18.16.4",
     "@types/rimraf": "^4.0.5",
@@ -41,18 +43,13 @@
   },
   "dependencies": {
     "@procamp/course-validator": "^1.0.2",
-    "@types/jest": "^29.5.1",
     "adm-zip": "^0.5.10",
     "axios": "^1.4.0",
     "commander": "^10.0.1",
-    "ejs": "^3.1.9",
     "form-data": "^4.0.0",
     "fs-extra": "^11.1.1",
-    "glob-promise": "^6.0.2",
-    "globby": "^11.1.0",
     "inquirer": "^8.2.5",
     "js-yaml": "^4.1.0",
-    "path": "^0.12.7",
     "ts-jest": "^29.1.0"
   }
 }

package/readme.md

@@ -1,32 +1,296 @@
-# Getting started with Cmp cli
+# Camp CLI - Init Command
 
-This project was bootstrapped with [Cmp CLI](https://github.com/facebook/create-react-app)
+The `init` command allows you to initialize the project configuration for your camp.
 
-### ENV
+## Usage
 
-Copy content from .example.env to .env 
-## Available Scripts
+```bash
+camp init [options]
+```
 
-You can create the course directory with:
-### `cmp new`
+## Description
 
-In the course directory, you can run:
+The `init` command initializes the project configuration by prompting you to provide information about the camp. It creates a `meta.json` file with the provided details in the specified directory.
 
-### `cmp init`
+## Options
 
-This command allows you to create a meta.json file that 
-contains race configurations such as the title, id .
+- `-d, --directory <directory>`: The directory to initialize the project. If not specified, the current working directory will be used.
 
-### `cmp pack`
+## Prompts
 
-Archive the course, by default it archives 
-the current folder. The -d or --directory option 
-adds the path of the archived folder 
+During the initialization process, the following prompts will be presented:
 
-### `cmp publish`
-Publishes the course on the course manager platform. It uses the id in the meta.json 
-file for publishing the course
+1. **title**: The title of the folder. This will be used as the default if not provided.
+2. **author**: The author of the camp. Leave it empty if not applicable.
+3. **description**: The description of the camp. Leave it empty if not applicable.
+4. **version**: The version of the camp. Defaults to "1.0" if not provided.
+5. **courseId**: The ID of the course. This field is mandatory and must not be left empty.
 
-### `cmp g course`
-Create course with blueprint.yaml
+## Example
 
+To initialize the project configuration for your camp, run the following command:
+
+```bash
+camp init -d /path/to/project
+```
+
+This will prompt you to provide the required information and create a `meta.json` file in the specified directory.
+
+---
+
+# Camp CLI - New Command
+
+The `new` command generates a new course project with the specified name.
+
+## Usage
+
+```bash
+camp new <projectName>
+```
+
+## Description
+
+The `new` command generates a new course project with the given `<projectName>`. It creates a new directory with the project name and prompts for confirmation before proceeding.
+
+## Arguments
+
+- `<projectName>`: The name of the project to generate. This will be used as the directory name for the project.
+
+## Example
+
+To generate a new course project with the name "myproject", run the following command:
+
+```bash
+camp new myproject
+```
+
+This will create a new directory named "myproject" and initialize the project configuration within it using the `init` command.
+
+---
+
+# Camp CLI - Pack Command
+
+The `pack` command compresses files in the specified directory.
+
+## Usage
+
+```bash
+camp pack [options]
+```
+
+## Description
+
+The `pack` command compresses the files in the specified directory using the ZIP format. It excludes certain files and directories from compression, such as "_MACOSX" and "node_modules".
+
+## Options
+
+- `-d, --directory <directory>`: The directory to compress. If not specified, the current working directory will be used.
+
+## Example
+
+To compress files in the current working directory, run the following command:
+
+```bash
+camp pack
+```
+
+This will create a compressed ZIP file named ".output.zip" in the same directory.
+
+To compress files in a specific directory, provide the directory path using the `-d` or `--directory` option:
+
+```bash
+camp pack -d /path/to/directory
+```
+
+This will create a compressed ZIP file named ".output.zip" in the specified directory.
+
+---
+
+# Camp CLI - Login Command
+
+The `login` command allows you to log in to Procamp.
+
+## Usage
+
+```bash
+camp login
+```
+
+## Description
+
+The `login` command prompts you to enter your email and password to log in to Procamp. It then retrieves the access token and stores it securely in the config file.
+
+## Example
+
+To log in to Procamp, run the following command:
+
+```bash
+camp login
+```
+
+This command performs the following steps:
+
+1. Prompts you to enter your email and password.
+2. Sends a request to the Procamp authentication server to retrieve the access token.
+3. Stores the access token, client ID, and other necessary information securely in the config file.
+4. Displays a success message indicating that you are logged in.
+
+---
+
+# Camp CLI - Publish Command
+
+The `publish` command publishes the files to the service.
+
+## Usage
+
+```bash
+camp publish
+```
+
+## Description
+
+The `publish` command publishes the files to the service by compressing the files, validating the course, and then sending the compressed file to the service endpoint.
+
+## Prerequisites
+
+Before running the `publish` command, make sure you have completed the following steps:
+
+1. Ensure that the `meta.json` file exists in the current directory.
+2. Make sure you are logged in by setting up the config file with your credentials.
+
+## Example
+
+To publish the course files to the service, run the following command:
+
+```bash
+camp publish
+```
+
+This command performs the following steps:
+
+1. Checks if the `meta.json` file exists in the current directory.
+2. Validates the course files in the directory.
+3. Compresses the files into a ZIP file.
+4. Sends the ZIP file to the service endpoint using the course ID specified in the `meta.json` file.
+5. Displays the response from the service.
+
+Note: Make sure you are logged in by setting up the config file with your credentials before running the `publish` command.
+
+---
+
+# Camp CLI - Validate Command
+
+The `validate` command validates the course folder structure.
+
+## Usage
+
+```bash
+camp validate
+```
+
+## Description
+
+The `validate` command validates the course folder structure to ensure it meets the required format and structure. It checks for any missing or incorrectly organized files and directories.
+
+## Example
+
+To validate the course folder structure, run the following command:
+
+```bash
+camp validate
+```
+
+This command performs the following steps:
+
+1. Validates the course folder structure in the current directory.
+2. Checks for any missing or incorrectly organized files and directories.
+3. Displays the validation results.
+
+---
+
+# Camp CLI - Generate Command
+
+The `generate` command generates a course based on the provided blueprint.yaml file.
+
+## Usage
+
+```bash
+camp generate <key> <value>
+```
+
+## Description
+
+The `generate` command generates a course with the specified structure using the blueprint.yaml file. It creates directories and files based on the blueprint configuration.
+
+## Arguments
+
+- `<key>`: The key to specify the type of generation. Currently supported key: `course`.
+- `<value>`: The value associated with the key.
+
+## Example
+
+To generate a course structure based on the blueprint.yaml file, run the following command:
+
+```bash
+camp generate course .
+```
+
+This command performs the following steps:
+
+1. Reads the `blueprint.yaml` file in the current directory.
+2. Creates directories and files based on the blueprint configuration.
+3. Sets the course title, author, description, version, and courseId in the `meta.json` file.
+4. Creates `README.md` files in each directory.
+5. Generates the folder structure for chapters, lessons, and assessments based on the blueprint configuration.
+
+Note: Make sure you have the `blueprint.yaml` file in the current directory before running the `generate` command.
+
+---
+
+# Camp CLI - Set Command
+
+The `set` command allows you to set values for specific keys.
+
+## Usage
+
+```bash
+camp set <key> <value>
+```
+
+## Description
+
+The `set` command sets values for specific keys in the configuration files.
+
+## Available Keys
+
+- `courseId`: Sets the course ID in the `meta.json` file.
+- `clientId`: Sets the client ID in the config file.
+- `clientSecret`: Sets the client secret in the config file.
+
+## Examples
+
+To set the course ID, run the following command:
+
+```bash
+camp set courseId <courseId>
+```
+
+This command sets the provided `<courseId>` in the `meta.json` file.
+
+To set the client ID, run the following command:
+
+```bash
+camp set clientId <clientId>
+```
+
+This command sets the provided `<clientId>` in the config file.
+
+To set the client secret, run the following command:
+
+```bash
+camp set clientSecret <clientSecret>
+```
+
+This command sets the provided `<clientSecret>` in the config file.
+
+---

package/dist/utils/error.d.ts

@@ -1 +0,0 @@
-export declare function error(err: string): void;

package/dist/utils/error.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.error = void 0;
-function error(err) {
-    console.error('cmp \x1b[31m%s\x1b[0m', 'ERR!', err);
-}
-exports.error = error;
-//# sourceMappingURL=error.js.map

package/dist/utils/error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":";;;AAAA,SAAgB,KAAK,CAAC,GAAW;IAC/B,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC;AAFD,sBAEC","sourcesContent":["export function error(err: string) {\n  console.error('cmp \\x1b[31m%s\\x1b[0m', 'ERR!', err);\n}\n"]}