hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-21 11:44:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: remove unnecessary features, update docs

Browse source
This commit is contained in:
littensy 2025-11-02 18:55:41 -08:00
parent 7a88c784fa
commit 37f79ecc3f
20 changed files with 774 additions and 955 deletions
Download patch file Download diff file Expand all files Collapse all files

8
packages/react-charm/src/__tests__/spec.luau
View file

@ -1,11 +1,11 @@
local suite = require("../../../../test/suite")
suite.describe("useAtom", function()
require("./useAtom.spec")
suite.describe("useSignalState", function()
require("./useSignalState.spec")
end)
suite.describe("useAtomBinding", function()
require("./useAtomBinding.spec")
suite.describe("useSignalBinding", function()
require("./useSignalBinding.spec")
end)
return {}

28
packages/react-charm/src/__tests__/useAtomBinding.spec.luau → packages/react-charm/src/__tests__/useSignalBinding.spec.luau
View file

@ -3,45 +3,43 @@ local ReactCharm = require("../")
local renderHook = require("./helpers/renderHook")
local suite = require("../../../../test/suite")
local atom = Charm.atom
local useAtomBinding = ReactCharm.useAtomBinding
local test = suite.test
test("tracks atom state", function()
local state = atom(0)
test("tracks signal state", function()
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtomBinding(state)
return ReactCharm.useSignalBinding(getState)
end)
assert(hook.result:getValue() == 0, "should return 0")
state(1)
setState(1)
assert(hook.result:getValue() == 1, "should return 1")
end)
test("accepts a selector", function()
local state = atom(0)
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtomBinding(function()
return 2 * state()
return ReactCharm.useSignalBinding(function()
return 2 * getState()
end)
end)
assert(hook.result:getValue() == 0, "should return 0")
state(1)
setState(1)
assert(hook.result:getValue() == 2, "should return 2")
end)
test("tracks dependencies", function()
local state = atom(0)
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtomBinding(state, { state })
return ReactCharm.useSignalBinding(getState, { getState })
end)
assert(hook.result:getValue() == 0, "should return 0")
state(1)
setState(1)
assert(hook.result:getValue() == 1, "should return 1")
state = atom(0)
getState, setState = Charm.signal(0)
hook.rerender()
assert(hook.result:getValue() == 0, "should return 0")
state(1)
setState(1)
assert(hook.result:getValue() == 1, "should return 1")
end)

28
packages/react-charm/src/__tests__/useAtom.spec.luau → packages/react-charm/src/__tests__/useSignalState.spec.luau
View file

@ -3,45 +3,43 @@ local ReactCharm = require("../")
local renderHook = require("./helpers/renderHook")
local suite = require("../../../../test/suite")
local atom = Charm.atom
local useAtom = ReactCharm.useAtom
local test = suite.test
test("tracks atom state", function()
local state = atom(0)
test("tracks signal state", function()
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtom(state)
return ReactCharm.useSignalState(getState)
end)
assert(hook.result == 0, "should return 0")
state(1)
setState(1)
assert(hook.result == 1, "should return 1")
end)
test("accepts a selector", function()
local state = atom(0)
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtom(function()
return 2 * state()
return ReactCharm.useSignalState(function()
return 2 * getState()
end)
end)
assert(hook.result == 0, "should return 0")
state(1)
setState(1)
assert(hook.result == 2, "should return 2")
end)
test("tracks dependencies", function()
local state = atom(0)
local getState, setState = Charm.signal(0)
local hook = renderHook(function()
return useAtom(state, { state })
return ReactCharm.useSignalState(getState, { getState })
end)
assert(hook.result == 0, "should return 0")
state(1)
setState(1)
assert(hook.result == 1, "should return 1")
state = atom(0)
getState, setState = Charm.signal(0)
hook.rerender()
assert(hook.result == 0, "should return 0")
state(1)
setState(1)
assert(hook.result == 1, "should return 1")
end)