Skip to content

Commit

Permalink
Switch from preact-signals + wonka to uneventful
Browse files Browse the repository at this point in the history
  • Loading branch information
pjeby committed May 27, 2024
1 parent 7d00e85 commit 61f2fa9
Show file tree
Hide file tree
Showing 14 changed files with 215 additions and 420 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Changelog

Note: in versions 0.0.20+, Ophidian was using a combination of @preact/signals-core, Wonka.js, and a lot of custom code to do the things that in it will use [Uneventful](https://uneventful.js.org/) for. If you are *directly* using anything that's exported from the `src/signify.ts`, `src/eventful.ts`, or `src/cleanups.ts` modules, please be aware that they are almost all being deprecated in favor of Uneventful's equivalent APIs. Future versions in the 0.0.x range will include backward-compatible wrappers for the bits that don't involve Wonka.js (for which no backward-compatibility will be provided), but from version 0.1.0 on those will be gone.
### 0.0.25 (unreleased)

So, if you're using any APIs from those modules, please see [this Github issue](https://github.com/ophidian-lib/core/issues/3) to get more details, ask questions, or report issues.
- As of this version, [Uneventful](https://uneventful.js.org/) 0.0.5 is required as a peerDependency, and the old preact/wonka code has been removed.

Note: in versions 0.0.20 - 0.0.24, Ophidian was using a combination of @preact/signals-core, Wonka.js, and a lot of custom code to do the things that it now uses Uneventful for. If you were *directly* using anything exported from the `src/signify.ts`, `src/eventful.ts`, or `src/cleanups.ts` modules, please be aware that they are now almost all deprecated in favor of Uneventful's equivalent APIs. Future versions in the 0.0.x range will include backward-compatible wrappers for the bits that don't involve Wonka.js (for which no backward-compatibility will be provided), but from version 0.1.0 on those will be gone.

So, if you're using any APIs from those modules, please see [this Github issue](https://github.com/ophidian-lib/core/issues/3) to get more details, ask questions, or report issues.

### 0.0.24

Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
"i18next": "^20.3.2",
"monkey-around": "^3",
"obsidian": "1.3.5",
"to-use": "^0.3.3",
"wonka": "^6.3.4"
"to-use": "^0.3.3"
},
"devDependencies": {
"@codemirror/state": "^6.4.1",
Expand All @@ -40,6 +39,9 @@
"typedoc": "^0.25.13",
"typescript": "5.2.2"
},
"peerDependencies": {
"uneventful": "^0.0.5"
},
"scripts": {
"docs": "tsx typedoc/run.mts",
"watch-docs": "onchange -i --kill \"*.md\" \"guides/**/*.md\" \"typedoc.config.*\" \"typedoc/*\" -- tsx typedoc/run.mts --watch",
Expand Down
12 changes: 3 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 61f2fa9

Please sign in to comment.