extwee 1.6.2 → 2.0.0

package/.eslintrc.json

@@ -1,24 +1,25 @@
-{
-    "env": {
-        "commonjs": true,
-        "es6": true,
-        "node": true
-    },
-    "extends": [
-        "standard",
-        "plugin:jsdoc/recommended"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 2018
-    },
-    "rules": {
-        "semi": ["error", "always"]
-    },
-    "plugins": [
-        "jsdoc"
-    ]
-}
+{
+    "env": {
+        "browser": true,
+        "es2020": true,
+        "jest/globals": true
+    },
+    "extends": [
+        "standard",
+        "plugin:jest/recommended",
+        "plugin:jsdoc/recommended"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 11,
+        "sourceType": "module"
+    },
+    "rules": {
+        "semi": ["error", "always"]
+    },
+    "plugins": [
+        "jest",
+        "@babel",
+        "jsdoc"
+    ],
+    "parser": "@babel/eslint-parser"
+}

package/.github/workflows/nodejs.yml

@@ -1,24 +1,24 @@
-name: Node CI
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x]
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm run lint
-    - run: npm run test
-      env:
-        CI: true
+name: Node CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run lint
+    - run: npm run test
+      env:
+        CI: true

package/.travis.yml

@@ -1,13 +1,13 @@
-language: node_js  
-
-node_js:  
-  - "node"
-
-install:
-  - npm install
-  - npm install codecov
-
-script:
-  - npm run test
-  - npm run report-coverage
-  - codecov
+language: node_js  
+
+node_js:  
+  - "node"
+
+install:
+  - npm install
+  - npm install codecov
+
+script:
+  - npm run test
+  - npm run report-coverage
+  - codecov

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,82 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to maintainer of this repository.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at `https://www.contributor-covenant.org/version/2/0/code_of_conduct.html`.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at `https://www.contributor-covenant.org/faq`. Translations are available at `https://www.contributor-covenant.org/translations`.

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Dan Cox
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Dan Cox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,205 +1,36 @@
-[![Build Status](https://travis-ci.org/videlais/extwee.svg?branch=master)](https://travis-ci.org/videlais/extwee) [![codecov](https://codecov.io/gh/videlais/extwee/branch/master/graph/badge.svg)](https://codecov.io/gh/videlais/extwee)
-
-[![NPM Badge](https://nodei.co/npm/extwee.png?downloads=true)](https://www.npmjs.com/package/extwee)
-
-# Extwee 1.6.2
-
-Extwee is a Twee compiler supporting Twine 2-style formats using the [Twee 3 specification](https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md).
-
-It will read both Twee 2 (Twee2) and Twee 3 formatted files, but does not understand or currently support Twee 1 (Twine 1.4.2) or Twee2 special passages for Twine 1.X formatting.
-
-*Extwee does not support Twine 1.X story formats.*
-
-## Binary Releases
-
-Compiled versions for Windows, MacOS X, and Linux can be found under [Releases](https://github.com/videlais/extwee/releases)
-
-## Story Formats
-
-Starting with Extwee 1.5, the latest versions of Harlowe (1.X, 2.X, and 3.X), SugarCube (1.X and 2.X) and Snowman (1.X) are now packaged with binary builds.
-
-## Compatibility With Other Tools
-
-* Does not parse StorySettings
-* Does not parse `@includes`
-* Does not parse StoryIncludes
-* Does not handle [haml]; will not parse HAML
-* Does not handle [twee2] special passages
-
-## Command-Line Usage
-
-When working with the binary builds of Extwee, the operating system is part of the file name. In Windows, for examples, the build is called `extwee-win.exe`.
-
-Extwee supports the following command-line arguments:
-
-* `i`: Input Twee file
-* `v`: Version of Extwee
-* `f`: Path to the Story Format's `format.js` file
-* `d`: HTML file to decompile into Twee code
-* `o`: Output file
-* `r`: Path of directory to read
-* `w`: Enable directory watching mode
-
-Using the command-line arguments, Extwee operates in four "modes":
-* Twee to HTML
-
-For simple, single-file compiling of Twee code into HTML, the arguments `i`, `o`, and `f` are used. These specify the input Twee file, the output HTML file, and the story format to use.
-
-`extwee-[OS] -i source.twee -o output.html -f path/format.js`
-
-* HTML to Twee
-
-For simple, single-file decompiling of HTML into Twee code, the arguments `d` and `o` are used. They specify the HTML file to read and the Twee file to create.
-
-`extwee-[OS] -d file.html -o source.twee `
-
-* Directory Reading
-
-For more complex, multiple file usage, the argument `r` can be used to read a directory. This is used with the `o` and `f` options to specify what output file and which story format to use.
-
-`extwee-[OS] -r path/ -o output.html -f path/format.js`
-
-* Directory Watching
-
-For more complex, multiple file usage, the argument `w` can be used to "watch" a directory for any new files or changes. While in this mode, Extwee will re-use the Directory Reading mode when it detects any additional files or changes. The specified output file will be re-build fresh each time.
-
-`extwee-[OS] -w path/ -o output.html -f path/format.js`
-
-### File Formats
-
-When watching a directory, Extwee will look for `tw`, `tw2`, `tw3`, `twee`, `twee2`, and `twee3` files. All other modes will accept any text files as input.
-
-### Escaping Metacharacters
-
-Extwee will attempt to escape the metacharacters of `{`, `}`, `[`, and `]` when moving to and from Twee notation. However, even with this support, it *highly recommended* to avoid these characters in passage name and tags to avoid confusion and potential issues.
-
-## API Usage
-
-Extwee can be installed via NPM.
-
-`npm i extwee`
-
-As a NPM package, Extwee's objects can also be used independent of the binary builds as part of other projects. It exposes the following objects and their properties and functions.
-
-### *FileReader*
-
-*FileReader* wraps *fs.existsSync* and *fs.readFileSync*. It accepts the path to a file and will throw an error if the file cannot be found or read.
-
-`let fr = new FileReader("path");`
-
-#### Properties
-
-* *contents*: The textual content of the read file.
-
-### *TweeParser*
-
-*TweeParser* accepts Twee textual content and saves an internal *Story* object populated with any passages found.
-
-`let tp = new TweeParser("tweeContent");`
-
-#### Properties
-
-* *story*: The internal *Story* object created and populated during parsing.
-
-### *TweeWriter*
-
-*TweeWriter* accepts a *Story* and path to file the Twee file.
-
-`let tw = new TweeWriter(Story, "path/");`
-
-### *StoryFormat*
-
-*StoryFormat* accepts a JS object (and will throw an error if not).
-
-It is uncommon for *StoryFormat* to be used directly.
-
-#### Properties
-
-* *name*: Name of the story format.
-* *version*: Version of the story format.
-* *description*: Description of the story format.
-* *author*: Author of the story format.
-* *image*: Logo image URL
-* *url*: URL of story format
-* *license*: License of the story format
-* *proofing*: If story format is a proofing story format or not
-* *source*: The JS source of the story format
-
-### *Passage*
-
-*Passage* represents a single passage in a Twine story. It accepts `name` (String), `tags` (Array), `metadata` (JS Object), `text` (String), and `pid` (Integer).
-
-It is uncommon for *Passage* to be used directly.
-
-#### Properties:
-
-* *name*: Name of passage.
-* *tags*: Array of any tags.
-* *metadata*: Object holding any passage metadata
-* *text*: Text of the passage.
-* *pid*: Passage Identification Number (PID)
-
-### *Story*
-
-The *Story* object holds all information about a Twine story including its metadata, passages, and name.
-
-`let s = new Story();`
-
-#### Properties
-
-* *name*: Name of the story. (Defaults to "Unknown").
-* *metadata*: Story metadata represented by `StoryData` passage in Twee 3
-* *passages*: Array of *Passage* objects.
-* *creator*: Set to `package.json` name (i.e. Exwee).
-* *creatorVersion*: Set to `package.json` version.
-
-#### Functions
-
-* *getStylePassages()*: Returns an array of any passages with the tag "stylesheet".
-* *getScriptPassages()*: Returns an array of any passages with the tag "script".
-* *deleteAllByTag(tag)*: Deletes any passages with the tag `tag`.
-* *getStartingPassage()*: Returns the PID of the starting passage (either `Start` or `StoryData`'s' `start` override, if found).
-
-### *StoryFormatParser*
-
-*StoryFormatParser* accepts the path to a story format's `format.js` file. Upon successful parsing, it keeps an internal *StoryFormat* object.
-
-`let sfp = new StoryFormatParser("path/format.js");`
-
-#### Properties
-
-* *storyFormat*: Either `null` (upon failure to parse) or a *StoryFormat* object
-
-### *HTMLParser*
-
-*HTMLParser* accepts HTML content to parse. Upon successful parsing, it stores an internal *Story* object.
-
-#### Properties
-
-* *story*: Upon successful parsing, this object will hold the story and all passages found.
-
-### *HTMLWriter*
-
-*HTMLWriter* accepts the path to an output file, a *Story* object, a *StoryFormat* object, and optional extra CSS and JS content.
-
-`let hw = new HTMLWriter("path/", Story, StoryFormat, extraCSS, extraJS)`
-
-## Common API Usage Patterns
-
-### Reading and Parsing a Twee file
-```
-const Extwee = require("extwee");
-
-let file = new Extwee.FileReader("tweefile.twee");
-let tp = new Extwee.TweeParser(file.contents);
-// tp.story will hold the parsed story and passages
-```
-
-### Reading and Parsing a Twine 2 HTML file
-```
-const Extwee = require("extwee");
-
-let file = new Extwee.FileReader("twine2.html");
-let hp = new Extwee.HTMLParser(file.contents);
-// hp.story will hold the parsed story and passages
-```
+# Status
+
+[![Build Status](https://travis-ci.org/videlais/extwee.svg?branch=master)](https://travis-ci.org/videlais/extwee)
+
+[![codecov](https://codecov.io/gh/videlais/extwee/branch/master/graph/badge.svg)](https://codecov.io/gh/videlais/extwee) [![npm version](https://badge.fury.io/js/extwee.svg)](https://badge.fury.io/js/extwee)
+
+[![NPM Badge](https://nodei.co/npm/extwee.png?downloads=true)](https://www.npmjs.com/package/extwee)
+
+## Summary
+
+Extwee is a Twee compiler supporting Twine 2-style formats using the [Twee 3 specification](https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md).
+
+It will read both Twee 2 (Twee2) and Twee 3 formatted files, but does not understand or currently support Twee 1 (Twine 1.4.2) or Twee2 special passages for Twine 1.X formatting.
+
+*Extwee does not support Twine 1.X story formats.*
+
+## Story Formats
+
+Starting with Extwee 1.5, the latest versions of Twine 2 story formats are included. See each story format for its own license.
+
+## Command-Line Usage
+
+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>`
+
+### Escaping Metacharacters
+
+Extwee will attempt to escape the metacharacters of `{`, `}`, `[`, and `]` when moving to and from Twee notation. However, even with this support, it *highly recommended* to avoid these characters in passage name and tags to avoid confusion and potential issues.
+
+## Installation
+
+Extwee can be installed via NPM.
+
+`npm i extwee`

package/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.6     | :x:                |
+| 2.0     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+When reporting a vulnerability, start with an issue. This will be flagged and integrated into the current project and fast-tracked for a new version.

package/babel.config.json

@@ -0,0 +1,22 @@
+{
+    "plugins": [
+      ["@babel/plugin-proposal-class-properties", { "loose": true }],
+      ["@babel/plugin-proposal-private-methods" , { "loose": true }],
+      ["@babel/plugin-proposal-private-property-in-object", { "loose": true }]
+    ],
+    "presets": [
+      [
+        "@babel/env",
+        {
+          "targets": {
+            "edge": "17",
+            "firefox": "60",
+            "chrome": "67",
+            "safari": "11.1"
+          },
+          "useBuiltIns": "usage",
+          "corejs": "3.8.0"
+        }
+      ]
+    ]
+  }

package/bin/extwee.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+
+/**
+ * @fileoverview CLI for Extwee
+ * @author Dan Cox
+ */
+
+// Import everything
+import Extwee from '../index.js';
+// Import Commander
+import { Command } from 'commander';
+
+// Creat a new Command
+const program = new Command();
+
+program
+.version('2.0.0')
+.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');
+
+// Set the process title
+process.title = 'extwee';
+
+// 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/index.js

@@ -1,26 +1,31 @@
-const FileReader = require('./src/FileReader.js');
-const TweeParser = require('./src/TweeParser.js');
-const TweeWriter = require('./src/TweeWriter.js');
-const StoryFormatParser = require('./src/StoryFormatParser.js');
-const HTMLParser = require('./src/HTMLParser.js');
-const HTMLWriter = require('./src/HTMLWriter.js');
-const DirectoryReader = require('./src/DirectoryReader.js');
-const DirectoryWatcher = require('./src/DirectoryWatcher.js');
-const Story = require('./src/Story.js');
-const Passage = require('./src/Passage.js');
-const StoryFormat = require('./src/StoryFormat.js');
-
-module.exports = {
-  FileReader: FileReader,
-  TweeParser: TweeParser,
-  TweeWriter: TweeWriter,
-  StoryFormat: StoryFormat,
-  Passage: Passage,
-  Story: Story,
-  StoryFormatParser: StoryFormatParser,
-  FileReader: FileReader,
-  HTMLParser: HTMLParser,
-  HTMLWriter: HTMLWriter,
-  DirectoryReader: DirectoryReader,
-  DirectoryWatcher: DirectoryWatcher
-};
+import FileReader from './src/FileReader.js';
+import TweeParser from './src/TweeParser.js';
+import TweeWriter from './src/TweeWriter.js';
+import StoryFormatParser from './src/StoryFormatParser.js';
+import HTMLParser from './src/HTMLParser.js';
+import HTMLWriter from './src/HTMLWriter.js';
+import Story from './src/Story.js';
+import Passage from './src/Passage.js';
+import StoryFormat from './src/StoryFormat.js';
+
+export { FileReader };
+export { TweeParser };
+export { StoryFormat };
+export { Passage };
+export { Story };
+export { StoryFormatParser };
+export { HTMLParser };
+export { HTMLWriter };
+
+// Export everything by default
+export default {
+    readFile: FileReader.read,
+    parseTwee: TweeParser.parse,
+    writeTwee: TweeWriter.write,
+    StoryFormat,
+    Passage,
+    Story,
+    parseStoryFormat: StoryFormatParser.parse,
+    parseHTML: HTMLParser.parse,
+    writeHTML: HTMLWriter.write
+};