Rename currentdir to getwd

Author: tarleb

README.md

@@ -58,16 +58,6 @@ Parameters:
 :   Path of the directory which is to become the new working directory.
 
 
-### currentdir {#system-currentdir}
-
-`currentdir ()`
-
-Obtain the current working directory as an absolute path.
-
-Returns:
-
-- The current working directory (string).
-
 ### env {#system-env}
 
 `env ()`
@@ -79,7 +69,6 @@ Returns:
 - A table mapping environment variables names to their string value
   (table).
 
-### getenv {#system-getenv}
 
 `getenv (var)`
 
@@ -96,7 +85,17 @@ Returns:
 - value of the variable, or nil if the variable is not defined (string
   or nil).
 
-### ls {#system-ls}
+### getwd
+
+`getwd ()`
+
+Obtain the current working directory as an absolute path.
+
+Returns:
+
+- The current working directory (string).
+
+### ls
 
 `ls ([directory])`
 

src/Foreign/Lua/Module/System.hs

@@ -22,8 +22,8 @@ module Foreign.Lua.Module.System (
 
   -- * Functions
   , chdir
-  , currentdir
   , env
+  , getwd
   , getenv
   , ls
   , mkdir
@@ -63,9 +63,9 @@ pushModule = do
   addField "compiler_version" compiler_version
   addField "os" os
   addFunction "chdir" chdir
-  addFunction "currentdir" currentdir
   addFunction "env" env
   addFunction "getenv" getenv
+  addFunction "getwd" getwd
   addFunction "ls" ls
   addFunction "mkdir" mkdir
   addFunction "rmdir" rmdir
@@ -112,10 +112,6 @@ os = Info.os
 chdir :: FilePath -> Lua ()
 chdir fp = ioToLua $ Directory.setCurrentDirectory fp
 
--- | Return the current working directory.
-currentdir :: Lua FilePath
-currentdir = ioToLua Directory.getCurrentDirectory
-
 -- | Retrieve the entire environment
 env :: Lua NumResults
 env = do
@@ -125,6 +121,10 @@ env = do
   mapM_ addValue kvs
   return (NumResults 1)
 
+-- | Return the current working directory as an absolute path.
+getwd :: Lua FilePath
+getwd = ioToLua Directory.getCurrentDirectory
+
 -- | Returns the value of an environment variable
 getenv :: String -> Lua (Optional String)
 getenv name = ioToLua (Optional <$> Env.lookupEnv name)

test/system-module-tests.lua

@@ -9,8 +9,8 @@ assert(type(system.compiler_name) == 'string')
 assert(type(system.compiler_version) == 'table')
 assert(type(system.os) == 'string')
 
--- currentdir
-assert(type(system.currentdir()) == 'string')
+-- getwd
+assert(type(system.getwd()) == 'string')
 
 -- env
 assert(type(system.env()) == 'table')
@@ -24,7 +24,7 @@ assert(pcall(system.ls, 'README.md') == false)
 
 -- mkdir and rmdir
 function in_tmpdir (callback)
-  local orig_dir = system.currentdir()
+  local orig_dir = system.getwd()
   return system.with_tmpdir(
     'hello',
     function (tmpdir)