npm - extwee - Versions diffs - 2.0.6 → 2.2.0 - Mend

extwee 2.0.6 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (216) hide show

package/.eslintrc.json +25 -25
package/.github/FUNDING.yml +3 -0
package/.github/dependabot.yml +11 -0
package/.github/workflows/nodejs.yml +25 -24
package/.travis.yml +13 -13
package/CODE_OF_CONDUCT.md +82 -82
package/LICENSE +21 -21
package/README.md +173 -36
package/SECURITY.md +12 -12
package/babel.config.json +18 -22
package/build/extwee +0 -0
package/build/extwee.exe +0 -0
package/build/extwee.web.min.js +2 -0
package/build/extwee.web.min.js.LICENSE.txt +1 -0
package/docs/.nojekyll +0 -0
package/docs/README.md +167 -0
package/docs/_sidebar.md +19 -0
package/docs/examples/dynamicPassages.md +28 -0
package/docs/examples/jsonToTwee.md +23 -0
package/docs/examples/twsToTwee.md +25 -0
package/docs/formats/json.md +17 -0
package/docs/formats/twee.md +13 -0
package/docs/formats/twine1HTML.md +13 -0
package/docs/formats/twine2ArchiveHTML.md +13 -0
package/docs/formats/twine2HTML.md +13 -0
package/docs/formats/tws.md +9 -0
package/docs/index.html +26 -0
package/docs/install/binaries.md +9 -0
package/docs/install/npm.md +20 -0
package/docs/install/npx.md +9 -0
package/docs/objects/passage.md +47 -0
package/docs/objects/story.md +70 -0
package/docs/objects/storyformat.md +27 -0
package/index.html +22 -0
package/index.js +29 -31
package/package.json +65 -58
package/src/JSON/parse.js +128 -0
package/src/Passage.js +298 -202
package/src/Story.js +650 -523
package/src/StoryFormat/parse.js +134 -0
package/src/StoryFormat.js +259 -300
package/src/TWS/parse.js +86 -0
package/src/Twee/parse.js +157 -0
package/src/Twine1HTML/compile.js +58 -0
package/src/Twine1HTML/parse.js +134 -0
package/src/Twine2ArchiveHTML/compile.js +36 -0
package/src/Twine2ArchiveHTML/parse.js +49 -0
package/src/Twine2HTML/compile.js +35 -0
package/src/Twine2HTML/parse.js +348 -0
package/src/extwee.js +206 -0
package/test/CLI/CLI.test.js +49 -0
package/test/CLI/files/example.json +1 -0
package/test/CLI/files/example6.twee +22 -0
package/test/{Roundtrip → CLI/files}/harlowe.js +2 -2
package/test/CLI/{input.html → files/input.html} +47 -47
package/test/CLI/files/output/test.twee +0 -0
package/test/CLI/{tweeExample.twee → files/tweeExample.twee} +17 -17
package/test/CLI/files/twine1/LICENSE.txt +32 -0
package/test/CLI/files/twine1/code.js +5 -0
package/test/CLI/files/twine1/engine.js +43 -0
package/test/CLI/files/twine1/header.html +325 -0
package/test/CLI/files/twine1Test.html +371 -0
package/test/CLI/{twineExample.html → files/twineExample.html} +16 -15
package/test/JSON/JSON.Parse.test.js +316 -0
package/test/Passage.test.js +175 -104
package/test/Roundtrip/{Example1.html → Files/Example1.html} +63 -63
package/test/Roundtrip/Files/LICENSE +19 -0
package/test/Roundtrip/Files/example1.twee +10 -0
package/test/Roundtrip/{example2.twee → Files/example2.twee} +27 -18
package/test/Roundtrip/{example4.twee → Files/example4.twee} +27 -27
package/test/{StoryFormatParser → Roundtrip/Files}/harlowe.js +2 -2
package/test/Roundtrip/{round.html → Files/round.html} +6 -4
package/test/Roundtrip/Roundtrip.test.js +54 -0
package/test/Story.test.js +638 -423
package/test/StoryFormat/StoryFormat.Parse.test.js +91 -0
package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/example.js +3 -3
package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/example2.js +3 -3
package/test/{CLI → StoryFormat/StoryFormatParser}/harlowe.js +2 -2
package/test/StoryFormat.test.js +152 -152
package/test/TWS/Parse.test.js +78 -0
package/test/TWS/TWSParser/Example1.tws +150 -0
package/test/TWS/TWSParser/Example5.tws +414 -0
package/test/TWS/TWSParser/noscale.tws +0 -0
package/test/TWS/TWSParser/nostory.tws +0 -0
package/test/Twee/Twee.Parse.test.js +76 -0
package/test/{TweeParser → Twee/TweeParser}/emptytags.twee +2 -2
package/test/{TweeParser → Twee/TweeParser}/example.twee +32 -32
package/test/{TweeParser → Twee/TweeParser}/missing.twee +19 -19
package/test/{TweeParser → Twee/TweeParser}/multipleScriptPassages.twee +19 -19
package/test/{TweeParser → Twee/TweeParser}/multipleStyleTag.twee +19 -19
package/test/{TweeParser → Twee/TweeParser}/multipletags.twee +10 -10
package/test/{TweeParser → Twee/TweeParser}/noTitle.twee +2 -2
package/test/{TweeParser → Twee/TweeParser}/notes.twee +16 -16
package/test/{TweeParser → Twee/TweeParser}/pasagemetadataerror.twee +2 -2
package/test/{TweeParser → Twee/TweeParser}/scriptPassage.twee +16 -16
package/test/{TweeParser → Twee/TweeParser}/singletag.twee +13 -13
package/test/{TweeParser → Twee/TweeParser}/startMetadata.twee +14 -14
package/test/{TweeParser → Twee/TweeParser}/storydataerror.twee +25 -25
package/test/{TweeParser → Twee/TweeParser}/stylePassage.twee +16 -16
package/test/{Story → Twee/TweeParser}/test.twee +25 -25
package/test/Twine1HTML/Twine1HTML.Compile.test.js +180 -0
package/test/Twine1HTML/Twine1HTML.Parse.test.js +183 -0
package/test/Twine1HTML/Twine1HTMLCompiler/Twine1/LICENSE +674 -0
package/test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js +43 -0
package/test/Twine1HTML/Twine1HTMLCompiler/Twine1/jquery.js +4 -0
package/test/Twine1HTML/Twine1HTMLCompiler/Twine1/modernizr.js +4 -0
package/test/Twine1HTML/Twine1HTMLCompiler/engineTest.html +1 -0
package/test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/LICENSE +32 -0
package/test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/code.js +4 -0
package/test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/header.html +327 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test.html +0 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test1.html +6 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test2.html +6 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test3.html +43 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test4.html +372 -0
package/test/Twine1HTML/Twine1HTMLCompiler/test5.html +372 -0
package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Compile.test.js +35 -0
package/test/Twine2ArchiveHTML/Twine2ArchiveHTML.Parse.test.js +25 -0
package/test/Twine2ArchiveHTML/Twine2ArchiveHTMLCompiler/test1.html +6 -0
package/test/Twine2ArchiveHTML/Twine2ArchiveHTMLParser/test1.html +3 -0
package/test/Twine2HTML/Twine2HTML.Compile.test.js +224 -0
package/test/Twine2HTML/Twine2HTML.Parse.test.js +172 -0
package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/creator.html +4 -4
package/test/{CLI → Twine2HTML/Twine2HTMLCompiler}/example6.twee +15 -15
package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/missingStoryTitle.twee +29 -29
package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/test2.html +10 -8
package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/test3.html +1 -1
package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/test4.html +4 -4
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/Example1.html +52 -52
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/Tags.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/lyingStartnode.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/lyingTagColors.html +48 -48
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingCreator.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingCreatorVersion.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingFormat.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingFormatVersion.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingIFID.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingName.html +33 -33
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingPID.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingPassageName.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingPassageTags.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingPosition.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingScript.html +14 -14
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingSize.html +35 -35
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingStartnode.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingStyle.html +14 -14
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/missingZoom.html +11 -11
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/twineExample.html +23 -23
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/twineExample2.html +15 -15
package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/twineExample3.html +15 -15
package/web-index.js +29 -0
package/webpack.config.js +12 -0
package/bin/extwee.js +0 -47
package/src/FileReader.js +0 -33
package/src/HTMLParser.js +0 -345
package/src/HTMLWriter.js +0 -231
package/src/StoryFormatParser.js +0 -142
package/src/TweeParser.js +0 -161
package/src/TweeWriter.js +0 -121
package/story-formats/chapbook-1.2.0/format.js +0 -1
package/story-formats/chapbook-1.2.0/logo.svg +0 -1
package/story-formats/harlowe-1.2.4/format.js +0 -1
package/story-formats/harlowe-1.2.4/icon.svg +0 -78
package/story-formats/harlowe-2.1.0/format.js +0 -2
package/story-formats/harlowe-2.1.0/icon.svg +0 -78
package/story-formats/harlowe-3.1.0/format.js +0 -3
package/story-formats/harlowe-3.1.0/icon.svg +0 -78
package/story-formats/paperthin-1.0.0/format.js +0 -1
package/story-formats/paperthin-1.0.0/icon.svg +0 -5
package/story-formats/snowman-1.4.0/format.js +0 -1
package/story-formats/snowman-1.4.0/icon.svg +0 -436
package/story-formats/snowman-2.0.2/format.js +0 -1
package/story-formats/snowman-2.0.2/icon.svg +0 -436
package/story-formats/sugarcube-1.0.35/LICENSE +0 -23
package/story-formats/sugarcube-1.0.35/format.js +0 -1
package/story-formats/sugarcube-1.0.35/icon.svg +0 -56
package/story-formats/sugarcube-2.31.1/LICENSE +0 -22
package/story-formats/sugarcube-2.31.1/format.js +0 -1
package/story-formats/sugarcube-2.31.1/icon.svg +0 -56
package/test/CLI/test2.html +0 -45
package/test/CLI.test.js +0 -30
package/test/FileReader/t1.txt +0 -1
package/test/FileReader.test.js +0 -14
package/test/HTMLParser.test.js +0 -177
package/test/HTMLWriter/example6.twee +0 -16
package/test/HTMLWriter.test.js +0 -287
package/test/Roundtrip/example1.twee +0 -21
package/test/Roundtrip.test.js +0 -48
package/test/Story/startmeta.twee +0 -29
package/test/StoryFormatParser.test.js +0 -91
package/test/TweeParser/test.twee +0 -25
package/test/TweeParser.test.js +0 -79
package/test/TweeWriter/test1.twee +0 -18
package/test/TweeWriter/test3.twee +0 -12
package/test/TweeWriter/test4.twee +0 -14
package/test/TweeWriter/test5.twee +0 -20
package/test/TweeWriter/test6.twee +0 -15
package/test/TweeWriter/test7.twee +0 -15
package/test/TweeWriter.test.js +0 -107
/package/test/CLI/{test.twee → files/test.twee} +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/format.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/format_doublename.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingAuthor.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingDescription.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingImage.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingLicense.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingName.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingProofing.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingSource.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingURL.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/missingVersion.js +0 -0
/package/test/{StoryFormatParser → StoryFormat/StoryFormatParser}/versionWrong.js +0 -0
/package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/TestTags.html +0 -0
/package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/test11.html +0 -0
/package/test/{HTMLWriter → Twine2HTML/Twine2HTMLCompiler}/test6.html +0 -0
/package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/tagColors.html +0 -0

