Cleanup pass and add Readme

Author: cswendrowski

README.md

@@ -1,2 +1,110 @@
 # foundryvtt-cli
 The official Foundry VTT CLI
+
+## Installation
+```bash
+npm install -g foundryvtt-cli
+```
+
+## Usage
+### Help
+```bash
+fvtt --help
+```
+
+### Current CLI Version
+```bash
+fvtt --version
+```
+
+### Configuration
+```bash
+fvtt configure
+```
+Determines if your configuration is correct and if not, prompts you to fix it.
+
+#### View
+```bash
+fvtt configure view
+```
+
+View your current configuration.
+
+
+#### Set
+```bash
+fvtt configure set "key" "value"
+```
+
+Set a configuration value.
+
+#### Get
+```bash
+fvtt configure get "key"
+```
+
+Get a configuration value.
+
+#### Path
+```bash
+fvtt configure path
+```
+Outputs the path to your configuration file.
+
+### Launch
+
+```bash
+fvtt launch
+```
+Launches Foundry VTT. Available options are:
+* `--demo` - Launches Foundry VTT in demo mode.
+* `--port 30000` - Launches Foundry VTT on a specific port.
+* `--world my-world` - Launches Foundry VTT straight into a specific world.
+* `--noupnp` - Disable UPnP port forwarding.
+* `--noupdate` - Disable automatic update checking.
+* `--adminKey "ABC123"` - The admin key to secure Foundry VTT's Setup screen with.
+
+### Package
+
+```bash
+fvtt package
+```
+Output the current working package, if any.
+
+#### Workon
+```bash
+fvtt package workon "1001-fish" --type "module"
+```
+Swaps to working on a specific package, eliminating the need to pass `--type` and `--id` to other package commands.
+
+#### Clear
+```bash
+fvtt package clear
+```
+Clears the current working package.
+
+#### Unpack
+```bash
+fvtt package unpack "compendiumName"
+```
+Reads a LevelDB database from the current Package /packs/ directory and writes each document as a serialized Object to its own file.
+There are a number of options available to customize the output, check out `fvtt package unpack --help` for more information.
+
+#### Pack
+```bash
+fvtt package pack "compendiumName"
+```
+
+Reads a directory of serialized Objects and writes them to a LevelDB database in the current Package /packs/ directory. There are a number of options available to customize the operation, check out `fvtt package pack --help` for more information.
+
+## Development
+```bash
+git clone
+cd foundryvtt-cli
+npm install
+npm run build
+npm link
+```
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

commands/configuration.mjs

@@ -1,5 +1,9 @@
 import Config from "../config.mjs";
 
