extwee 2.2.1 → 2.2.3

package/.eslintrc.json

@@ -1,25 +1,19 @@
 {
     "env": {
         "browser": true,
-        "es2023": true,
+        "es2021": true,
+        "node": true,
         "jest/globals": true
     },
-    "extends": [
-        "standard",
-        "plugin:jest/recommended",
-        "plugin:jsdoc/recommended"
-    ],
+    "extends": "standard",
     "parserOptions": {
-        "ecmaVersion": 13,
+        "ecmaVersion": "latest",
         "sourceType": "module"
     },
     "rules": {
-        "semi": ["error", "always"]
+        "semi": [2, "always"]
     },
     "plugins": [
-        "jest",
-        "@babel",
-        "jsdoc"
-    ],
-    "parser": "@babel/eslint-parser"
+        "jest"
+    ]
 }

package/.github/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ develop ]
+    paths-ignore:
+      - 'test/**'
+  pull_request:
+    branches: [ develop ]
+    paths-ignore:
+      - 'test/**'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        upload: false # disable the upload here - we will upload in a different action
+        output: sarif-results
+
+    - name: filter-sarif
+      uses: advanced-security/filter-sarif@v1
+      with:
+        # filter out all test files unless they contain a sql-injection vulnerability
+        patterns:
+          -test/**/*
+          +test/**/*:js/sql-injection
+        input: sarif-results/${{ matrix.language }}.sarif
+        output: sarif-results/${{ matrix.language }}.sarif
+
+    - name: Upload SARIF
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: sarif-results/${{ matrix.language }}.sarif

package/README.md

@@ -27,11 +27,11 @@
 
 ## Story Compilation
 
-The process of *story compilation* converts human-readable content, what is generally called a *story*, into a playable format such as HyperText Markup Language (HTML) able to be read by another application such as a web browser. The result is then presented as links or other visual, interactive elements to a player or reader, depending on the work created.
+The process of *story compilation* converts human-readable content, what is generally called a *story*, into a playable format such as HyperText Markup Language (HTML). The result is then presented as links or other visual, interactive elements for another party to interact with to see its content.
 
-The term *compilation* is used because different parts of code are put together in a specific arrangement to enable later play. As part of Twine-compatible HTML, this means combining story format JavaScript code with story HTML data.
+The term *compilation* is used because different parts of code are put together in a specific arrangement to enable later play. As part of Twine-compatible HTML, this means combining JavaScript code (generally a "story format") with story HTML data.
 
-Extwee is **not** an authoring tool. It cannot be used to create story content. This data must be created using other tools or processes. Extwee can then *compile* the story with story format code to produce something playable.
+Extwee is **not** an authoring tool. It cannot be used to create story content. This data must be created using other tools or processes. Extwee can then *compile* the content with story format code to produce something playable.
 
 Playable formats are the following and require external story formats[^1] to enable play:
 
@@ -113,6 +113,12 @@ Compiles story, story formats, or other data into an archive or playable format.
 
 **Note:** In order to create playable Twine 1 HTML, an `engine.js` file must be supplied.
 
+### Support Functionality
+
+Multiple Twine formats support using [an IFID](https://ifdb.org/help-ifid) to identify one work from another.
+
+As part of its API, the Extwee method `generateIFID()` can be used to create a new IFID for a `Story` object or as part of other processes.
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Documentation