@rohal12/twee-ts 1.18.2 → 2.1.0

package/README.md

@@ -11,7 +11,9 @@
 
 TypeScript reimplementation of [Tweego](https://www.motoslave.net/tweego/) — a command-line compiler for Twine/Twee interactive fiction projects.
 
-Zero runtime dependencies. Node.js 22+.
+Zero runtime dependencies (the parsers it uses, parse5 and acorn, are bundled). Node.js 24+.
+
+Upgrading from 1.x? Read **[Migrating to 2.0](https://rohal12.github.io/twee-ts/migrating-to-2)**.
 
 **[Documentation](https://rohal12.github.io/twee-ts/)**
 
@@ -51,6 +53,7 @@ const result = await compile({
   sources: ['src/'],
   tagAliases: { library: 'script' },
 });
+console.log(result.diagnostics);
 ```
 
 ## Build Plugins
@@ -71,9 +74,12 @@ Also available: `@rohal12/twee-ts/rollup`. In both plugins, compile errors fail
 Full docs at **[rohal12.github.io/twee-ts](https://rohal12.github.io/twee-ts/)**:
 
 - [Getting Started](https://rohal12.github.io/twee-ts/getting-started)
+- [Differences from Tweego](https://rohal12.github.io/twee-ts/tweego-differences)
+- [Migrating to 2.0](https://rohal12.github.io/twee-ts/migrating-to-2)
 - [CLI Reference](https://rohal12.github.io/twee-ts/cli)
 - [Configuration](https://rohal12.github.io/twee-ts/configuration)
 - [Tag Aliases](https://rohal12.github.io/twee-ts/tag-aliases)
+- [Output Modes](https://rohal12.github.io/twee-ts/output-modes)
 - [Programmatic API](https://rohal12.github.io/twee-ts/api)
 - [Vite & Rollup Plugins](https://rohal12.github.io/twee-ts/plugins)
 - [Story Formats](https://rohal12.github.io/twee-ts/story-formats)
@@ -81,15 +87,29 @@ Full docs at **[rohal12.github.io/twee-ts](https://rohal12.github.io/twee-ts/)**
 
 ## Development
 
+You need Node.js 24 or later and pnpm 12, the version `packageManager` in `package.json` pins; `devEngines` makes the install fail on an older Node.js. Get pnpm 12 with `npm install -g pnpm@12`, or run `corepack enable` and let Corepack read the pinned version. A standalone pnpm 10 or 11 cannot install the project: it tries to switch to the pinned pnpm 12 and fails with `ERR_PNPM_NO_MATCHING_VERSION` for `@pnpm/linux-x64@12.10.1` (pnpm 12 renamed its platform packages), so update pnpm first. [CONTRIBUTING.md](CONTRIBUTING.md) lists the checks a change has to pass.
+
 ```sh
 pnpm install
-pnpm test            # run tests
+pnpm test            # run tests (including every example in these docs)
 pnpm run typecheck   # type-check
+pnpm run lint        # ESLint
 pnpm run build       # bundle
 pnpm run docs:dev    # local docs dev server
 pnpm run docs:build  # build docs for deployment
+pnpm run test:contracts  # build, then run the compiler contract matrix against it
 ```
 
+Releases need recorded validation evidence: see
+[Compiler Validation and Releases](https://rohal12.github.io/twee-ts/compiler-validation).
+
 ## License
 
-This is free and unencumbered software released into the public domain. See [UNLICENSE](UNLICENSE).
+The twee-ts source code is free and unencumbered software released into the public domain. See [UNLICENSE](UNLICENSE).
+
+The published package is not entirely public domain:
+
+- twee-ts reimplements [Tweego](https://www.motoslave.net/tweego/) and ports parts of its Go source. Tweego is © Thomas Michael Edwards under the BSD 2-Clause licence.
+- The JavaScript in `dist/` bundles third-party packages (such as parse5 and acorn), which keep their own licences (MIT and BSD 2-Clause).
+
+[THIRD_PARTY_NOTICES](THIRD_PARTY_NOTICES) lists every bundled package with its licence text, reproduces Tweego's notice, and ships in the npm package. The build regenerates it from what it actually bundled. If you redistribute twee-ts, or bundle it into your own build, keep that file with it.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,111 @@
+THIRD-PARTY NOTICES for @rohal12/twee-ts
+
+The twee-ts source code is released into the public domain under the Unlicense
+(see UNLICENSE). twee-ts is a reimplementation of Tweego and ports parts of
+Tweego's Go source, so Tweego's licence is reproduced below. The JavaScript
+files in dist/ also bundle the third-party packages listed after it; that code
+stays under its own licence.
+
+This file is generated by scripts/third-party-notices.mjs during the build.
+Do not edit it by hand.
+
+================================================================================
+Tweego
+https://www.motoslave.net/tweego/
+License: BSD-2-Clause
+--------------------------------------------------------------------------------
+
+Copyright (c) 2014-2020, Thomas Michael Edwards <thomasmedwards@gmail.com>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+================================================================================
+acorn
+https://github.com/acornjs/acorn
+License: MIT
+--------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (C) 2012-2022 by various contributors (see AUTHORS)
+
+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.
+
+================================================================================
+entities
+https://github.com/fb55/entities
+License: BSD-2-Clause
+--------------------------------------------------------------------------------
+
+Copyright (c) Felix Böhm
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+================================================================================
+parse5
+https://github.com/inikulin/parse5
+License: MIT
+--------------------------------------------------------------------------------
+
+Copyright (c) 2013-2019 Ivan Nikulin (ifaaan@gmail.com, https://github.com/inikulin)
+
+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/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>