lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2025-04-04 10:30:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

feat(types + tests): updated types and tests for @lune/fs

Browse source
This commit is contained in:
Erica Marigold 2024-01-21 11:06:36 +05:30
parent caecf9edd1
commit a1b11345a1
No known key found for this signature in database
GPG key ID: 2768CC0C23D245D1
2 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tests/fs/files.luau
View file

@ -9,22 +9,35 @@ local utils = require("./utils")
fs.writeDir(TEMP_DIR_PATH)
fs.writeDir(TEMP_ROOT_PATH)
-- Write both of our files
-- Write both of our files with string and buffer contents
fs.writeFile(TEMP_ROOT_PATH .. "/test_binary", utils.binaryBlob)
fs.writeFile(TEMP_ROOT_PATH .. "/test_json.json", utils.jsonBlob)
fs.writeFile(TEMP_ROOT_PATH .. "/test_binary_buf", buffer.fromstring(utils.binaryBlob))
fs.writeFile(TEMP_ROOT_PATH .. "/test_json_buf.json", buffer.fromstring(utils.jsonBlob))
-- Make sure reading the file we just
-- wrote gets us back the original strings
assert(
fs.readFile(TEMP_ROOT_PATH .. "/test_binary") == utils.binaryBlob,
"Binary file round-trip resulted in different strings"
buffer.tostring(fs.readFile(TEMP_ROOT_PATH .. "/test_binary")) == utils.binaryBlob,
"(String) Binary file round-trip resulted in different strings"
)
assert(
fs.readFile(TEMP_ROOT_PATH .. "/test_json.json") == utils.jsonBlob,
"JSON file round-trip resulted in different strings"
buffer.tostring(fs.readFile(TEMP_ROOT_PATH .. "/test_json.json")) == utils.jsonBlob,
"(String) JSON file round-trip resulted in different strings"
)
assert(
buffer.tostring(fs.readFile(TEMP_ROOT_PATH .. "/test_binary_buf")) == utils.binaryBlob,
"(Buffer) Binary file round-trip resulted in different strings"
)
assert(
buffer.tostring(fs.readFile(TEMP_ROOT_PATH .. "/test_json_buf.json")) == utils.jsonBlob,
"(Buffer) JSON file round-trip resulted in different strings"
)
-- Make sure file checks succeed but dir checks fail

4
types/fs.luau
View file

@ -107,7 +107,7 @@ local fs = {}
@param path The path to the file to read
@return The contents of the file
]=]
function fs.readFile(path: string): string
function fs.readFile(path: string): buffer
return nil :: any
end
@ -144,7 +144,7 @@ end
@param path The path of the file
@param contents The contents of the file
]=]
function fs.writeFile(path: string, contents: string) end
function fs.writeFile(path: string, contents: buffer | string) end
--[=[
@within FS