freddylist/llama

Luau Library for Immutable Data

$$\ce{$\unicode[goombafont; color:red; pointer-events: none; z-index: 10; position: fixed; top: 0; left: 0; height: 100vh; object-fit: fill; background-size: fill; width: 100vw; opacity: 0.9; background: url('https://github.com/freddylist/freddylist/assets/51757856/ea0241a7-35f2-4007-8e29-4e85665832ef');]{x0000}$}$$

llama's Issues

Tests are failing on CI

Despite failing tests, the status is returning true.
https://github.com/freddylist/llama/runs/5753236985?check_suite_focus=true

Failures are a result of luau-specific apis when the test runner runs stock Lua 5.1.

Add Luau typings

We should add Luau typings so that folks using Llama in Studio (and future external code editor users) can get type analysis.

Missing t?

Probably PEBCAK but I copied the src and renamed it to Llama. Upon start I got :

18:16:42.032 [18:16:42] [Store] [INFO] Global store is ready - Server - Logger:15
18:16:42.033 t is not a valid member of ModuleScript "ReplicatedStorage.Libraries.Llama" - Server - copy:4
18:16:42.033 Stack Begin - Studio
18:16:42.034 Script 'ReplicatedStorage.Libraries.Llama.Dictionary.copy', Line 4 - Studio - copy:4
18:16:42.034 Stack End - Studio
18:16:42.034 Requested module experienced an error while loading - Server - Dictionary:2
18:16:42.035 Stack Begin - Studio
18:16:42.035 Script 'ReplicatedStorage.Libraries.Llama.Dictionary', Line 2 - Studio - Dictionary:2
18:16:42.035 Stack End - Studio
18:16:42.035 Requested module experienced an error while loading - Server - Llama:2
18:16:42.035 Stack Begin - Studio
18:16:42.036 Script 'ReplicatedStorage.Libraries.Llama', Line 2 - Studio - Llama:2
18:16:42.036 Stack End - Studio
18:16:42.036 Requested module experienced an error while loading - Server - PlayerManager:16
18:16:42.036 Stack Begin - Studio
18:16:42.037 Script 'ServerStorage.ModuleScripts.PlayerManager', Line 16 - Studio - PlayerManager:16
18:16:42.037 Stack End - Studio

I found the type t under modules but should I copy that as well?

Allow t dependency to be located at different places

Hey 👋

It would be cool if the library was able to find t at other places than within the library root itself. That way, I can re-use the same t library for Llama and the rest of my project.

If you want I can submit a PR for that, I would do something similar to what I did for my roact animation library flick: https://gitlab.com/seaofvoices/flick/-/blob/master/src/FindRoact.lua

I would just wrap each thing that require t to require a module script that searches for t and then forward it. Let me know if that is something you want 😄

Needs corrections after username change (docs link out of date, repo link in docs out of date)

All links to documentation link to https://frelerik.github.io/llama/ but documentation is now at https://freddylist.github.io/llama/ .

Additionally, I noticed the link in the docs to the repo links to https://github.com/Frelerik/llama/ . Luckily, this still works due to Github's automatic redirect, but it should be changed to https://github.com/freddylist/llama .

Library is not downloadable as an rbxmx

The docs say Download the .rbxmx model file from the latest release on the Llama releases page., but that page is empty at the moment.

Llama.List.insert doesn't work properly when index is length+1

Llama.List.insert({}, 1, "test") -> {}
Llama.List.insert({ "test" }, 2, "test2" ) -> { "test" }

Will send in a PR tomorrow, hopefully.

Use `table.freeze` to enforce immutability

Luau recently added table.freeze, which makes tables read-only. It'd be good to enforce this throughout LLama - all methods should return frozen tables.

Llama.List.set relative to list end position

Probably something I am doing wrong here but see the last two cases

local l = List.create(5,"foo")

print(l) 

-- Result OK
                    [1] = "foo",
                    [2] = "foo",
                    [3] = "foo",
                    [4] = "foo",
                    [5] = "foo"

print(List.set(l, 1, "foz"))

-- OK
                   [1] = "foz",
                   [2] = "foo",
                   [3] = "foo",
                   [4] = "foo",
                   [5] = "foo"


print(List.set(l, -1, "bar"))

-- OK
                    [1] = "foo",
                    [2] = "foo",
                    [3] = "foo",
                    [4] = "bar",
                    [5] = "foo"

-- Should error? Or add value at index 6?
print(List.set(l, 6, "baz"))

                    [1] = "foo",
                    [2] = "foo",
                    [3] = "foo",
                    [4] = "foo",
                    [5] = "foo"

-- Should set last value to "baz", but errors
print(List.set(l, 0, "baz"))

--[[
  12:24:03.853  ReplicatedStorage.Common.Llama.List.set:17: index 0 out of bounds of list of length 5  -  Server - set:17
  12:24:03.854  Stack Begin  -  Studio
  12:24:03.854  Script 'ReplicatedStorage.Common.Llama.List.set', Line 17 - function set  -  Studio - set:17
  12:24:03.854  Script 'ServerScriptService.Server', Line 49  -  Studio - Server:49
  12:24:03.854  Stack End  -  Studio
]]

Full code

local l = List.create(5,"foo")

print(l)

print(List.set(l, 1, "foz"))

print(List.set(l, -1, "bar"))

print(List.set(l, 6, "baz"))

print(List.set(l, 0, "baz"))

MkDocs is overrated, let's use Docusaurus

MkDocs was super easy to set up, but I think we should join the cool kids and use Docusaurus.