npm - extwee - Versions diffs - 1.6.2 → 2.0.0 - Mend

extwee 1.6.2 → 2.0.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 (151) hide show

package/.eslintrc.json +25 -24
package/.github/workflows/nodejs.yml +24 -24
package/.travis.yml +13 -13
package/CODE_OF_CONDUCT.md +82 -0
package/LICENSE +21 -21
package/README.md +36 -205
package/SECURITY.md +12 -0
package/babel.config.json +22 -0
package/bin/extwee.js +49 -0
package/index.js +31 -26
package/package.json +60 -45
package/src/FileReader.js +33 -35
package/src/HTMLParser.js +343 -206
package/src/HTMLWriter.js +196 -172
package/src/Passage.js +202 -24
package/src/Story.js +461 -122
package/src/StoryFormat.js +300 -28
package/src/StoryFormatParser.js +142 -59
package/src/TweeParser.js +166 -207
package/src/TweeWriter.js +98 -96
package/story-formats/chapbook-1.2.0/format.js +1 -0
package/story-formats/chapbook-1.2.0/logo.svg +1 -0
package/story-formats/harlowe-1.2.4/format.js +1 -0
package/story-formats/harlowe-1.2.4/icon.svg +78 -0
package/story-formats/harlowe-2.1.0/format.js +2 -0
package/story-formats/harlowe-2.1.0/icon.svg +78 -0
package/story-formats/harlowe-3.1.0/format.js +3 -0
package/story-formats/harlowe-3.1.0/icon.svg +78 -0
package/story-formats/paperthin-1.0.0/format.js +1 -0
package/story-formats/paperthin-1.0.0/icon.svg +5 -0
package/story-formats/snowman-1.4.0/format.js +1 -0
package/story-formats/snowman-1.4.0/icon.svg +436 -0
package/story-formats/snowman-2.0.2/format.js +1 -0
package/story-formats/snowman-2.0.2/icon.svg +436 -0
package/story-formats/sugarcube-1.0.35/LICENSE +23 -0
package/story-formats/sugarcube-1.0.35/format.js +1 -0
package/story-formats/sugarcube-1.0.35/icon.svg +56 -0
package/story-formats/sugarcube-2.31.1/LICENSE +22 -0
package/story-formats/sugarcube-2.31.1/format.js +1 -0
package/story-formats/sugarcube-2.31.1/icon.svg +56 -0
package/test/{HTMLWriter/example7.twee → CLI/example6.twee} +16 -16
package/test/CLI/harlowe.js +3 -0
package/test/CLI/input.html +47 -0
package/test/CLI/test.twee +18 -0
package/test/CLI/test2.html +47 -0
package/test/CLI/tweeExample.twee +17 -0
package/test/CLI/twineExample.html +15 -0
package/test/CLI.test.js +30 -0
package/test/FileReader.test.js +14 -0
package/test/HTMLParser/Example1.html +53 -0
package/test/HTMLParser/Tags.html +15 -0
package/test/HTMLParser/lyingStartnode.html +15 -0
package/test/HTMLParser/lyingTagColors.html +48 -0
package/test/HTMLParser/missingCreator.html +11 -0
package/test/HTMLParser/missingCreatorVersion.html +11 -0
package/test/HTMLParser/missingFormat.html +11 -0
package/test/HTMLParser/missingFormatVersion.html +11 -0
package/test/HTMLParser/missingIFID.html +11 -0
package/test/HTMLParser/missingName.html +33 -0
package/test/HTMLParser/missingPID.html +15 -0
package/test/HTMLParser/missingPassageName.html +15 -0
package/test/HTMLParser/missingPassageTags.html +15 -0
package/test/HTMLParser/missingPosition.html +15 -0
package/test/HTMLParser/missingScript.html +14 -0
package/test/HTMLParser/missingSize.html +35 -0
package/test/HTMLParser/missingStartnode.html +11 -0
package/test/HTMLParser/missingStyle.html +14 -0
package/test/HTMLParser/missingZoom.html +11 -0
package/test/HTMLParser/tagColors.html +31 -0
package/test/HTMLParser/twineExample.html +15 -46
package/test/HTMLParser/twineExample2.html +15 -0
package/test/HTMLParser/twineExample3.html +15 -0
package/test/HTMLParser.test.js +177 -0
package/test/HTMLWriter/TestTags.html +42 -0
package/test/HTMLWriter/{test10.html → creator.html} +8 -5
package/test/HTMLWriter/example6.twee +16 -16
package/test/HTMLWriter/{example.twee → missingStoryTitle.twee} +29 -29
package/test/HTMLWriter/test11.html +123 -0
package/test/HTMLWriter/test2.html +15 -12
package/test/HTMLWriter/test3.html +7 -13
package/test/HTMLWriter/test4.html +8 -5
package/test/HTMLWriter/test6.html +7 -5
package/test/HTMLWriter.test.js +279 -0
package/test/Passage.test.js +104 -0
package/test/Roundtrip/Example1.html +64 -0
package/test/Roundtrip/example1.twee +21 -0
package/test/Roundtrip/example2.twee +18 -0
package/test/Roundtrip/harlowe.js +3 -0
package/test/Roundtrip/round.html +50 -0
package/test/Roundtrip.test.js +48 -0
package/test/Story/startmeta.twee +29 -29
package/test/Story/test.twee +25 -25
package/test/Story.test.js +282 -0
package/test/StoryFormat.test.js +152 -0
package/test/StoryFormatParser/example.js +3 -0
package/test/StoryFormatParser/{test2.js → example2.js} +3 -3
package/test/StoryFormatParser/format_doublename.js +1 -0
package/test/StoryFormatParser/harlowe.js +2 -2
package/test/StoryFormatParser/missingAuthor.js +1 -0
package/test/StoryFormatParser/missingDescription.js +1 -0
package/test/StoryFormatParser/missingImage.js +1 -0
package/test/StoryFormatParser/missingLicense.js +1 -0
package/test/StoryFormatParser/missingName.js +1 -0
package/test/StoryFormatParser/missingProofing.js +1 -0
package/test/StoryFormatParser/missingSource.js +1 -0
package/test/StoryFormatParser/missingURL.js +1 -0
package/test/StoryFormatParser/missingVersion.js +1 -0
package/test/StoryFormatParser/versionWrong.js +1 -0
package/test/StoryFormatParser.test.js +91 -0
package/test/TweeParser/emptytags.twee +2 -2
package/test/TweeParser/example.twee +32 -29
package/test/TweeParser/missing.twee +19 -0
package/test/{HTMLWriter/example5.twee → TweeParser/multipleScriptPassages.twee} +19 -13
package/test/{HTMLWriter/example4.twee → TweeParser/multipleStyleTag.twee} +19 -13
package/test/TweeParser/multipletags.twee +10 -2
package/test/TweeParser/noTitle.twee +2 -0
package/test/TweeParser/notes.twee +16 -32
package/test/TweeParser/pasagemetadataerror.twee +2 -2
package/test/{HTMLWriter/example2.twee → TweeParser/scriptPassage.twee} +16 -13
package/test/TweeParser/singletag.twee +13 -2
package/test/TweeParser/startMetadata.twee +14 -0
package/test/TweeParser/storydataerror.twee +25 -25
package/test/{HTMLWriter/example3.twee → TweeParser/stylePassage.twee} +16 -13
package/test/TweeParser/test.twee +25 -25
package/test/TweeParser.test.js +79 -0
package/test/TweeWriter/test1.twee +14 -9
package/test/TweeWriter/test3.twee +7 -10
package/test/TweeWriter/test4.twee +14 -0
package/test/TweeWriter/test5.twee +20 -0
package/test/TweeWriter.test.js +82 -0
package/main.js +0 -106
package/src/DirectoryReader.js +0 -114
package/src/DirectoryWatcher.js +0 -87
package/test/DirectoryReader/css/test.css +0 -3
package/test/DirectoryReader1/js/Site.js +0 -1
package/test/DirectoryReader2/error.js +0 -1
package/test/DirectoryReader2/example.css +0 -3
package/test/DirectoryReader2/index.twee +0 -6
package/test/DirectoryReader3/twee/index.twee +0 -6
package/test/DirectoryWatcher/example.txt +0 -0
package/test/DirectoryWatcher/test.txt +0 -0
package/test/DirectoryWatcher/test1.txt +0 -0
package/test/HTMLWriter/test5.html +0 -48
package/test/HTMLWriter/test7.html +0 -48
package/test/HTMLWriter/test8.html +0 -48
package/test/HTMLWriter/test9.html +0 -48
package/test/StoryFormatParser/test.js +0 -2
package/test/TweeParser/test.twee3 +0 -11
package/test/TweeWriter/metatest.twee +0 -12
package/test/TweeWriter/test2.twee +0 -15
package/test/test.js +0 -736

