stdlib: cleanup @std/fs (renaming/removing APIs) (#606)

As part of the API audit/cleanup, we are fixing `@std/fs` APIs.

This is mostly renaming and removing unnecessary functions, gonna leave
`fs.watch` to be its separate PR

Parallel changes to `@lute/fs` will be in a subsequent PR after we've
agreed on how @std should look like

Author: annieetang

docs/scripts/reference.luau

@@ -235,7 +235,7 @@ local function processDirectory(
 )
 	fs.createdirectory(documentationPath, { makeparents = true })
 
-	local entries = fs.listdir(modulePath)
+	local entries = fs.listdirectory(modulePath)
 
 	for _, entry in entries do
 		local entryPath = path.join(modulePath, entry.name)

examples/async_read.luau

@@ -13,7 +13,7 @@ else
 	print("Failed to create directory")
 end
 
-fs.rmdir(directory)
+fs.removedirectory(directory)
 
 if not fs.exists(directory) then
 	print("Directory successfully removed")

examples/create_directory.luau

@@ -11,7 +11,7 @@ end
 local function findtestfilesrec(directory: path.path): { path.path }
 	local results = {}
 
-	for _, entry in fs.listdir(directory) do
+	for _, entry in fs.listdirectory(directory) do
 		local fullPath = path.join(directory, entry.name)
 
 		if entry.type == "dir" then

lute/cli/commands/test/finder.luau

@@ -10,13 +10,14 @@ local sys = require("@std/system")
 local fslib = {}
 
 export type handlemode = fs.HandleMode
-export type filehandle = fs.FileHandle
-export type filetype = fs.FileType
-export type filemetadata = fs.FileMetadata
+export type file = fs.FileHandle
+export type type = fs.FileType
+export type metadata = fs.FileMetadata
 export type directoryentry = fs.DirectoryEntry
 export type watchhandle = fs.WatchHandle
 export type watchevent = fs.WatchEvent
-export type pathlike = pathlib.pathlike
+
+type pathlike = pathlib.pathlike
 
 export type createdirectoryoptions = {
 	makeparents: boolean?,
@@ -30,39 +31,39 @@ export type walkoptions = {
 	recursive: boolean?,
 }
 
-function fslib.open(path: pathlike, mode: handlemode?): filehandle
+function fslib.open(path: pathlike, mode: handlemode?): file
 	return fs.open(pathlib.format(path), mode)
 end
 
-function fslib.read(handle: filehandle): string
-	return fs.read(handle)
+function fslib.read(file: file): string
+	return fs.read(file)
 end
 
-function fslib.write(handle: filehandle, contents: string): ()
-	return fs.write(handle, contents)
+function fslib.write(file: file, contents: string): ()
+	return fs.write(file, contents)
 end
 
-function fslib.close(handle: filehandle): ()
-	return fs.close(handle)
+function fslib.close(file: file): ()
+	return fs.close(file)
 end
 
 function fslib.remove(path: pathlike): ()
 	return fs.remove(pathlib.format(path))
 end
 
-function fslib.stat(path: pathlike): filemetadata
+function fslib.metadata(path: pathlike): metadata
 	return fs.stat(pathlib.format(path))
 end
 
-function fslib.type(path: pathlike): filetype
+function fslib.type(path: pathlike): type
 	return fs.type(pathlib.format(path))
 end
 
 function fslib.link(src: pathlike, dest: pathlike): ()
 	return fs.link(pathlib.format(src), pathlib.format(dest))
 end
 
-function fslib.symlink(src: pathlike, dest: pathlike): ()
+function fslib.symboliclink(src: pathlike, dest: pathlike): ()
 	return fs.symlink(pathlib.format(src), pathlib.format(dest))
 end
 
@@ -78,14 +79,10 @@ function fslib.copy(src: pathlike, dest: pathlike): ()
 	return fs.copy(pathlib.format(src), pathlib.format(dest))
 end
 
-function fslib.listdir(path: pathlike): { directoryentry }
+function fslib.listdirectory(path: pathlike): { directoryentry }
 	return fs.listdir(pathlib.format(path))
 end
 
-function fslib.rmdir(path: pathlike): ()
-	return fs.rmdir(pathlib.format(path))
-end
-
 function fslib.readfiletostring(filepath: pathlike): string
 	return fs.readfiletostring(pathlib.format(filepath))
 end
@@ -94,10 +91,6 @@ function fslib.writestringtofile(filepath: pathlike, contents: string): ()
 	return fs.writestringtofile(pathlib.format(filepath), contents)
 end
 
-function fslib.readasync(filepath: pathlike): string
-	return fs.readasync(pathlib.format(filepath))
-end
-
 function fslib.createdirectory(path: pathlike, options: createdirectoryoptions?): ()
 	if options and options.makeparents then
 		local parsed = pathlib.parse(path)
@@ -129,7 +122,7 @@ function fslib.removedirectory(path: pathlike, options: removedirectoryoptions?)
 	if options and options.recursive then
 		-- Recursively delete all contents first
 		if fslib.exists(path) and fslib.type(path) == "dir" then
-			local entries = fslib.listdir(path)
+			local entries = fslib.listdirectory(path)
 			for _, entry in entries do
 				local entryPath = pathlib.join(path, entry.name)
 				if entry.type == "dir" then
@@ -157,7 +150,7 @@ function fslib.walk(path: pathlike, options: walkoptions?): () -> path?
 			end
 
 			if fslib.type(current) == "dir" and options and options.recursive then
-				local entries = fslib.listdir(current)
+				local entries = fslib.listdirectory(current)
 				for _, entry in entries do
 					local fullPath = pathlib.join(current, entry.name)
 					table.insert(queue, fullPath)

lute/std/libs/fs.luau

@@ -52,7 +52,7 @@ test.suite("Lute CLI Run", function(suite)
 
 	suite:afterall(function()
 		if fs.exists(testDirStr) then
-			fs.rmdir(testDirStr)
+			fs.removedirectory(testDirStr)
 		end
 	end)
 end)

tests/cli/loadbypath.test.luau

@@ -14,7 +14,7 @@ test.suite("FsSuite", function(suite)
 		fs.write(h, "abc")
 		fs.close(h)
 
-		local m = fs.stat(file)
+		local m = fs.metadata(file)
 		assert.eq(m.size, 3)
 
 		local hr = fs.open(file, "r")
@@ -55,25 +55,15 @@ test.suite("FsSuite", function(suite)
 		assert.eq(fs.exists(dir), true)
 		assert.eq(fs.type(dir), "dir")
 
-		local entries = fs.listdir(tmpdir)
+		local entries = fs.listdirectory(tmpdir)
 		local found = false
 		for _, e in entries do
 			if e.name == "subdir" then
 				found = true
 			end
 		end
 		assert.eq(found, true)
-		fs.rmdir(dir)
-	end)
-
-	suite:case("readasync_and_writestring", function(assert)
-		local file = path.join(tmpdir, "async.txt")
-		fs.writestringtofile(file, "async content")
-
-		local got = fs.readasync(file)
-		assert.eq(got, "async content")
-
-		fs.remove(file)
+		fs.removedirectory(dir)
 	end)
 
 	suite:case("link_and_symlink_and_copy", function(assert)
@@ -92,7 +82,7 @@ test.suite("FsSuite", function(suite)
 		fs.remove(dstcopy)
 
 		local dstsymlink = path.join(tmpdir, "dstsymlink")
-		fs.symlink(srcfile, dstsymlink)
+		fs.symboliclink(srcfile, dstsymlink)
 		assert.eq(fs.readfiletostring(dstsymlink), "linkcontent")
 		fs.remove(dstsymlink)
 
@@ -131,8 +121,8 @@ test.suite("FsSuite", function(suite)
 		fs.createdirectory(nestedDir, { makeparents = true })
 		assert.eq(fs.exists(nestedDir), true)
 
-		fs.rmdir(nestedDir)
-		fs.rmdir(path.join(tmpdir, "nested"))
+		fs.removedirectory(nestedDir)
+		fs.removedirectory(path.join(tmpdir, "nested"))
 	end)
 
 	suite:case("createdirectory_makeparents_false", function(assert)
@@ -223,7 +213,7 @@ test.suite("FsSuite", function(suite)
 
 		-- Cleanup
 		fs.remove(file)
-		fs.rmdir(dir)
+		fs.removedirectory(dir)
 	end)
 
 	suite:case("walk_directory_recursive", function(assert)

tests/std/fs.test.luau

@@ -124,7 +124,7 @@ test.suite("Parser", function(suite)
 
 	suite:case("roundtrippableAst", function(assert)
 		local function visitDirectory(directory: string)
-			for _, entry in fs.listdir(directory) do
+			for _, entry in fs.listdirectory(directory) do
 				if entry.type ~= "file" then
 					continue
 				end