+/**
+ * Get the command object for the configuration command
+ * @returns {{handler: ((function(*): Promise<void>)|*), builder: builder, describe: string, command: string}}
+ */
 export function getCommand() {
     return {
         command: "configure [action] [key] [value]",

commands/launch.mjs

@@ -2,6 +2,10 @@ import Config from "../config.mjs";
 import {spawn} from "child_process";
 import path from "path";
 
+/**
+ * Get the command object for the launch command
+ * @returns {{handler: ((function(*): Promise<void>)|*), builder: builder, describe: string, command: string}}
+ */
 export function getCommand() {
     return {
         command: "launch",

commands/package.mjs

@@ -4,6 +4,10 @@ import yaml from "js-yaml";
 import path from "path";
 import fs from "fs";
 
+/**
+ * Get the command object for the package command
+ * @returns {{handler: ((function(*): Promise<void>)|*), builder: builder, describe: string, command: string}}
+ */
 export function getCommand() {
     let currentPackageId = Config.instance.get("currentPackageId");
     let currentPackageType = Config.instance.get("currentPackageType");
@@ -90,6 +94,10 @@ export function getCommand() {
                 }
 
                 default: {
+                    if ( !currentPackageId ) {
+                        console.error("No package ID is currently set. Use `package workon <id>` to set it.");
+                        return;
+                    }
                     console.log(`Currently in ${currentPackageType} ${currentPackageId}`);
                     break;
                 }
@@ -101,6 +109,7 @@ export function getCommand() {
 
     /**
      * Set the current package ID and type
+     * @param {Object} argv                  The command line arguments
      * @private
      */
     function _handleWorkon(argv) {
@@ -144,6 +153,11 @@ export function getCommand() {
 
     /* -------------------------------------------- */
 
+    /**
+     * Normalize a path to use POSIX separators
+     * @param {string} pathToNormalize      The path to normalize
+     * @returns {string}
+     */
     function normalizePath(pathToNormalize) {
         return path.normalize(pathToNormalize).split(path.sep).join(path.posix.sep);
     }
@@ -152,6 +166,7 @@ export function getCommand() {
 
     /**
      * Discover the list of all Packages in the dataPath
+     * @param {Object} argv                  The command line arguments
      * @returns {*}
      */
     function discoverPackageDirectory(argv) {
@@ -228,7 +243,7 @@ export function getCommand() {
 
     /**
      * Load a pack from a directory and serialize the DB entries, each to their own file
-     * @param argv
+     * @param {Object} argv                  The command line arguments
      * @returns {Promise<void>}
      * @private
      */
@@ -258,14 +273,8 @@ export function getCommand() {
             if (!fs.existsSync(outputDir)) {
                 fs.mkdirSync(outputDir, {recursive: true});
             }
-            const entries = new Map();
             for await (const [key, value] of db.iterator()) {
                 const name = value.name ? `${value.name.toLowerCase().replaceAll(" ", "_")}_${value._id}` : key;
-                entries.set(name, value);
-            }
-            await db.close();
-
-            for (const [name, value] of entries) {
                 let fileName;
                 if ( argv.yaml ) {
                     fileName = `${outputDir}/${name}.yml`;
@@ -277,6 +286,7 @@ export function getCommand() {
                 }
                 console.log(`Wrote ${fileName}`);
             }
+            await db.close();
         }
         catch (err) {
             console.error(err);
@@ -287,7 +297,7 @@ export function getCommand() {
 
     /**
      * Read serialized files from a directory and write them to a pack db
-     * @param argv
+     * @param {Object} argv                  The command line arguments
      * @returns {Promise<void>}
      * @private
      */
@@ -312,18 +322,20 @@ export function getCommand() {
         try {
             // Load the directory as a ClassicLevel db
             const db = new ClassicLevel(packDir, {keyEncoding: "utf8", valueEncoding: "json"});
+            const batch = db.batch();
 
             // Iterate over all YAML files in the input directory, writing them to the db
             const files = fs.readdirSync(inputDir);
             for ( const file of files ) {
                 const fileContents = fs.readFileSync(path.join(inputDir, file));
                 const value = file.endsWith(".yml") ? yaml.load(fileContents) : JSON.parse(fileContents);
-                await db.put(value._id, value);
+                batch.put(value._id, value);
                 console.log(`Packed ${value._id}${value.name ? ` (${value.name})` : ""}`);
             }
+            await batch.write();
         }
         catch (err) {
             console.error(err);
         }
     }
-}
+}

config.mjs

@@ -11,6 +11,10 @@ export default class Config {
 
     /* -------------------------------------------- */
 
+    /**
+     * Get the singleton instance of the Config class
+     * @returns {Config}
+     */
     static get instance() {
         if (!this.#instance) {
             this.#instance = new Config();
@@ -40,18 +44,32 @@ export default class Config {
 
     /* -------------------------------------------- */
 
+    /**
+     * Get the entire configuration object
+     * @returns {Map<string, *>}
+     */
     getAll() {
         return this.#config;
     }
 
     /* -------------------------------------------- */
 
+    /**
+     * Get a specific configuration value
+     * @param {string} key      The configuration key
+     * @returns {*}
+     */
     get(key) {
         return this.#config[key];
     }
 
     /* -------------------------------------------- */
 
+    /**
+     * Set a specific configuration value
+     * @param {string} key      The configuration key
+     * @param {*} value         The configuration value
+     */
     set(key, value) {
         this.#config[key] = value;
 
@@ -61,8 +79,10 @@ export default class Config {
 
     /* -------------------------------------------- */
 
+    /**
+     * Write the configuration to disk
+     */
     #writeConfig() {
-        // Write to disk
         fs.writeFileSync(this.configPath, yaml.dump(this.#config));
     }
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@foundryvtt/fvtt",
+  "name": "@foundryvtt/foundryvtt-cli",
   "productName": "Foundry VTT CLI",
   "description": "The Official CLI for Foundry VTT",
   "version": "0.0.4",