Skip to content

Releases: videlais/extwee

v2.2.4

07 Sep 20:52
Compare
Choose a tag to compare

There are two smaller but important changes:

  • Stories can be a single and only passage named Start. It is strongly recommended to have StoryData to have story metadata, but a single passage named Start is technically allowed.
  • pkg has been removed from the project because it was archived starting on Jan 13, 2024. This version does not have a single executable application build, but support for Node's internal API for building applications is queued for a later version.

Full Changelog: v2.2.3...v2.2.4

v2.2.3

24 Apr 00:55
Compare
Choose a tag to compare

Adds TypeScript types generation as a script and as part of the "npm run all" combination to guarantee they will always be updated.

What's Changed

Full Changelog: v2.2.2...v2.2.3

v2.2.2

07 Mar 04:09
Compare
Choose a tag to compare

Adds more tests and documentation overall.

Hopefully, the next minor update will be a fix for #447 with future work toward 2.4.0 and configuration files.

What's Changed

Full Changelog: v2.2.1...v2.2.2

v2.2.1

08 Jan 21:48
Compare
Choose a tag to compare

Updates

  • Better HTML special character escaping when translating into and out of Twine 2 and Twine 1 HTML.
  • Adding of TypeScript types.

What's Changed

Full Changelog: v2.2.0...v2.2.1

Extwee 2.2.0

21 Dec 01:33
Compare
Choose a tag to compare

Extwee 2.2.0 was a multi-month process of supporting every format ever produced by Twine. It included work to get the Twine 1 TWS and Twine 1 HTML documentation approved as well as creating the new Twine 2 JSON format.

Tree Shaking

To support tree-shaking, every method was de-coupled from a static class. Instead of, for example, TweeParser.parse(), the new function can be found in the Twee/parse.js file. This should allow those using the API directly to only import the exact function or object rather than need to reference a static class or import the entire Extwee object.

Documentation

As part of the move to 2.2, documentation was also added. There are now pages on each supported format, each individual object, and two examples: how to use the API to generate passages and converting from JSON to Twee.

Public Projects

To enable transparency on upcoming code changes, both the Road to Extwee 2.2.0 project and Road to Extwee 2.4.0 project were set to public.

Note The Road to Extwee 2.2.0 will be closed after this release and publish of files to NPM.

New Binaries

The build folder contains the latest binary builds for macOS and Windows.

What's Changed

Full Changelog: v2.0.6...v2.2.0

Extwee 2.0.6

13 Jun 14:16
Compare
Choose a tag to compare

Changes:

  • Adjusted testing scripts from test() to it() pattern.
  • Updated dependencies
  • Changed how passages with the name StoryTitle or containing the tags script or stylesheet are handled. They are no longer part of Story.forEach() and must be searched for seperately.

Full Changelog: v2.0.5...v2.0.6

Extwee 2.0.5

11 Jun 05:06
Compare
Choose a tag to compare

Minor update to fix an issue with semver and version checking.

Full Changelog: v2.0.3...v2.0.5

Extwee 2.0.3

06 Jun 22:39
fed2cb4
Compare
Choose a tag to compare

Moving into 2.0, Extwee now uses static methods for all major functionality. What was previously a two-step process of creating an object and then calling its method is reduced into, for example, TweeParser.parse(). These static methods are also now exported individually and as properties from an object from the index.js file, allowing a developer to either import the exact method they want or to use the whole object.

Internally, testing was condensed into using Jest and away from a combination of Mocha + Chai as well.

Extwee 2.0 now supports command-line usage (via Node) again. This was available in an early build, but has been added back.

Extwee supports NPX commands:

  • Compile: npx extwee -c -i <input twee> -s <input story format JS> -o <output HTML>
  • Decompile: npx extwee -d -i <input HTML> -o <output twee>

What's Changed

Full Changelog: v1.5.0...v2.0.3

Extwee 1.5.0

28 Jul 23:37
Compare
Choose a tag to compare

Changes:

  • Various bug fixes
  • A robust set of Mocha + Istanbul test for over 90% code coverage.

Additions:

  • DirectoryReader

Extwee now has a -r option that will recursively read a directory for CSS, JS, and Twee files. Combined with the built-in -o option, this will build a HTML file based on a directory instead of a single Twee file.

  • DirectoryWatcher

Extwee now has a -w option that will watch a directory for any file additions or changes. If it detects any, DirectoryReader will be used to process and auto-build the set -o output after any change.

  • Babel Processing

When watching a directory, all JS files will be processed by Babel, transpiling any ES6 into ES5.

  • UglyJS Processing

When watching a directory, all JS files will be post-processed by UglyJS, minifying ES5 code.

  • CleanCSS Processing

When watching a directory, all CSS files will be "cleaned" by CleanCSS, minifying and optimizing any CSS code.

Extwee 1.1.3

29 Jun 22:45
Compare
Choose a tag to compare

Moved to 1.1.3 after fixing a PID issue (and moving to 1.1.2).
Updated HTMLWriter, README, and package.json to 1.1.3.

Update:

pkg has an issue with Windows builds on MacOS X, so the extwee-win.exe build is now made on Windows exclusively.