[#88] Fix error thrown when attempting to pack or unpack with --in and --out if configuration hadn't been completed.

Author: Fyorl

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.0.3
+
+### Improvements
+ - Added support for processing Level embedded Documents.
+ - (Mana) Added the `transformSerialized` option which can be used to modify the serialized content before it is written to disk.
+
+### Fixes
+ - Fixed error thrown when attempting to pack or unpack with `--in` and `--out` options if configuration hadn't been completed.
+
 ## 3.0.2
 
 ### Improvements

README.md

@@ -213,6 +213,7 @@ Extract the contents of a compendium pack into individual source files for each
     * **transformEntry:** *(entry: object, context: object): Promise<false|void>* A function that is called on every entry. Returning *false* indicates that the entry should be discarded.
     * **transformName:** *(entry: object, context: object): Promise<string|void>* A function that is called on every entry. The value returned from this will be used as the entry's filename and must include the appropriate file extension. If nothing is returned, an auto-generated name will be used instead.
     * **transformFolderName:** *(entry: object): Promise<string|void>* A function used to generate a directory name for an extracted Folder document when the `folders` option is used.
+    * **transformSerialized:** *(content: string, context: object): Promise<string>* A function that is called on the serialized content. The value returned from this will be written to disk.
     * **expandAdventures:** *boolean* Write documents embedded in Adventures to their own files. If the `folders` option is also supplied, the Adventure is treated like a folder, and written to `_Adventure.{yml|json}` instead of `_Folder.{yml|json}`. Additionally, all its entries are grouped into sub-folders by Document type.
     * **omitVolatile:** *boolean* When unpacking, diff the candidate entry against an existing one and only write it if non-volatile fields have changed. Currently, `_stats.createdTime`, `_stats.modifiedTime`, `_stats.lastModifiedBy`, `_stats.systemVersion`, and `_stats.coreVersion` are considered volatile.
     * **jsonOptions:** *object*

commands/package.mjs

@@ -317,7 +317,6 @@ function determinePaths(argv, operation) {
     return {};
   }
 
-  const typeDir = `${currentPackageType.toLowerCase()}s`;
   const compendiumName = argv.compendiumName ?? argv.value;
   if ( !compendiumName ) {
     console.error("No compendium name provided. Use `-n <name>` to supply it.");
@@ -327,7 +326,10 @@ function determinePaths(argv, operation) {
   let pack = operation === "pack" ? argv.outputDirectory : argv.inputDirectory;
   let source = operation === "pack" ? argv.inputDirectory : argv.outputDirectory;
   if ( pack ) pack = path.join(pack, compendiumName);
-  else pack = path.join(dataPath, "Data", typeDir, currentPackageId, "packs", compendiumName);
+  else {
+    const typeDir = `${currentPackageType.toLowerCase()}s`;
+    pack = path.join(dataPath, "Data", typeDir, currentPackageId, "packs", compendiumName);
+  }
   source ??= path.join(pack, "_source");
   if ( argv.nedb ) pack += ".db";
   return { source: path.resolve(path.normalize(source)), pack: path.resolve(path.normalize(pack)) };

lib/package.mjs

@@ -64,7 +64,8 @@ import { ClassicLevel } from "classic-level";
  *                                                    to that resolved location.
  * @property {NameTransformer} [transformFolderName]  A function used to generate a filename for an extracted folder
  *                                                    when the folders option is enabled.
- * @property {SerializationTransformer} [transformSerialized] A function used to transform serialized data before writing.
+ * @property {SerializationTransformer} [transformSerialized]  A function used to transform serialized data before
+ *                                                             writing.
  */
 
 /**
@@ -104,10 +105,11 @@ import { ClassicLevel } from "classic-level";
 
 /**
  * @callback SerializationTransformer
- * @param {string} serialized                 Serialized data
- * @param {object} context                    Additional context
- * @param {string} context.filename           Name of the file being transformed
- * @param {boolean} context.yaml              Whether this is YAML or JSON
+ * @param {string} content                    The data that will be written.
+ * @param {object} context                    Additional serialization context.
+ * @param {string} context.filename           The full path to the file that will be written.
+ * @param {boolean} context.yaml              Whether this is YAML or JSON.
+ * @returns {Promise<string>}                 The transformed data to write.
  */
 
 /**
@@ -187,6 +189,7 @@ const HIERARCHY = {
   scenes: {
     drawings: [],
     tokens: [],
+    levels: [],
     lights: [],
     notes: [],
     regions: [],
@@ -474,7 +477,8 @@ export async function extractPack(src, dest, {
   try {
     if ( nedb ) {
       await extractNedb(src, tmp, {
-        yaml, yamlOptions, jsonOptions, omitVolatile, log, collection, transformEntry, transformName, transformSerialized, existing: dest
+        yaml, yamlOptions, jsonOptions, omitVolatile, log, collection, transformEntry, transformName,
+        transformSerialized, existing: dest
       });
     }
     await extractClassicLevel(src, tmp, {
@@ -499,7 +503,8 @@ export async function extractPack(src, dest, {
  * @returns {Promise<void>}
  */
 async function extractNedb(pack, dest, {
-  yaml, yamlOptions, jsonOptions, omitVolatile, log, collection, transformEntry, transformName, transformSerialized, existing
+  yaml, yamlOptions, jsonOptions, omitVolatile, log, collection, transformEntry, transformName, transformSerialized,
+  existing
 }={}) {
   // Load the NeDB file.
   const db = new Datastore({ filename: pack, autoload: true });
@@ -524,7 +529,7 @@ async function extractNedb(pack, dest, {
     }
     const filename = path.join(dest, name);
     await serializeDocument(checkVolatile(doc, name, { collection, omitVolatile, existing, yaml }), filename, {
-      yaml, yamlOptions, jsonOptions, transformSerialized, filename: name
+      yaml, yamlOptions, jsonOptions, transformSerialized
     });
     if ( log ) console.log(`Wrote ${chalk.blue(name)}`);
   }
@@ -541,8 +546,8 @@ async function extractNedb(pack, dest, {
  * @returns {Promise<void>}
  */
 async function extractClassicLevel(pack, dest, {
-  yaml, yamlOptions, jsonOptions, log, folders, expandAdventures, omitVolatile, transformEntry, transformName, transformSerialized,
-  transformFolderName, existing
+  yaml, yamlOptions, jsonOptions, log, folders, expandAdventures, omitVolatile, transformEntry, transformName,
+  transformFolderName, transformSerialized, existing
 }={}) {
   // Load the directory as a ClassicLevel DB.
   const db = new ClassicLevel(pack, { keyEncoding: "utf8", valueEncoding: "json", createIfMissing: false });
@@ -574,7 +579,8 @@ async function extractClassicLevel(pack, dest, {
     if ( await transformEntry?.(doc, context) === false ) continue;
     if ( key.startsWith("!adventures") && expandAdventures ) {
       await extractAdventure(doc, dest, { folderMap }, {
-        yaml, yamlOptions, jsonOptions, log, folders, omitVolatile, transformEntry, transformName, transformSerialized, existing
+        yaml, yamlOptions, jsonOptions, log, folders, omitVolatile, transformEntry, transformName, transformSerialized,
+        existing
       });
       continue;
     }
@@ -591,7 +597,7 @@ async function extractClassicLevel(pack, dest, {
     }
     const filename = path.join(dest, name);
     await serializeDocument(checkVolatile(doc, name, { collection, omitVolatile, existing, yaml }), filename, {
-      yaml, yamlOptions, jsonOptions, transformSerialized, filename: name
+      yaml, yamlOptions, jsonOptions, transformSerialized
     });
     if ( log ) console.log(`Wrote ${chalk.blue(name)}`);
   }
@@ -611,7 +617,8 @@ async function extractClassicLevel(pack, dest, {
  * @param {string} [extractOptions.existing]          The location of existing serialized Documents.
  */
 async function extractAdventure(doc, dest, { folderMap }={}, {
-  yaml, yamlOptions, jsonOptions, log, folders, omitVolatile, transformEntry, transformName, transformSerialized, transformFolderName, existing
+  yaml, yamlOptions, jsonOptions, log, folders, omitVolatile, transformEntry, transformName, transformSerialized,
+  transformFolderName, existing
 }={}) {
   let adventureFolder;
 
@@ -661,7 +668,7 @@ async function extractAdventure(doc, dest, { folderMap }={}, {
         omitVolatile, existing, yaml,
         collection: embeddedCollectionName
       }), filename, {
-        yaml, yamlOptions, jsonOptions, transformSerialized, filename: embeddedName
+        yaml, yamlOptions, jsonOptions, transformSerialized
       });
       if ( log ) console.log(`Wrote ${chalk.blue(embeddedName)}`);
     }
@@ -671,7 +678,7 @@ async function extractAdventure(doc, dest, { folderMap }={}, {
   // Write the adventure itself
   const filename = path.join(dest, name);
   await serializeDocument(checkVolatile(doc, name, { omitVolatile, existing, yaml }), filename, {
-    yaml, yamlOptions, jsonOptions, transformSerialized, filename: name
+    yaml, yamlOptions, jsonOptions, transformSerialized
   });
   if ( log ) console.log(`Wrote ${chalk.blue(name)}`);
 }
@@ -808,7 +815,7 @@ function findSourceFiles(root, { yaml=false, recursive=false }={}) {
  * @param {string} filename                    The filename to write it to.
  * @param {Partial<ExtractOptions>} [options]  Options to configure serialization behavior.
  */
-async function serializeDocument(doc, filename, { yaml, yamlOptions, jsonOptions, transformSerialized, filename: destName }={}) {
+async function serializeDocument(doc, filename, { yaml, yamlOptions, jsonOptions, transformSerialized }={}) {
   fs.mkdirSync(path.dirname(filename), { recursive: true });
   let serialized;
   if ( yaml ) serialized = YAML.dump(doc, yamlOptions);
@@ -817,8 +824,8 @@ async function serializeDocument(doc, filename, { yaml, yamlOptions, jsonOptions
     serialized = JSON.stringify(doc, replacer, space) + "\n";
   }
 
-  if (typeof transformSerialized === "function") {
-    serialized = await transformSerialized(serialized, { yaml, filename: destName });
+  if ( typeof transformSerialized === "function" ) {
+    serialized = await transformSerialized(serialized, { yaml, filename });
   }
 
   fs.writeFileSync(filename, serialized);