extwee 1.6.0 → 2.0.2

package/src/TweeParser.js

@@ -1,255 +1,161 @@
-const Passage = require('./Passage.js');
-const Story = require('./Story.js');
-/**
- * @class TweeParser
- * @module TweeParser
- */
-class TweeParser {
-	/**
-     * @method TweeParser
-     * @constructor
-     */
-    constructor (content) {
-        this.story = new Story();
-        this._passageMetadatError = false;
-        this._storydataError = false;
-
-        this.parse(content);
-    }
-
-    /**
-     * @method parse
-     * @returns Array or Null on error
-     */
-    parse(fileContents) {
-
-      let passages = [];
-
-    	// Check if there are extra content in the files
-    	// If so, cut it all out for the parser
-    	if(fileContents[0] != ':' && fileContents[1] != ':') {
-
-    		let firstPassagePos = fileContents.indexOf('::');
-    		fileContents = fileContents.slice(firstPassagePos, fileContents.length);
-
-    	}
-
-    	// Split the file based on the passage sigil (::) preceeded by a newline
-    	let parsingPassages = fileContents.split('\n::');
-
-    	// Check if any passages exist
-      if(parsingPassages == 0) {
-
-        	throw new Error("No passages were found!");
-
-      }
-
-      // Fix the first result
-      parsingPassages[0] = parsingPassages[0].slice(2, parsingPassages[0].length);
-
-      // Set the initial pid
-      let pid = 0;
-
-      // Iterate through the passages
-      for(let passage of parsingPassages) {
-
-        	// Set default values
-	        let tags = "";
-	        let position = "";
-	        let metadata = "";
-	        let text = "";
-	        let name = "";
-
-        	// Header is everything to the first newline
-        	let header = passage.slice(0, passage.indexOf('\n'));
-        	// Text is everything else
-        	// (Also eat the leading newline character.)
-        	// (And trim any remaining whitespace.)
-        	text = passage.substring(header.length+1, passage.length).trim();
-
-	        // Test for metadata
-	        let openingCurlyBracketPosition = header.lastIndexOf('{');
-	        let closingCurlyBracketPosition = header.lastIndexOf('}');
-
-	        if(openingCurlyBracketPosition != -1 && closingCurlyBracketPosition != -1) {
-
-	        	// Save the text metadata
-	        	metadata = header.slice(openingCurlyBracketPosition, closingCurlyBracketPosition+1);
-
-	        	// Remove the metadata from the header
-	        	header = header.substring(0, openingCurlyBracketPosition) + header.substring(closingCurlyBracketPosition+1);
-	        }
-
-	        // There was passage metadata
-	        if(metadata.length > 0) {
-
-	        	// Try to parse the metadata
-	        	try {
-
-	        		metadata = JSON.parse(metadata);
-
-	        	} catch(event) {
-
-              this._passageMetadatError = true;
-
-	        	}
-
-	        }
-
-        	// Test for tags
-        	let openingSquareBracketPosition = header.lastIndexOf('[');
-        	let closingSquareBracketPosition = header.lastIndexOf(']');
-
-        	if(openingSquareBracketPosition != -1 && closingSquareBracketPosition != -1) {
-
-        		tags = header.slice(openingSquareBracketPosition, closingSquareBracketPosition+1);
-
-        		// Remove the tags from the header
-        		header = header.substring(0, openingSquareBracketPosition) + header.substring(closingSquareBracketPosition+1);
-        	}
-
-        	// Parse tags
-        	if(tags.length > 0) {
-
-        		// Eat the opening and closing square brackets
-        		tags = tags.substring(1, tags.length-1);
-
-            // Set empty default
-            let tagsArray = [];
-
-            // Test if tags is not single, empty string
-            if( !(tags == "") ) {
-
-                tagsArray = tags.split(" ");
-            }
-
-        		// There are multiple tags
-        		if(tagsArray.length > 1) {
-
-        			// Create future array
-        			let futureTagArray = [];
-
-        			// Move through entries
-        			for(let tag in tagsArray) {
-
-        				// Add a trimmed verion into future array
-        				futureTagArray.push(tagsArray[tag].trim());
-
-        			}
-
-        			// Set the tags back to the future array
-        			tags = futureTagArray;
-
-        		} else if (tagsArray.length == 1) {
-
-        			// There was only one tag
-        			// Store it
-        			let temp = tags;
-
-        			// Switch tags over to an array
-        			tags = new Array();
-        			// Push the single entry
-        			tags.push(temp);
-
-            } else {
-
-              // Make sure tags is set to empty array if no tags were found
-              tags = [];
-
-            }
-
-        	} else {
-        		// There were no tags, so set it to an empty array;
-        		tags = [];
-        	}
-
-          // Filter out any empty string tags
-          tags = tags.filter(tag => tag != "");
-
-        	// Trim any remaining whitespace
-        	header = header.trim();
-
-        	// Check if there is a name left
-        	if(header.length > 0) {
-
-        		name = header;
-
-        	} else {
-
-        		// No name left. Something went wrong. Blame user.
-        		throw new Error("Malformed passage header!");
-
-        	}
-
-          if(this._passageMetadatError) {
-
-            console.warn('Error parsing metadata for "' + name + '". It was ignored.');
-
-          }
-
-        	// Add the new Passage to the internal array
-        	passages.push(new Passage(name, tags, metadata, text, pid));
-
-          // Increase pid
-          pid++;
-
-        }
-
-        // All formats share StoryTitle
-        // Find it and set it
-        let pos = passages.find((el) => {
-        	return el.name == "StoryTitle";
-        });
-
-        if(pos != undefined) {
-
-        	this.story.name = pos.text;
-            // Remove the StoryTitle passage
-            passages = passages.filter(p => p.name !== "StoryTitle");
-
-        } else {
-
-            // There was no StoryTitle passage
-            // Set a value of "Unknown"
-            this.story.name = "Unknown";
-
-        }
-
-        // Look for StoryData
-        pos = passages.find((el) => {
-        		return el.name == "StoryData";
-        });
-
-        if(pos != undefined ) {
-
-        	// Try to parse the StoryData
-        	try {
-
-        		this.story.metadata = JSON.parse(pos.text);
-
-        	} catch(event) {
-
-        		// Silently fail with default values
-            this._storydataError = true;
-
-        	}
-
-            // Remove the StoryData passage
-            passages = passages.filter(p => p.name !== "StoryData");
-
-        }
-
-        if(this._storydataError) {
-
-            console.warn("Error with processing StoryData JSON data. It was ignored.");
-
-        }
-
-        // Set the passages to the internal story
-        this.story.passages = passages;
-
-    }
-
-}
-
-module.exports = TweeParser;
+import Passage from './Passage.js';
+import Story from './Story.js';
+/**
+ * @class TweeParser
+ * @module TweeParser
+ */
+export default class TweeParser {
+  /**
+   * Parse Twee
+   *
+   * @public
+   * @static
+   * @function parse
+   * @param {string} fileContents - File contents to parse
+   * @returns {Story} story
+   */
+  static parse (fileContents) {
+    // Create Story.
+    const story = new Story();
+
+    // Throw error if fileContents is not a string
+    if (Object.prototype.toString.call(fileContents) !== '[object String]') {
+      throw new Error('Contents not a String');
+    }
+
+    let adjusted = '';
+
+    // Check if there are extra content in the files
+    // If so, cut it all out for the parser
+    if (fileContents[0] !== ':' && fileContents[1] !== ':') {
+      adjusted = fileContents.slice(fileContents.indexOf('::'), fileContents.length);
+    } else {
+      adjusted = fileContents;
+    }
+
+    // Split the file based on the passage sigil (::) proceeded by a newline
+    const parsingPassages = adjusted.split('\n::');
+
+    // Fix the first result
+    parsingPassages[0] = parsingPassages[0].slice(2, parsingPassages[0].length);
+
+    // Set the initial pid
+    let pid = 1;
+
+    // Iterate through the passages
+    parsingPassages.forEach((passage) => {
+      // Set default values
+      let tags = '';
+      let metadata = '';
+      let text = '';
+      let name = '';
+
+      // Header is everything to the first newline
+      let header = passage.slice(0, passage.indexOf('\n'));
+      // Text is everything else
+      // (Also eat the leading newline character.)
+      // (And trim any remaining whitespace.)
+      text = passage.substring(header.length + 1, passage.length).trim();
+
+      // Test for metadata
+      const openingCurlyBracketPosition = header.lastIndexOf('{');
+      const closingCurlyBracketPosition = header.lastIndexOf('}');
+
+      if (openingCurlyBracketPosition !== -1 && closingCurlyBracketPosition !== -1) {
+        // Save the text metadata
+        metadata = header.slice(openingCurlyBracketPosition, closingCurlyBracketPosition + 1);
+
+        // Remove the metadata from the header
+        header = header.substring(0, openingCurlyBracketPosition) + header.substring(closingCurlyBracketPosition + 1);
+      }
+
+      // There was passage metadata
+      if (metadata.length > 0) {
+        // Try to parse the metadata
+        try {
+          metadata = JSON.parse(metadata);
+        } catch (event) {
+        }
+      } else {
+        // There wasn't any metadata, so set default
+        metadata = {};
+      }
+
+      // Test for tags
+      const openingSquareBracketPosition = header.lastIndexOf('[');
+      const closingSquareBracketPosition = header.lastIndexOf(']');
+
+      if (openingSquareBracketPosition !== -1 && closingSquareBracketPosition !== -1) {
+        tags = header.slice(openingSquareBracketPosition, closingSquareBracketPosition + 1);
+
+        // Remove the tags from the header
+        header = header.substring(0, openingSquareBracketPosition) + header.substring(closingSquareBracketPosition + 1);
+      }
+
+      // Parse tags
+      if (tags.length > 0) {
+        // Eat the opening and closing square brackets
+        tags = tags.substring(1, tags.length - 1);
+
+        // Set empty default
+        let tagsArray = [];
+
+        // Test if tags is not single, empty string
+        if (!(tags === '')) {
+          tagsArray = tags.split(' ');
+        }
+
+        // There are multiple tags
+        if (tagsArray.length > 1) {
+        // Create future array
+          const futureTagArray = [];
+
+          // Move through entries
+          // Add a trimmed version into future array
+          tagsArray.forEach((tag) => { futureTagArray.push(tag.trim()); });
+
+          // Set the tags back to the future array
+          tags = futureTagArray;
+        } else if (tagsArray.length === 1) {
+          // There was only one tag
+          // Store it
+          const temp = tags;
+
+          // Switch tags over to an array
+          tags = [];
+          // Push the single entry
+          tags.push(temp);
+        } else {
+        // Make sure tags is set to empty array if no tags were found
+          tags = [];
+        }
+      } else {
+        // There were no tags, so set it to an empty array;
+        tags = [];
+      }
+
+      // Filter out any empty string tags
+      tags = tags.filter(tag => tag !== '');
+
+      // Trim any remaining whitespace
+      header = header.trim();
+
+      // Check if there is a name left
+      if (header.length > 0) {
+        name = header;
+      } else {
+        // No name left. Something went wrong. Blame user.
+        throw new Error('Malformed passage header!');
+      }
+
+      // addPassage() method does all the work
+      story.addPassage(new Passage(name, text, tags, metadata, pid));
+
+      // Increase pid
+      pid++;
+    });
+
+    // Return Story.
+    return story;
+  }
+}

