extwee 2.0.6 → 2.2.0

package/test/CLI.test.js

@@ -1,30 +0,0 @@
-import shell from 'shelljs';
-
-// We could get this from process,
-//  but since we are using shelljs,
-//  we ask for the pwd() instead of cwd().
-const currentPath = shell.pwd().stdout;
-const testFilePath = currentPath + '/test/CLI';
-
-describe('CLI', () => {
-  // Remove the test files, if they exist
-  beforeAll(() => {
-    shell.rm(`${testFilePath}/test.*`);
-  });
-
-  // Test generating Twee files
-  describe('Decompile', () => {
-    it('Decompile: HTML into Twee', () => {
-      shell.exec(`node ${currentPath}/bin/extwee.js -d -i ${testFilePath}/input.html -o ${testFilePath}/test.twee`);
-      expect(shell.test('-e', `${testFilePath}/test.twee`)).toBe(true);
-    });
-  });
-
-  // Test generating HTML files
-  describe('Compile', () => {
-    it('Compile: Twee + StoryFormat into Twee', () => {
-      shell.exec(`node ${currentPath}/bin/extwee.js -c -i ${testFilePath}/example6.twee -s ${testFilePath}/harlowe.js -o ${testFilePath}/test2.html`);
-      expect(shell.test('-e', `${testFilePath}/test2.html`)).toBe(true);
-    });
-  });
-});

package/test/FileReader/t1.txt

@@ -1 +0,0 @@
-Gibberish

package/test/FileReader.test.js

@@ -1,14 +0,0 @@
-import FileReader from '../src/FileReader.js';
-
-describe('FileReader', () => {
-  describe('#readFile()', () => {
-    it('Should throw error if file not found', () => {
-      expect(() => { FileReader.read('test/FileReader/t2.txt'); }).toThrow();
-    });
-
-    it('Should read the contents of a file', () => {
-      const fr = FileReader.read('test/FileReader/t1.txt');
-      expect(fr).toBe('Gibberish');
-    });
-  });
-});

package/test/HTMLParser.test.js

@@ -1,177 +0,0 @@
-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', () => {
-  describe('#parse()', () => {
-    it('Should throw error if content is not Twine-2 style HTML', () => {
-      expect(() => { HTMLParser.parse(''); }).toThrow();
-    });
-
-    it('Should be able to parse Twine 2 HTML for story name', () => {
-      const fr = FileReader.read('test/HTMLParser/twineExample.html');
-      const story = HTMLParser.parse(fr);
-      const storyTitle = story.getPassageByName('StoryTitle');
-      expect(storyTitle.text).toBe('twineExample');
-    });
-
-    it('Should be able to parse Twine 2 HTML for correct number of passages', () => {
-      const fr = FileReader.read('test/HTMLParser/twineExample.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.size()).toBe(5);
-    });
-
-    it('Should be able to correctly parse passage tags', () => {
-      const fr = FileReader.read('test/HTMLParser/Tags.html');
-      const story = HTMLParser.parse(fr);
-      const p = story.getPassageByName('Untitled Passage');
-      expect(p.tags).toHaveLength(2);
-    });
-
-    it('Should set a missing name to Untitled', () => {
-      const fr = FileReader.read('test/HTMLParser/missingName.html');
-      const story = HTMLParser.parse(fr);
-      const p = story.getPassageByName('StoryTitle');
-      expect(p.text).toBe('Untitled');
-    });
-
-    it('Should set a missing IFID to an empty string', () => {
-      const fr = FileReader.read('test/HTMLParser/missingIFID.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.IFID).toBe('');
-    });
-
-    it('Should have Extwee for creator when missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingCreator.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.creator).toBe('extwee');
-    });
-
-    it('Should have correct for creatorVersion when missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingCreatorVersion.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.creatorVersion).toBe(version);
-    });
-
-    it('Should have empty string as format when missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingFormat.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.format).toBe('');
-    });
-
-    it('Should have empty string as formatVersion when missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingFormatVersion.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.formatVersion).toBe('');
-    });
-
-    it('Should have empty string as zoom when missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingZoom.html');
-      const tp = HTMLParser.parse(fr);
-      expect(tp.zoom).toBe(0);
-    });
-
-    it('Should not have position if passage does not', () => {
-      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);
-    });
-
-    it('Should not have size if passage does not', () => {
-      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);
-    });
-
-    it('Should have empty array as tags if tags is missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingPassageTags.html');
-      const story = HTMLParser.parse(fr);
-      const p = story.getPassageByName('Untitled Passage');
-      expect(p.tags).toHaveLength(0);
-    });
-
-    it('Should not have stylesheet tag if no passages exist with it', () => {
-      const fr = FileReader.read('test/HTMLParser/missingStyle.html');
-      const story = HTMLParser.parse(fr);
-      const passages = story.getPassagesByTag('stylesheet');
-      expect(passages.length).toBe(0);
-    });
-
-    it('Should not have script tag if no passages exist with it', () => {
-      const fr = FileReader.read('test/HTMLParser/missingScript.html');
-      const story = HTMLParser.parse(fr);
-      const passages = story.getPassagesByTag('script');
-      expect(passages.length).toBe(0);
-    });
-
-    it('Should have script and style tags normally', () => {
-      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);
-    });
-
-    it('Should not have start property if startNode does not exist when parsed', () => {
-      const fr = FileReader.read('test/HTMLParser/missingStartnode.html');
-      const story = HTMLParser.parse(fr);
-      expect(story.start).toBe('');
-    });
-
-    it('Should not add passages without names', () => {
-      const fr = FileReader.read('test/HTMLParser/missingPassageName.html');
-      const story = HTMLParser.parse(fr);
-      // There is only one passage, StoryTitle
-      expect(story.size()).toBe(0);
-    });
-
-    it('Should not add passages without PID', () => {
-      const fr = FileReader.read('test/HTMLParser/missingPID.html');
-      const story = HTMLParser.parse(fr);
-      // There is only one passage, StoryTitle
-      expect(story.size()).toBe(0);
-    });
-
-    it('Parse tag colors', () => {
-      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');
-    });
-
-    it('Will not set start if startnode is missing', () => {
-      const fr = FileReader.read('test/HTMLParser/missingStartnode.html');
-      const story = HTMLParser.parse(fr);
-      // Test for default start
-      expect(story.start).toBe('');
-    });
-
-    it('Throw error when startnode has PID that does not exist', () => {
-      const fr = FileReader.read('test/HTMLParser/lyingStartnode.html');
-      expect(() => {
-        HTMLParser.parse(fr);
-      }).toThrow();
-    });
-
-    it('Do not update name and color if those attributes do not exist', () => {
-      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()', () => {
-    it('Should escape metacharacters', () => {
-      /* eslint no-useless-escape: "off" */
-      expect(HTMLParser.escapeMetacharacters('\\\{\\\}\\\[\\\]\\\\')).toBe('\\\\{\\\\}\\\\[\\\\]\\\\');
-    });
-  });
-});