package/test/{HTMLParser → Twine2HTML/Twine2HTMLParser}/twineExample3.html RENAMED Viewed

@@ -1,15 +1,15 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="utf-8">
-<title>twineExample</title>
-</head>
-<body>
-<tw-story></tw-story>
-<tw-storydata name="twineExample" startnode="1" creator="Twine" creator-version="2.2.1" ifid="2B68ECD6-348F-4CF5-96F8-549A512A8128" zoom="1" format="Harlowe" format-version="2.1.0" options="" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css">html{font-size: 1.2em;}</style><script role="script" id="twine-user-script" type="text/twine-javascript">window.test = {};</script><tw-passagedata pid="1" name="Start" tags="" position="102,104" size="100,100">[[Another passage]]
-[[A third passage]]</tw-passagedata><tw-passagedata pid="2" name="Another passage" tags="" position="353,60" size="100,100">[[A fourth passage]]
-[[A third passage]] </tw-passagedata><tw-passagedata pid="3" name="A third passage" tags="" position="350,288" size="100,100">[[Start]]</tw-passagedata><tw-passagedata pid="4" name="A fourth passage" tags="" position="587,197" size="100,100">[[A fifth passage]]</tw-passagedata><tw-passagedata pid="5" name="A fifth passage" tags="" position="800,306" size="100,100">Double-click this passage to edit it.</tw-passagedata></tw-storydata>
-</body>
-</html>
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>twineExample</title>
+</head>
+<body>
+<tw-story></tw-story>
+<tw-storydata name="twineExample" startnode="1" creator="Twine" creator-version="2.2.1" ifid="2B68ECD6-348F-4CF5-96F8-549A512A8128" zoom="1" format="Harlowe" format-version="2.1.0" options="" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css">html{font-size: 1.2em;}</style><script role="script" id="twine-user-script" type="text/twine-javascript">window.test = {};</script><tw-passagedata pid="1" name="Start" tags="" position="102,104" size="100,100">[[Another passage]]
+[[A third passage]]</tw-passagedata><tw-passagedata pid="2" name="Another passage" tags="" position="353,60" size="100,100">[[A fourth passage]]
+[[A third passage]] </tw-passagedata><tw-passagedata pid="3" name="A third passage" tags="" position="350,288" size="100,100">[[Start]]</tw-passagedata><tw-passagedata pid="4" name="A fourth passage" tags="" position="587,197" size="100,100">[[A fifth passage]]</tw-passagedata><tw-passagedata pid="5" name="A fifth passage" tags="" position="800,306" size="100,100">Double-click this passage to edit it.</tw-passagedata></tw-storydata>
+</body>
+</html>