package/src/TweeWriter.js

@@ -1,111 +1,98 @@
-const fs = require("fs");
-const path = require('path');
-const Story = require('./Story.js');
-
-/**
- * @class TweeWriter
- * @module TweeWriter
- */
-class TweeWriter {
-    /**
-     * @method TweeWriter
-     * @constructor
-     */
-    constructor (story, file) {
-
-        if( !(story instanceof Story) ) {
-          throw new Error("Not a Story object!");
-        }
-
-        this.writeFile(file, story);
-    }
-
-    writeFile(file, story) {
-
-      // Write StoryTitle first
-      let outputContents = ":: StoryTitle\n" + story.name + "\n\n";
-
-      // Write the StoryData second
-      outputContents += ":: StoryData\n"
-
-      // Borrowed from Underscore
-      // https://github.com/jashkenas/underscore/blob/master/underscore.js#L1319-L1323
-      let isObject = function(obj) {
-        var type = typeof obj;
-        return type === 'function' || type === 'object' && !!obj;
-      };
-
-      // Test if story.metadata is an object or not
-      if(isObject(story.metadata) ) {
-
-        // Write any metadata in pretty format
-        outputContents += " " + JSON.stringify(story.metadata, undefined, 2);
-
-      } else {
-
-        // If, for whatever reason, story.metadata is not an object, throw error.
-        throw new Error("Story Metadata MUST be an object!");
-
-      }
-
-      // Add two newlines
-      outputContents += "\n\n";
-
-      // Are there any passages?
-      if(story.passages.length > 0) {
-
-        // Build the contents
-        for(let passage in story.passages) {
-
-          // Write the name
-          outputContents += ":: " + story.passages[passage].name;
-
-          // Test if it has any tags
-          if(story.passages[passage].tags.length > 0) {
-
-            outputContents += " [";
-
-            for(let tag of story.passages[passage].tags) {
-
-              outputContents += " " + tag;
-
-            }
-
-            outputContents += "]";
-
-          }
-
-          // Write out any passage metadata
-          outputContents += JSON.stringify(story.passages[passage].metadata);
-
-          // Add the text and two newlines
-          outputContents += "\n" + story.passages[passage].text + "\n\n";
-
-        }
-
-      } else {
-
-        // Create empty Start passage
-        outputContents += ":: Start\n";
-
-      }
-
-      try {
-
-        // Try to write
-        fs.writeFileSync(file, outputContents);
-
-      } catch(event) {
-
-        // Throw error
-        throw new Error("Error: Cannot write Twee file!");
-
-      }
-
-      // Writing was successful
-      console.info("Created " + fs.realpathSync(file) );
-
-    }
-}
-
-module.exports = TweeWriter;
+/**
+ * @external Story
+ * @see Story.js
+ * @external Passage
+ * @see Passage.js
+ */
+
+import fs from 'fs';
+import Story from './Story.js';
+import { v4 as uuidv4 } from 'uuid';
+
+/**
+ * @class TweeWriter
+ * @module TweeWriter
+ */
+export default class TweeWriter {
+  /**
+   * Write to a file using a Story object
+   *
+   * @static
+   * @param {Story} story - Story format to write
+   * @param {string} file - File to write to
+   * @returns {void}
+   */
+  static write (story, file) {
+    if (!(story instanceof Story)) {
+      throw new Error('Not a Story object!');
+    }
+
+    // Write the StoryData first.
+    let outputContents = ':: StoryData\n';
+
+    // Create default object.
+    const metadata = {};
+
+    // Is there an IFID?
+    if (story.IFID === '') {
+      // Generate a new IFID for this work.
+      // Twine 2 uses v4 (random) UUIDs, using only capital letters.
+      metadata.ifid = uuidv4().toUpperCase();
+    } else {
+      // Use existing (non-default) value.
+      metadata.ifid = story.IFID;
+    }
+
+    // Is there a format?
+    if (story.format !== '') {
+      // Using existing format
+      metadata.format = story.format;
+    }
+
+    // Is there a formatVersion?
+    if (story.formatVersion !== '') {
+      // Using existing format version
+      metadata['format-version'] = story.formatVersion;
+    }
+
+    // Is there a zoom?
+    if (story.zoom !== 0) {
+      // Using existing zoom.
+      metadata.zoom = story.zoom;
+    }
+
+    // Is there a start?
+    if (story.start !== '') {
+      // Using existing start
+      metadata.start = story.start;
+    }
+
+    // Get number of colors.
+    const numberOfColors = Object.keys(story.tagColors).length;
+    // Are there any colors?
+    if (numberOfColors > 0) {
+      // Add a tag-colors property
+      metadata['tag-colors'] = story.tagColors;
+    }
+
+    // Write out the story metadata.
+    outputContents += `${JSON.stringify(metadata, undefined, 2)}`;
+
+    // Add two newlines.
+    outputContents += '\n\n';
+
+    // For each passage, append it to the output.
+    story.forEach((passage) => {
+      // For each passage, append it to the output.
+      outputContents += passage.toString();
+    });
+
+    try {
+      // Try to write
+      fs.writeFileSync(file, outputContents);
+    } catch (event) {
+      // Throw error
+      throw new Error('Error: Cannot write Twee file!');
+    }
+  }
+}