package/test/HTMLParser/twineExample2.html ADDED Viewed

@@ -0,0 +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"></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/test/HTMLParser/twineExample3.html ADDED Viewed

@@ -0,0 +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>

package/test/HTMLParser.test.js ADDED Viewed

@@ -0,0 +1,177 @@
+import FileReader from '../src/FileReader.js';
+import HTMLParser from '../src/HTMLParser.js';
+// Pull the name and version of this project from package.json.
+// These are used as the 'creator' and 'creator-version'.
+const { version } = JSON.parse(FileReader.read('package.json'));
+describe('HTMLParser', function () {
+  describe('#parse()', function () {
+    test('Should throw error if content is not Twine-2 style HTML', function () {
+      expect(() => { HTMLParser.parse(''); }).toThrow();
+    });
+    test('Should be able to parse Twine 2 HTML for story name', function () {
+      const fr = FileReader.read('test/HTMLParser/twineExample.html');
+      const story = HTMLParser.parse(fr);
+      const storyTitle = story.getPassageByName('StoryTitle');
+      expect(storyTitle.text).toBe('twineExample');
+    });
+    test('Should be able to parse Twine 2 HTML for correct number of passages', function () {
+      const fr = FileReader.read('test/HTMLParser/twineExample.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.size()).toBe(6);
+    });
+    test('Should be able to correctly parse passage tags', function () {
+      const fr = FileReader.read('test/HTMLParser/Tags.html');
+      const story = HTMLParser.parse(fr);
+      const p = story.getPassageByName('Untitled Passage');
+      expect(p.tags).toHaveLength(2);
+    });
+    test('Should set a missing name to Untitled', function () {
+      const fr = FileReader.read('test/HTMLParser/missingName.html');
+      const story = HTMLParser.parse(fr);
+      const p = story.getPassageByName('StoryTitle');
+      expect(p.text).toBe('Untitled');
+    });
+    test('Should set a missing IFID to an empty string', function () {
+      const fr = FileReader.read('test/HTMLParser/missingIFID.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.IFID).toBe('');
+    });
+    test('Should have Extwee for creator when missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingCreator.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.creator).toBe('extwee');
+    });
+    test('Should have correct for creatorVersion when missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingCreatorVersion.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.creatorVersion).toBe(version);
+    });
+    test('Should have empty string as format when missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingFormat.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.format).toBe('');
+    });
+    test('Should have empty string as formatVersion when missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingFormatVersion.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.formatVersion).toBe('');
+    });
+    test('Should have empty string as zoom when missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingZoom.html');
+      const tp = HTMLParser.parse(fr);
+      expect(tp.zoom).toBe(0);
+    });
+    test('Should not have position if passage does not', function () {
+      const fr = FileReader.read('test/HTMLParser/missingPosition.html');
+      const story = HTMLParser.parse(fr);
+      const p = story.getPassageByName('Untitled Passage');
+      expect(Object.prototype.hasOwnProperty.call(p.metadata, 'position')).toBe(false);
+    });
+    test('Should not have size if passage does not', function () {
+      const fr = FileReader.read('test/HTMLParser/missingSize.html');
+      const story = HTMLParser.parse(fr);
+      const p = story.getPassageByName('Untitled Passage');
+      expect(Object.prototype.hasOwnProperty.call(p.metadata, 'size')).toBe(false);
+    });
+    test('Should have empty array as tags if tags is missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingPassageTags.html');
+      const story = HTMLParser.parse(fr);
+      const p = story.getPassageByName('Untitled Passage');
+      expect(p.tags).toHaveLength(0);
+    });
+    test('Should not have stylesheet tag if no passages exist with it', function () {
+      const fr = FileReader.read('test/HTMLParser/missingStyle.html');
+      const story = HTMLParser.parse(fr);
+      const passages = story.getPassagesByTag('stylesheet');
+      expect(passages.length).toBe(0);
+    });
+    test('Should not have script tag if no passages exist with it', function () {
+      const fr = FileReader.read('test/HTMLParser/missingScript.html');
+      const story = HTMLParser.parse(fr);
+      const passages = story.getPassagesByTag('script');
+      expect(passages.length).toBe(0);
+    });
+    test('Should have script and style tags normally', function () {
+      const fr = FileReader.read('test/HTMLParser/Example1.html');
+      const story = HTMLParser.parse(fr);
+      const scriptPassages = story.getPassagesByTag('script');
+      const stylesheetPassages = story.getPassagesByTag('stylesheet');
+      expect(scriptPassages.length).toBe(1);
+      expect(stylesheetPassages.length).toBe(1);
+    });
+    test('Should not have start property if startNode does not exist when parsed', function () {
+      const fr = FileReader.read('test/HTMLParser/missingStartnode.html');
+      const story = HTMLParser.parse(fr);
+      expect(story.start).toBe('');
+    });
+    test('Should not add passages without names', function () {
+      const fr = FileReader.read('test/HTMLParser/missingPassageName.html');
+      const story = HTMLParser.parse(fr);
+      // There is only one passage, StoryTitle
+      expect(story.size()).toBe(1);
+    });
+    test('Should not add passages without PID', function () {
+      const fr = FileReader.read('test/HTMLParser/missingPID.html');
+      const story = HTMLParser.parse(fr);
+      // There is only one passage, StoryTitle
+      expect(story.size()).toBe(1);
+    });
+    test('Parse tag colors', function () {
+      const fr = FileReader.read('test/HTMLParser/tagColors.html');
+      const story = HTMLParser.parse(fr);
+      // Test for tag colors
+      const tagColors = story.tagColors;
+      expect(tagColors.a).toBe('red');
+    });
+    test('Will not set start if startnode is missing', function () {
+      const fr = FileReader.read('test/HTMLParser/missingStartnode.html');
+      const story = HTMLParser.parse(fr);
+      // Test for default start
+      expect(story.start).toBe('');
+    });
+    test('Throw error when startnode has PID that does not exist', function () {
+      const fr = FileReader.read('test/HTMLParser/lyingStartnode.html');
+      expect(() => {
+        HTMLParser.parse(fr);
+      }).toThrow();
+    });
+    test('Do not update name and color if those attributes do not exist', function () {
+      const fr = FileReader.read('test/HTMLParser/lyingTagColors.html');
+      const story = HTMLParser.parse(fr);
+      const tagColorProperties = Object.keys(story.tagColors).length;
+      expect(tagColorProperties).toBe(0);
+    });
+  });
+  describe('#escapeMetacharacters()', function () {
+    test('Should escape metacharacters', function () {
+      /* eslint no-useless-escape: "off" */
+      expect(HTMLParser.escapeMetacharacters('\\\{\\\}\\\[\\\]\\\\')).toBe('\\\\{\\\\}\\\\[\\\\]\\\\');
+    });
+  });
+});