package/test/HTMLWriter/example6.twee

@@ -1,16 +0,0 @@
-:: StoryTitle
-twineExample
-
-:: Start [tag tags] {"position": "200,200", "size": "100,100"}
-Content
-
-:: Style1 [stylesheet]
-body {background-color: green;}
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}

package/test/HTMLWriter.test.js

@@ -1,287 +0,0 @@
-import FileReader from '../src/FileReader.js';
-import StoryFormatParser from '../src/StoryFormatParser.js';
-import HTMLParser from '../src/HTMLParser.js';
-import TweeParser from '../src/TweeParser.js';
-import HTMLWriter from '../src/HTMLWriter.js';
-import Story from '../src/Story.js';
-import Passage from '../src/Passage.js';
-
-describe('HTMLWriter', () => {
-  describe('#write()', () => {
-    it('story should be instanceof Story', () => {
-      expect(() => { HTMLWriter.write('test/HTMLWriter/test.html', {}); }).toThrow();
-    });
-
-    it('storyFormat should be instanceof StoryFormat', () => {
-      const s = new Story();
-      expect(() => { HTMLWriter.write('test/HTMLWriter/test.html', s, {}); }).toThrow();
-    });
-
-    it('Read, write, and read HTML', () => {
-      // Read HTML.
-      const fr = FileReader.read('test/HTMLParser/twineExample3.html');
-      // Parse HTML.
-      const story = HTMLParser.parse(fr);
-
-      const s1Title = story.getPassageByName('StoryTitle').text;
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Write HTML.
-      HTMLWriter.write('test/HTMLWriter/test2.html', story, storyFormat);
-
-      // Read HTML.
-      const fr3 = FileReader.read('test/HTMLWriter/test2.html');
-      // Parse HTML.
-      const story2 = HTMLParser.parse(fr3);
-
-      // Test both names to be the same.
-      expect(s1Title).toBe(story2.name);
-    });
-
-    it('Should write one and two-tag passages', () => {
-      // Read HTML.
-      const fr = FileReader.read('test/HTMLWriter/TestTags.html');
-      // Parse HTML.
-      const story = HTMLParser.parse(fr);
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Write HTML.
-      HTMLWriter.write('test/HTMLWriter/test3.html', story, storyFormat);
-
-      // Read HTML.
-      const fr3 = FileReader.read('test/HTMLWriter/test3.html');
-      // Parse HTML.
-      const story2 = HTMLParser.parse(fr3);
-
-      let tags = '';
-      let tags2 = '';
-
-      // Combine contents of tags.
-      story.forEach((p) => {
-        tags += p.tags.join('');
-      });
-
-      // Combine contents of tags.
-      story2.forEach((p) => {
-        tags2 += p.tags.join('');
-      });
-
-      // Test combination tags.
-      // They should be the same.
-      expect(tags).toBe(tags2);
-    });
-
-    it('Should throw error if file path invalid', () => {
-      // Read HTML.
-      const fr = FileReader.read('test/HTMLParser/twineExample3.html');
-      // Parse HTML.
-      const story = HTMLParser.parse(fr);
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Throw error if path is invalid.
-      expect(() => {
-        HTMLWriter.write('test2/HTMLWriter/test2.html', story, storyFormat);
-      }).toThrow();
-    });
-
-    it('Should not add optional position to passages', () => {
-      // Create Story.
-      const story = new Story();
-      // Add passage.
-      story.addPassage(new Passage('A'));
-      // Add passage.
-      story.addPassage(new Passage('B'));
-      // Add StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Title'));
-      // Add Start
-      story.addPassage(new Passage('Start', 'Content'));
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Write out HTML with story and storyFormat.
-      // (Will add position to passages without them.)
-      HTMLWriter.write('test/HTMLWriter/test4.html', story, storyFormat);
-
-      // Read new HTML file.
-      const fr3 = FileReader.read('test/HTMLWriter/test4.html');
-      // Parse new HTML file.
-      const story2 = HTMLParser.parse(fr3);
-
-      // Verify none of the directly created passages have position.
-      story.forEach((passage) => {
-        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
-      });
-
-      // Verify none parsed passages have position.
-      story2.forEach((passage) => {
-        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
-      });
-    });
-
-    it("Don't write creator if missing originally", () => {
-      // Create a new story.
-      const story = new Story();
-
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create another passage.
-      story.addPassage(new Passage('B'));
-
-      // Create another passage.
-      story.addPassage(new Passage('StoryTitle', 'Title'));
-
-      // Add Start
-      story.addPassage(new Passage('Start', 'Content'));
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Write the HTML.
-      HTMLWriter.write('test/HTMLWriter/creator.html', story, storyFormat);
-
-      // Read HTML.
-      const fr3 = FileReader.read('test/HTMLWriter/creator.html');
-      // Parse HTML.
-      const story2 = HTMLParser.parse(fr3);
-
-      // Test creator (should be default)
-      expect(story.creator).toBe('extwee');
-
-      // Test parsed creator (should be default)
-      expect(story2.creator).toBe('extwee');
-
-      // Creator should be the same
-      expect(story.creator).toBe(story2.creator);
-    });
-
-    it('Throw error if StoryTitle does not exist', () => {
-      // Create a new story.
-      const story = new Story();
-
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      expect(() => {
-        HTMLWriter.write('test', story, storyFormat);
-      }).toThrow();
-    });
-
-    it('Throw error if no start or Start exists', () => {
-      // Create a new story.
-      const story = new Story();
-
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Name'));
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Throws error
-      expect(() => {
-        HTMLWriter.write('test/HTMLWriter/test6.html', story, storyFormat);
-      }).toThrow();
-    });
-
-    it('Write with Start without start', () => {
-      // Create a new story.
-      const story = new Story();
-
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Name'));
-
-      // Create Start
-      story.addPassage(new Passage('Start', 'Content'));
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Write file
-      HTMLWriter.write('test/HTMLWriter/test6.html', story, storyFormat);
-
-      // Read new HTML file.
-      const fr3 = FileReader.read('test/HTMLWriter/test6.html');
-      // Parse new HTML file.
-      const story2 = HTMLParser.parse(fr3);
-
-      // Should not be start
-      expect(story2.start).toBe('Start');
-    });
-
-    it('Throw error if starting passage property does not exist', () => {
-      // Create a new story.
-      const story = new Story();
-
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Name'));
-
-      // Set a passage that doesn't exist
-      story.start = 'Nope';
-
-      // Read StoryFormat.
-      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
-      // Parse StoryFormat.
-      const storyFormat = StoryFormatParser.parse(fr2);
-
-      // Throws error
-      expect(() => {
-        HTMLWriter.write('test/HTMLWriter/test7.html', story, storyFormat);
-      }).toThrow();
-    });
-
-    it('Should correctly replace all instances of STORY_NAME', () => {
-      const fr = FileReader.read('test/HTMLWriter/example6.twee');
-      const story = TweeParser.parse(fr);
-      const storyFormatFile = FileReader.read('test/StoryFormatParser/format_doublename.js');
-      const sfp = StoryFormatParser.parse(storyFormatFile);
-      HTMLWriter.write('test/HTMLWriter/test11.html', story, sfp);
-      const frh = FileReader.read('test/HTMLWriter/test11.html');
-      expect(frh.indexOf('STORY_NAME')).toBe(-1);
-    });
-  });
-
-  describe('escape()', () => {
-    it('Should throw error if argument is not string', () => {
-      expect(() => { HTMLWriter.escape(1); }).toThrow();
-    });
-
-    it('Should escape HTML sequences', () => {
-      expect(HTMLWriter.escape('<script>alert("Hi!");</script>')).toBe('&lt;script&gt;alert(&quot;Hi!&quot;);&lt;/script&gt;');
-    });
-  });
-});