package/web-index.js ADDED Viewed

@@ -0,0 +1,29 @@
+import { parse as parseTwee } from './src/Twee/parse.js';
+import { parse as parseJSON } from './src/JSON/parse.js';
+import { parse as parseStoryFormat } from './src/StoryFormat/parse.js';
+import { parse as parseTwine1HTML } from './src/Twine1HTML/parse.js';
+import { parse as parseTwine2HTML } from './src/Twine2HTML/parse.js';
+import { parse as parseTwine2ArchiveHTML } from './src/Twine2ArchiveHTML/parse.js';
+import { parse as parseTWS } from './src/TWS/parse.js';
+import { compile as compileTwine1HTML } from './src/Twine1HTML/compile.js';
+import { compile as compileTwine2HTML } from './src/Twine2HTML/compile.js';
+import { compile as compileTwine2ArchiveHTML } from './src/Twine2ArchiveHTML/compile.js';
+import Story from './src/Story.js';
+import Passage from './src/Passage.js';
+import StoryFormat from './src/StoryFormat.js';
+window.Extwee = {
+    parseTwee,
+    parseJSON,
+    parseTWS,
+    parseStoryFormat,
+    parseTwine1HTML,
+    parseTwine2HTML,
+    parseTwine2ArchiveHTML,
+    compileTwine1HTML,
+    compileTwine2HTML,
+    compileTwine2ArchiveHTML,
+    Story,
+    Passage,
+    StoryFormat
+};

