@rbxts/rl 0.1.11 → 0.1.13

package/README.md

@@ -10,7 +10,7 @@
 ## Wally
 Add the following to your `wally.toml`, in the `[dependencies]` section:
 ```toml
-rl = "wiam/rl@<version>"
+rl = "wiam77/rl@<version>"
 ```
 
 Then run:

package/base_pesde.toml

@@ -1,5 +1,5 @@
 name = "wiam/rl"
-version = "0.1.11"
+version = "0.1.13"
 description = "Simple reactive library for Luau."
 authors = ["wiam"]
 repository = "https://codeberg.org/wiam/rl"

package/build.luau

@@ -4,7 +4,7 @@ local fs = require("@lune/fs")
 local serde = require("@lune/serde")
 
 local TARGETS = {"luau", "lune", "roblox"}
-local INCLUDES = {"src", "COPYING", "PESDE_README.md", "docs"}
+local INCLUDES = {"src", "COPYING", "README.md", "docs"}
 
 local base_manifest = fs.readFile("base_pesde.toml")
 
@@ -19,7 +19,7 @@ for _, target in TARGETS do
 	fs.writeDir(out_dir)
 
 	for _, include in INCLUDES do
-		fs.copy(include, out_dir.."/"..if include == "PESDE_README.md" then "README.md" else include)
+		fs.copy(include, out_dir.."/"..include)
 	end
 
 	fs.writeFile(out_dir.."/pesde.toml", base_manifest.."\n"..serde.encode("toml", {target = {

package/docs/api_ref.md

@@ -1,7 +1,7 @@
 # rl API Reference
 ## Types
 ### state\<T>
-The [state](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#state) type.
+The [state](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#state) type.
 
 ```luau
 type state<T> = (() -> T) & ((value : T, force : boolean?) -> T) & {
@@ -10,7 +10,7 @@ type state<T> = (() -> T) & ((value : T, force : boolean?) -> T) & {
 ```
 
 ### callback
-Function which gets called when its [effect](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#effect) is triggered.
+Function which gets called when its [effect](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#effect) is triggered.
 Takes the previous value of the state which triggered the effect, as well as its "index", determined by the order in which it appears within the function.
 
 ```luau
@@ -19,12 +19,11 @@ type callback<T> = (old_value : T, state_i : number?) -> any
 
 ## Functions
 ### state
-Creates a new [state](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#state), with the given initial value, and whether to always [force](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#forcing), and returns it.
+Creates a new [state](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#state), with the given initial value, and whether to always [force](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#forcing), and returns it.
 
 ```luau
 function state<T>(value : T?, force : boolean?) : state<T>
 
--- Example
 local health = state(100)
 local stamina = state(100, true)
 ```
@@ -41,7 +40,6 @@ as how would happen with a function which's return value depends on a State.
 ```luau
 function derive<T, U>(callback : () -> U) : (state<U>, () -> (), true)
 
--- Example
 -- without derive() (normal function)
 local half_health = function()
 	print("some computation")
@@ -65,12 +63,11 @@ print(derive_half_health()) -- 10
 ```
 
 ### effect
-Creates a new [effect](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#effect), with the given [callback](https://pesde.dev/packages/wiam/rl/latest/any/docs/api_ref#callback) function, and returns its disconnect function.
+Creates a new [effect](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#effect), with the given [callback](https://pesde.dev/packages/wiam/rl/latest/any/docs/api_ref#callback) function, and returns its disconnect function.
 
 ```luau
 function effect<T>(callback : callback<T>) : () -> ()
 
--- Example
 effect(function()
 	print(`new health: {health()}`)
 end)
@@ -96,7 +93,6 @@ Batches any State write operation up until the function is done running.
 ```luau
 function batch(f : () -> any) : ()
 
--- Example
 batch(function()
 	health(420)
 	health(1337, true)
@@ -104,7 +100,6 @@ batch(function()
 end)
 
 -- "new health: 69"
-
 ```
 
 ### scope
@@ -115,7 +110,6 @@ This is intended to be used for disconnecting Effects in bulk.
 ```luau
 function scope<T>(... : T) : () -> ()
 
--- Example
 -- without scope
 local disconnect_health = effect(function()
 	print(`your health is : {health()}`)
@@ -146,14 +140,13 @@ vitals_scope()
 ```
 
 ### branch
-Alternative `if`-like function to be used within effects. Learn more about it in the [tracking section of the Concepts page](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#tracking).
+Alternative `if`-like function to be used within effects. Learn more about it in the [tracking section of the intro page](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#tracking).
 Pass a condition to be checked, and after it a function to be run if it's successful.
 The last value, if a function, and if not after a condition, will be threated as the "else" branch.
 
 ```luau
 function branch(...) : ()
 
--- Example
 -- A single effect for the same functionality as the examples above, thanks to the use of state_i and the branching function.
 effect(function(_, state_i)
 	branch(
@@ -175,7 +168,6 @@ Returns the given table, as well as a function which disconnects all created eff
 ```luau
 function mirror<K, V>(t : {[K] : V}) : ({[K] : V}, () -> ())
 
--- Example
 local name = state("john")
 local data = mirror {
 	username = name,
@@ -191,12 +183,11 @@ print({data.username}) -- "joe"; didn't update because we disconnected the effec
 ```
 
 ### cleanup
-Disconnects all [effects](https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts#effect).
+Disconnects all [effects](https://pesde.dev/packages/wiam/rl/latest/any/docs/intro#effect).
 
 ```luau
 function cleanup() : ()
 
--- Example
 cleanup()
 health(77) -- doesn't print because no effect is connected to this state (we just disconnected)
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/rl",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "simple reactive library",
   "publishConfig": {
     "access": "public"

package/pesde.lock

@@ -0,0 +1,11 @@
+# This file is automatically @generated by pesde.
+# It is not intended for manual editing.
+format = 2
+name = "wiam/rl_root"
+version = "1.0.0"
+target = "lune"
+
+[workspace."wiam/rl"]
+roblox = "build/roblox"
+lune = "build/lune"
+luau = "build/luau"

package/src/init.luau

@@ -171,7 +171,7 @@ end
 
 	@param callback () -> U -- the callback
 	@return derived_state state<U> -- the State that was created
-	@return disconnect () -> -- the created Effect's disconnect function
+	@return disconnect () -> () -- the created Effect's disconnect function
 	@return flag true -- a flag used internally by rl.scope(); can be ignored.
 ]=]
 function rl.derive<T, U>(callback : () -> U) : (state<U>, () -> (), true)

package/wally.toml

@@ -1,7 +1,7 @@
 [package]
 name = "wiam77/rl"
-description = "Simple reactive library for Luau. Docs: https://pesde.dev/packages/wiam/rl/latest/any/docs/concepts"
-version = "0.1.11"
+description = "Simple reactive library for Luau. Docs: https://pesde.dev/packages/wiam/rl/latest/any/docs/intro"
+version = "0.1.13"
 license = "GPL-3.0-or-later"
 registry = "https://github.com/UpliftGames/wally-index"
 realm = "shared"

package/PESDE_README.md

@@ -1,39 +0,0 @@
-# rl
-`rl` is a simple reactive library for Luau, inspired by [Vide](https://centau.github.io/vide)'s sources and effects system.
-
-# API Reference
-You can read `rl`'s API reference [here](https://pesde.dev/packages/wiam/rl/latest/any/docs/api_ref).
-
-# Demo
-```luau
---!strict
-
-local rl = require("path/to/rl")
-local s = rl.state
-local e = rl.effect
-
-local name = s("john", true)
-local login_year = s(2020)
-
-local login_d = e(function(last_login : number)
-	print(`{name.value}, it's been {login_year() - (last_login or 0)} years!`)
-end)
-
-login_year(2025) -- "wiam, it's been 5 years!"
-login_year(2025) -- doesn't print because value didn't change
-login_year(2025, true) -- "wiam, it's been 0 years!" - this prints since it's forced
-
-name("doe") -- doesn't print because we are reading with name.value, and not name()
-
-e(function(old_name : string)
-	print(`hey {old_name}, your name has been changed to '{name()}'`)
-end)
-
-name("jane") -- "hey doe, your name has been changed to jane"
-name("jane") -- "hey jane, your name has been changed to jane" - this one is forced by default
-
-login_d()
-login_year(2026) -- doesn't print because the effect was disconnected
-
-rl.cleanup() -- disconnect all effects
-```

package/publish.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
- 
-pesde run build && pesde update && pesde publish -y && wally publish