package/test/Roundtrip/example1.twee

@@ -1,21 +0,0 @@
-:: StoryData
-{
-  "ifid": "E70FC479-01D9-4E44-AC6A-AFF9F5E1C475",
-  "format": "Chapbook",
-  "format-version": "1.1.0",
-  "zoom": 1,
-  "start": "StoryTitle"
-}
-
-:: StoryTitle
-Example1
-
-:: Untitled Passage {"position":"200,102","size":"100,100"}
-[[Another passage]]
-
-:: Another passage {"position":"200,252","size":"100,100"}
-[[A third]]
-
-:: A third {"position":"200,402","size":"100,100"}
-Double-click this passage to edit it.
-

package/test/Roundtrip.test.js

@@ -1,48 +0,0 @@
-import TweeWriter from '../src/TweeWriter.js';
-import FileReader from '../src/FileReader.js';
-import TweeParser from '../src/TweeParser.js';
-import HTMLParser from '../src/HTMLParser.js';
-import StoryFormatParser from '../src/StoryFormatParser.js';
-import HTMLWriter from '../src/HTMLWriter.js';
-
-describe('Round-trip testing', () => {
-  it('Should round-trip HTML-to-Twee', () => {
-    // Read HTML
-    const fr = FileReader.read('test/Roundtrip/Example1.html');
-    // Parse HTML
-    const s = HTMLParser.parse(fr);
-    // Write Story into Twee
-    TweeWriter.write(s, 'test/Roundtrip/example1.twee');
-    // Read new Twee file
-    const fr2 = FileReader.read('test/Roundtrip/example1.twee');
-    // Parse the new Twee
-    const s2 = TweeParser.parse(fr2);
-    // Number of passages should be the same, too
-    expect(s2.size()).toBe(s.size());
-    // IFID should be the same
-    expect(s.ifid).toBe(s2.ifid);
-  });
-
-  it('Should round-trip Twee-to-HTML', () => {
-    // Read StoryFormat
-    const storyFormat = FileReader.read('test/Roundtrip/harlowe.js');
-    // Parse StoryFormat
-    const sfp = StoryFormatParser.parse(storyFormat);
-    // Read Twee
-    const fr = FileReader.read('test/Roundtrip/example2.twee');
-    // Parse Twee
-    const story = TweeParser.parse(fr);
-    // Write HTML
-    HTMLWriter.write('test/Roundtrip/round.html', story, sfp);
-    // Read HTML
-    const fr2 = FileReader.read('test/Roundtrip/round.html');
-    // Parse HTML
-    const story2 = HTMLParser.parse(fr2);
-    // Number of passages should be the same, too
-    expect(story2.size()).toBe(story.size());
-    // IFID should be the same
-    expect(story.ifid).toBe(story2.ifid);
-    // Should have same 'start' name
-    expect(story.start).toBe(story2.start);
-  });
-});

package/test/Story/startmeta.twee

@@ -1,29 +0,0 @@
-:: StoryTitle
-twineExample
-
-:: Another
-This should be the start passage!
-
-:: Start
-Some content.
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1",
-    "start": "Another"
-}
-
-:: Script1 [script]
-// Some code
-
-:: Script2 [script]
-//More code here!
-
-:: Style1 [stylesheet]
-body {font-size: 1.2em}
-
-:: Style2 [stylesheet]
-p {font-style: italic;}