package/webpack.config.js ADDED Viewed

@@ -0,0 +1,12 @@
+import path from 'node:path';
+export default {
+  mode: 'production',
+  entry: {
+    'extwee.web.min': './web-index.js'
+  },
+  output: {
+    path: path.resolve('./', 'build'),
+    filename: '[name].js',
+  },
+};

package/bin/extwee.js DELETED Viewed

@@ -1,47 +0,0 @@
-#!/usr/bin/env node
-/**
- * @fileoverview CLI for Extwee
- * @author Dan Cox
- */
-// Import everything
-import Extwee from '../index.js';
-// Import Commander
-import { Command } from 'commander';
-// Create a new Command
-const program = new Command();
-program
-.name('extwee')
-.version('2.0.6')
-.option('-c', 'From Twee into HTML')
-.option('-d', 'From HTML into Twee')
-.option('-s <storyformat>', 'Path to storyformat')
-.option('-i <inputFile>', 'Path to input file')
-.option('-o <outputFile>', 'Path to output file');
-// Parse the passed arguments
-program.parse(process.argv);
-// Create object of passed arguments parsed by Commander
-const options = program.opts();
-// Decompile branch
-if(options.d === true) {
-    const inputHTML = Extwee.readFile(options.i);
-    const storyObject = Extwee.parseHTML(inputHTML);
-    Extwee.writeTwee(storyObject, options.o);
-    process.exit();
-}
-// Compile branch
-if(options.c === true) {
-    const inputTwee = Extwee.readFile(options.i);
-    const story = Extwee.parseTwee(inputTwee);
-    const inputStoryFormat = Extwee.readFile(options.s);
-    const parsedStoryFormat = Extwee.parseStoryFormat(inputStoryFormat);
-    Extwee.writeHTML(options.o, story, parsedStoryFormat);
-    process.exit();
-}

