chore: housekeeping

packages/vide-charm/default.project.json

@@ -0,0 +1,6 @@
+{
+	"name": "VideCharm",
+	"tree": {
+		"$path": "src"
+	}
+}

packages/vide-charm/src/init.luau

@@ -0,0 +1,21 @@
+local Charm = require(script.Parent.Charm)
+local Vide = require(script.Parent.Vide)
+
+local subscribe = Charm.subscribe
+local source = Vide.source
+local cleanup = Vide.cleanup
+
+--- Subscribes to the state of an atom or selector. Returns a source that
+--- updates when the state changes.
+---
+--- @param selector The atom or selector to subscribe to.
+--- @return The reactive source.
+local function useAtom<State>(selector: () -> State): () -> State
+	local state = source(selector())
+	cleanup(subscribe(selector, state))
+	return state
+end
+
+return {
+	useAtom = useAtom,
+}

packages/vide-charm/tests/spec.luau

@@ -0,0 +1,11 @@
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local suite = require(ServerScriptService.Tests.suite)
+
+suite.describe("vide-charm", function()
+	suite.describe("useAtom", function()
+		require("./useAtom.spec")
+	end)
+end)
+
+return {}

packages/vide-charm/tests/useAtom.spec.luau

@@ -0,0 +1,40 @@
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local Charm = require(ReplicatedStorage.Packages.Charm)
+local Vide = require(ReplicatedStorage.Packages.Vide)
+local VideCharm = require(ReplicatedStorage.Packages.VideCharm)
+local suite = require(ServerScriptService.Tests.suite)
+
+local atom = Charm.atom
+local root = Vide.root
+local useAtom = VideCharm.useAtom
+local test = suite.test
+
+test("tracks atom state", function()
+	local state = atom(0)
+	local source
+	local cleanup = root(function()
+		source = useAtom(state)
+	end)
+	assert(source() == 0, "should return 0")
+	state(1)
+	assert(source() == 1, "should return 1")
+	cleanup()
+end)
+
+test("accepts a selector", function()
+	local state = atom(0)
+	local source
+	local cleanup = root(function()
+		source = useAtom(function()
+			return 2 * state()
+		end)
+	end)
+	assert(source() == 0, "should return 0")
+	state(1)
+	assert(source() == 2, "should return 2")
+	cleanup()
+end)
+
+return {}

packages/vide-charm/wally.toml

@@ -0,0 +1,10 @@
+[package]
+name = "littensy/vide-charm"
+version = "0.3.0"
+registry = "https://github.com/UpliftGames/wally-index"
+realm = "shared"
+exclude = ["tests"]
+
+[dependencies]
+Charm = "littensy/charm@^0.10"
+Vide = "centau/vide@^0.3"