npm - extwee - Versions diffs - 2.2.6 → 2.3.1 - Mend

extwee 2.2.6 → 2.3.1

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 (63) hide show

package/.github/dependabot.yml +1 -1
package/.github/workflows/dependabot-automerge.yml +23 -0
package/.github/workflows/nodejs.yml +4 -1
package/README.md +9 -0
package/SECURITY.md +1 -1
package/build/extwee.web.min.js +2 -0
package/build/extwee.web.min.js.LICENSE.txt +1 -0
package/docs/README.md +79 -55
package/docs/_sidebar.md +0 -1
package/docs/install/npm.md +0 -4
package/docs/install/npx.md +70 -0
package/extwee.config.json +6 -0
package/extwee.config.md +67 -0
package/package.json +22 -22
package/src/CLI/CommandLineProcessing.js +196 -0
package/src/CLI/ProcessConfig/loadStoryFormat.js +102 -0
package/src/CLI/ProcessConfig/readDirectories.js +46 -0
package/src/CLI/ProcessConfig.js +175 -0
package/src/CLI/isDirectory.js +27 -0
package/src/CLI/isFile.js +28 -0
package/src/Config/parser.js +30 -8
package/src/Passage.js +17 -2
package/src/Story.js +92 -1
package/src/extwee.js +20 -195
package/test/Config/Config.test.js +40 -10
package/test/Config/files/full.json +8 -0
package/test/Config/files/valid.json +4 -3
package/test/Config/isDirectory.test.js +44 -0
package/test/Config/isFile.test.js +50 -0
package/test/Config/loadStoryFormat.test.js +101 -0
package/test/Config/readDirectories.test.js +68 -0
package/test/Objects/Passage.test.js +5 -0
package/test/Objects/Story.test.js +131 -0
package/test/TWS/Parse.test.js +0 -22
package/test/Web/window.Extwee.test.js +85 -0
package/types/Story.d.ts +25 -0
package/types/index.d.ts +4 -2
package/types/src/CLI/CommandLineProcessing.d.ts +8 -0
package/types/src/CLI/ProcessConfig/loadStoryFormat.d.ts +20 -0
package/types/src/CLI/ProcessConfig/readDirectories.d.ts +9 -0
package/types/src/CLI/ProcessConfig.d.ts +12 -0
package/types/src/CLI/isDirectory.d.ts +1 -0
package/types/src/CLI/isFile.d.ts +1 -0
package/types/src/Config/parser.d.ts +6 -0
package/types/src/Config/reader.d.ts +11 -0
package/types/src/IFID/generate.d.ts +14 -0
package/types/src/JSON/parse.d.ts +44 -1
package/types/src/Passage.d.ts +49 -4
package/types/src/Story.d.ts +110 -16
package/types/src/StoryFormat/compile.d.ts +8 -0
package/types/src/StoryFormat/parse.d.ts +46 -3
package/types/src/StoryFormat.d.ts +69 -38
package/types/src/TWS/parse.d.ts +3 -3
package/types/src/Twee/parse.d.ts +3 -4
package/types/src/Twine1HTML/compile.d.ts +3 -1
package/types/src/Twine1HTML/parse.d.ts +3 -4
package/types/src/Twine2ArchiveHTML/compile.d.ts +8 -0
package/types/src/Twine2ArchiveHTML/parse.d.ts +31 -1
package/types/src/Twine2HTML/compile.d.ts +7 -2
package/types/src/Twine2HTML/parse.d.ts +12 -9
package/docs/install/binaries.md +0 -9
package/index.html +0 -22
package/test/TWS/TWSParser/Example1.tws +0 -150

package/.github/dependabot.yml CHANGED Viewed

@@ -8,4 +8,4 @@ updates:
   - package-ecosystem: "npm" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "monthly"

package/.github/workflows/dependabot-automerge.yml ADDED Viewed

@@ -0,0 +1,23 @@
+name: Dependabot auto-merge
+on: pull_request
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'videlais/extwee'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@d7267f607e9d3fb96fc2fbe83e0af444713e90b7
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/nodejs.yml CHANGED Viewed

@@ -2,6 +2,9 @@ name: Node CI
 on: [push]
+permissions:
+  contents: read
 jobs:
   build:
@@ -9,7 +12,7 @@ jobs:
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [23.x]
     steps:
     - uses: actions/checkout@v4

package/README.md CHANGED Viewed

@@ -21,6 +21,7 @@
   </ol>
   <li><a href="#documentation">Documentation</a></li>
   <li><a href="#command-line-usage">Command-Line Usage</a></li>
+  <li><a href="#config-file-usage">Config File Usage</a></li>
   <li><a href="#escaping- meta-characters">Escaping Meta-Characters</a></li>
   <li><a href="#license">License</a></li>
   </ol>
@@ -169,6 +170,14 @@ Enabling Twine 1 mode requires using the `--twine1` flag.
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
+## Config File Usage
+When invoked from its command-line interface using `npx extwee`, it will look for a `extwee.config.json` file in the local directory. If found, and its fields are valid, processing will use the values found in the file.
+Consult the possible options in its [dedicated file](extwee.config.md).
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 ## Tree Shaking Support
 For [advanced tree shaking](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking) patterns, most formats are broke into `compile.js` and `parse.js` files exporting associated `compile()` and `parse()` functions.

package/SECURITY.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.6     | :x:                |
-| 2.2     | :white_check_mark: |
+| 2.X     | :white_check_mark: |
 ## Reporting a Vulnerability