package/src/FileReader.js DELETED Viewed

@@ -1,33 +0,0 @@
-import fs from 'fs';
-/**
- * @class FileReader
- * @module FileReader
- */
-export default class FileReader {
-  /**
-   * Read a text file
-   *
-   * @static
-   * @public
-   * @function readFile
-   * @memberof FileReader
-   * @param {string} file - Path of file to read
-   * @returns {string} Content of file
-   */
-  static read (file) {
-    // Setup default value
-    let contents = '';
-    // Attempt to find the file
-    if (fs.existsSync(file)) {
-      // The file exists.
-      contents = fs.readFileSync(file, 'utf8');
-    } else {
-      // Throw error if file does not exist
-      throw new Error('Error: File not found!');
-    }
-    // Return default or updated values
-    return contents;
-  }
-}

package/src/HTMLParser.js DELETED Viewed

@@ -1,345 +0,0 @@
-/**
- * @external HTML
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML|HTML}
- */
-import { parse as HtmlParser } from 'node-html-parser';
-import Story from './Story.js';
-import Passage from './Passage.js';
-/**
- * @class HTMLParser
- * @module HTMLParser
- */
-export default class HTMLParser {
-  /**
-   * Parse HTML text into a JS DOM-like object
-   *
-   * @public
-   * @static
-   * @function parse
-   * @param {string} content - Content to parse
-   * @returns {Story} story
-   */
-  static parse (content) {
-    let story = null;
-    let startNode = null;
-    // Send to node-html-parser
-    // Enable getting the content of 'script', 'style', and 'pre' elements
-    // Get back a DOM
-    const dom = new HtmlParser(
-      content,
-      {
-        lowerCaseTagName: false,
-        script: true,
-        style: true,
-        pre: true
-      });
-    // Pull out the tw-storydata element
-    const storyData = dom.querySelector('tw-storydata');
-    // Does the <tw-storydata> element exist?
-    if (storyData !== null) {
-      // Create a Story.
-      story = new Story();
-      /**
-       * name: (string) Required.
-       *   The name of the story.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'name')) {
-        // Create StoryTitle passage based on name
-        story.addPassage(new Passage('StoryTitle', storyData.attributes.name));
-        // Set the story name
-        story.name = storyData.attributes.name;
-      } else {
-        // Name is a required filed. Warn user.
-        console.warn('Twine 2 HTML must have a name!');
-        // Set a default name
-        story.addPassage(new Passage('StoryTitle', 'Untitled'));
-      }
-      /**
-       * ifid: (string) Required.
-       *   An IFID is a sequence of between 8 and 63 characters,
-       *   each of which shall be a digit, a capital letter or a
-       *   hyphen that uniquely identify a story (see Treaty of Babel).
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'ifid')) {
-        // Update story IFID
-        story.IFID = storyData.attributes.ifid;
-      } else {
-        // Name is a required filed. Warn user.
-        console.warn('Twine 2 HTML must have an IFID!');
-      }
-      /**
-       * creator: (string) Optional.
-       *   The name of program used to create the file.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'creator')) {
-        // Update story creator
-        story.creator = storyData.attributes.creator;
-      }
-      /**
-       * creator-version: (string) Optional.
-       *   The version of the program used to create the file.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'creator-version')) {
-        // Update story creator version
-        story.creatorVersion = storyData.attributes['creator-version'];
-      }
-      /**
-       * format: (string) Optional.
-       *   The story format used to create the story.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'format')) {
-        // Update story format
-        story.format = storyData.attributes.format;
-      }
-      /**
-       * format-version: (string) Optional.
-       *   The version of the story format used to create the story.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'format-version')) {
-        // Update story format version
-        story.formatVersion = storyData.attributes['format-version'];
-      }
-      /**
-       * zoom: (string) Optional.
-       *   The decimal level of zoom (i.e. 1.0 is 100% and 1.2 would be 120% zoom level).
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'zoom')) {
-        // Update story zoom
-        story.zoom = Number(Number.parseFloat(storyData.attributes.zoom).toFixed(2));
-      }
-      /**
-       * startnode: (string) Optional.
-       *   The PID matching a <tw-passagedata> element whose content should be displayed first.
-       */
-      if (Object.prototype.hasOwnProperty.call(storyData.attributes, 'startnode')) {
-        // Take string value and convert to Int
-        startNode = Number.parseInt(storyData.attributes.startnode, 10);
-      }
-    } else {
-      // If there is not a <tw-storydata> element, this is not a Twine 2 story!
-      throw new Error('Not a Twine 2-style file!');
-    }
-    // Pull out the tw-passagedata elements
-    const storyPassages = dom.querySelectorAll('tw-passagedata');
-    // Move through the passages
-    for (const passage in storyPassages) {
-      // Get the passage attributes
-      const attr = storyPassages[passage].attributes;
-      // Get the passage text
-      const text = storyPassages[passage].rawText;
-      // Set a default position.
-      let position = null;
-      // Does position exist?
-      if (Object.prototype.hasOwnProperty.call(attr, 'position')) {
-        // Update position.
-        position = attr.position;
-      }
-      // Set a default size.
-      let size = null;
-      // Does size exist?
-      if (Object.prototype.hasOwnProperty.call(attr, 'size')) {
-        // Update size.
-        size = attr.size;
-      }
-      /**
-       * name: (string) Required.
-       *   The name of the passage.
-       *
-       *   https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md#passages
-       */
-      // Create a default value
-      let name = null;
-      // Does name exist?
-      if (Object.prototype.hasOwnProperty.call(attr, 'name')) {
-        // Escape the name
-        name = HTMLParser.escapeMetacharacters(attr.name);
-      } else {
-        console.warn('Encountered passage without a name! Will not add.');
-      }
-      // Create empty tag array.
-      let tags = [];
-      // Does the tags attribute exist?
-      if (Object.prototype.hasOwnProperty.call(attr, 'tags')) {
-        // Escape any tags
-        // (Attributes can, themselves, be empty strings.)
-        if (attr.tags.length > 0 && attr.tags !== '""') {
-          // Escape the tags
-          tags = HTMLParser.escapeMetacharacters(attr.tags);
-          // Split by spaces into an array
-          tags = tags.split(' ');
-        }
-        // Remove any empty strings.
-        tags = tags.filter(tag => tag !== '');
-      }
-      // Create metadata for passage.
-      const metadata = {};
-      // Does position exist?
-      if (position !== null) {
-        // Add the property to metadata
-        metadata.position = position;
-      }
-      // Does size exist?
-      if (size !== null) {
-        // Add the property to metadata
-        metadata.size = size;
-      }
-      /**
-       * pid: (string) Required.
-       *   The Passage ID (PID).
-       *   (Note: This is subject to change during editing with Twine 2.)
-       *
-       *   https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md#passages
-       */
-      // Create a default PID
-      let pid = -1;
-      // Does pid exist?
-      if (Object.prototype.hasOwnProperty.call(attr, 'pid')) {
-        // Parse string into int
-        // Update PID
-        pid = Number.parseInt(attr.pid, 10);
-      } else {
-        console.warn('Passages are required to have PID. Will not add!');
-      }
-      // If passage is missing name and PID (required attributes),
-      //  they are not added.
-      if (name !== null && pid !== -1) {
-        // Add a new Passage into an array
-        story.addPassage(
-          new Passage(
-            name,
-            text,
-            tags,
-            metadata,
-            pid
-          )
-        );
-      }
-    }
-    // Look for the style element
-    const styleElement = dom.querySelector('#twine-user-stylesheet');
-    // Does the style element exist?
-    if (styleElement !== null) {
-      // Check if there is any content.
-      if (styleElement.rawText.length > 0) {
-        // Update stylesheet passage
-        story.addPassage(new Passage(
-          'UserStylesheet',
-          styleElement.rawText,
-          ['stylesheet'])
-        );
-      }
-    }
-    // Look for the script element
-    const scriptElement = dom.querySelector('#twine-user-script');
-    // Does the script element exist?
-    if (scriptElement !== null) {
-      // Check if there is any content.
-      if (scriptElement.rawText.length > 0) {
-        story.addPassage(new Passage(
-          'UserScript',
-          scriptElement.rawText,
-          ['script'])
-        );
-      }
-    }
-    // Was there a startNode?
-    if (startNode !== null) {
-      // Try to find starting passage by PID.
-      const startingPassage = story.getPassageByPID(startNode);
-      // Does the passage exist (yet)?
-      if (startingPassage !== null) {
-        // If so, update property to name of passage.
-        story.start = startingPassage.name;
-      } else {
-        throw new Error('Invalid startnode detected in <tw-storydata>!');
-      }
-    }
-    // Look for all <tw-tag> elements
-    const twTags = dom.querySelectorAll('tw-tag');
-    // Parse through the entries
-    twTags.forEach((tags) => {
-      // Parse each tag element
-      const attributes = tags.attributes;
-      // Create default value for name
-      let name = '';
-      // Create default value for color
-      let color = '';
-      // Check for name
-      if (Object.prototype.hasOwnProperty.call(attributes, 'name')) {
-        name = attributes.name;
-      }
-      // Check for color
-      if (Object.prototype.hasOwnProperty.call(attributes, 'color')) {
-        color = attributes.color;
-      }
-      // If both are not empty strings, use them.
-      if (name !== '' && color !== '') {
-        // Add name and color to the object
-        story.tagColors[name] = color;
-      }
-    });
-    // Return the parsed story
-    return story;
-  }
-  /**
-   * Try to escape meta-characters
-   *
-   * @public
-   * @static
-   * @function escapeMetacharacters
-   * @param {string} result - Text to parse
-   * @returns {string} Escaped characters
-   */
-  static escapeMetacharacters (result) {
-    // Replace any single backslash with two of them
-    result = result.replace(/\\/g, '\\');
-    // Double-escape escaped {
-    result = result.replace(/\\\{/g, '\\\\{');
-    // Double-escape escaped }
-    result = result.replace(/\\\}/g, '\\\\}');
-    // Double-escape escaped [
-    result = result.replace(/\\\[/g, '\\\\[');
-    // Double-escape escaped ]
-    result = result.replace(/\\\]/g, '\\\\]');
-    return result;
-  }
-}