feat: opendirOptionsDefault

Author: Serhii Khoma

src/Node/FS/Aff.purs

@@ -83,8 +83,8 @@ import Effect.Aff (Aff, Error, makeAff, nonCanceler)
 import Node.Buffer (Buffer)
 import Node.Encoding (Encoding)
 import Node.FS as F
-import Node.FS.Async (CpOptions)
-import Node.FS.Async (CpOptions, CpForce(..), cpOptionsDefault) as Exports
+import Node.FS.Async (CpOptions, CpForce(..), cpOptionsDefault, OpendirOptions , opendirOptionsDefault, RmOptions, rmOptionsDefault, RmdirOptions, rmdirOptionsDefault) as Exports
+import Node.FS.Async (CpOptions, OpendirOptions, RmdirOptions, RmOptions)
 import Node.FS.Async as A
 import Node.FS.Constants (AccessMode, CopyMode)
 import Node.FS.Dir (Dir)
@@ -264,7 +264,7 @@ rmdir = toAff1 A.rmdir
 -- |
 -- | Deletes a directory with options.
 -- |
-rmdir' :: FilePath -> { maxRetries :: Int, retryDelay :: Int } -> Aff Unit
+rmdir' :: FilePath -> RmdirOptions -> Aff Unit
 rmdir' = toAff2 A.rmdir'
 
 -- |
@@ -276,7 +276,7 @@ rm = toAff1 A.rm
 -- |
 -- | Deletes a file or directory with options.
 -- |
-rm' :: FilePath -> { force :: Boolean, maxRetries :: Int, recursive :: Boolean, retryDelay :: Int } -> Aff Unit
+rm' :: FilePath -> RmOptions -> Aff Unit
 rm' = toAff2 A.rm'
 
 -- |
@@ -502,7 +502,7 @@ opendir = toAff1 A.opendir
 
 -- | Open a directory. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_opendir_path_options_callback)
 -- | for details.
-opendir' :: FilePath -> { bufferSize :: Int, recursive :: Boolean, encoding :: Encoding } -> Aff Dir
+opendir' :: FilePath -> OpendirOptions -> Aff Dir
 opendir' = toAff2 A.opendir'
 
 -- | Read from a file descriptor into a buffer array. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_readv_fd_buffers_position_callback)

src/Node/FS/Async.purs

@@ -20,8 +20,12 @@ module Node.FS.Async
   , unlink
   , rmdir
   , rmdir'
+  , rmdirOptionsDefault
+  , RmdirOptions
   , rm
   , rm'
+  , rmOptionsDefault
+  , RmOptions
   , mkdir
   , mkdir'
   , readdir
@@ -65,8 +69,10 @@ module Node.FS.Async
   , lchown
   , lutimes
   -- , openAsBlob
-  , opendir'
   , opendir
+  , opendir'
+  , OpendirOptions
+  , opendirOptionsDefault
   , readv
   , statfs
   -- , unwatchFile
@@ -158,8 +164,8 @@ foreign import symlinkImpl :: EffectFn4 FilePath FilePath (Nullable String) (JSC
 foreign import readlinkImpl :: EffectFn2 FilePath (JSCallback FilePath) Unit
 foreign import realpathImpl :: forall cache. EffectFn3 FilePath { | cache } (JSCallback FilePath) Unit
 foreign import unlinkImpl :: EffectFn2 FilePath (JSCallback Unit) Unit
-foreign import rmdirImpl :: EffectFn3 FilePath { maxRetries :: Int, retryDelay :: Int } (JSCallback Unit) Unit
-foreign import rmImpl :: EffectFn3 FilePath { force :: Boolean, maxRetries :: Int, recursive :: Boolean, retryDelay :: Int } (JSCallback Unit) Unit
+foreign import rmdirImpl :: EffectFn3 FilePath RmdirOptions (JSCallback Unit) Unit
+foreign import rmImpl :: EffectFn3 FilePath RmOptions (JSCallback Unit) Unit
 foreign import mkdirImpl :: EffectFn3 FilePath { recursive :: Boolean, mode :: String } (JSCallback Unit) Unit
 -- if { withFileTypes: false, recursive: false } => ['Tidy']
 -- if { withFileTypes: false, recursive: true } => [ 'Tidy', 'Tidy/Codegen', 'Tidy/Codegen.purs', 'Tidy/Codegen/Class.purs', .. ]
@@ -290,32 +296,42 @@ unlink
   -> Effect Unit
 unlink file cb = runEffectFn2 unlinkImpl file (handleCallback cb)
 
+type RmdirOptions = { maxRetries :: Int, retryDelay :: Int }
+
+rmdirOptionsDefault :: RmdirOptions
+rmdirOptionsDefault = { maxRetries: 0, retryDelay: 100 }
+
 -- | Deletes a directory.
 rmdir
   :: FilePath
   -> Callback Unit
   -> Effect Unit
-rmdir path cb = rmdir' path { maxRetries: 0, retryDelay: 100 } cb
+rmdir path cb = rmdir' path rmdirOptionsDefault cb
 
 -- | Deletes a directory with options.
 rmdir'
   :: FilePath
-  -> { maxRetries :: Int, retryDelay :: Int }
+  -> RmdirOptions
   -> Callback Unit
   -> Effect Unit
 rmdir' path opts cb = runEffectFn3 rmdirImpl path opts (handleCallback cb)
 
+type RmOptions = { force :: Boolean, maxRetries :: Int, recursive :: Boolean, retryDelay :: Int }
+
+rmOptionsDefault :: RmOptions
+rmOptionsDefault = { force: false, maxRetries: 100, recursive: false, retryDelay: 1000 }
+
 -- | Deletes a file or directory.
 rm
   :: FilePath
   -> Callback Unit
   -> Effect Unit
-rm path = rm' path { force: false, maxRetries: 100, recursive: false, retryDelay: 1000 }
+rm path = rm' path rmOptionsDefault
 
 -- | Deletes a file or directory with options.
 rm'
   :: FilePath
-  -> { force :: Boolean, maxRetries :: Int, recursive :: Boolean, retryDelay :: Int }
+  -> RmOptions
   -> Callback Unit
   -> Effect Unit
 rm' path opts cb = runEffectFn3 rmImpl path opts (handleCallback cb)
@@ -655,16 +671,21 @@ lutimes file atime mtime cb = runEffectFn4 lutimesImpl file (datetimeToUnixEpoch
 -- openAsBlob :: FilePath -> Promise Blob -> Effect Unit
 -- openAsBlob path cb = runEffectFn2 openAsBlobImpl path (handleCallback cb)
 
+type OpendirOptions = { encoding :: Encoding, bufferSize :: Int, recursive :: Boolean }
+
+opendirOptionsDefault :: OpendirOptions
+opendirOptionsDefault = { bufferSize: 32, recursive: false, encoding: UTF8 }
+
 -- | Open a directory. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_opendir_path_options_callback)
 -- | for details.
-opendir' :: FilePath -> { encoding :: Encoding, bufferSize :: Int, recursive :: Boolean } -> Callback Dir -> Effect Unit
+opendir' :: FilePath -> OpendirOptions -> Callback Dir -> Effect Unit
 opendir' path { encoding, bufferSize, recursive } cb = runEffectFn3 opendirImpl path { encoding: encodingToNode encoding, bufferSize, recursive } (handleCallback cb)
 
 -- | Open a directory. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_opendir_path_options_callback)
 -- | for details.
 -- | NOTE: encoding: 'buffer' is not supported, will throw error "TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received an instance of Buffer"
 opendir :: FilePath -> Callback Dir -> Effect Unit
-opendir path = opendir' path { bufferSize: 32, recursive: false, encoding: UTF8 }
+opendir path = opendir' path opendirOptionsDefault
 
 -- | Read from a file descriptor into a buffer array. See the [Node Documentation](https://nodejs.org/api/fs.html#fs_fs_readv_fd_buffers_position_callback)
 -- | for details.

test/Test.purs

@@ -11,6 +11,7 @@ import Effect.Exception (Error, catchException, error, message, throw, throwExce
 import Node.Buffer as Buffer
 import Node.Encoding (Encoding(..))
 import Node.FS (FileFlags(..), SymlinkType(..))
+import Node.FS.Aff (rmOptionsDefault)
 import Node.FS.Async as A
 import Node.FS.Constants (copyFile_EXCL, r_OK, w_OK)
 import Node.FS.Perms (mkPerms, permsAll)
@@ -80,6 +81,7 @@ main = do
   log "statusChangedTime:"
   log $ show $ statusChangedTime stats
 
+  S.rm' (fp [ "tmp", "TestSymlink.js" ]) (rmOptionsDefault { force = true })
   S.symlink (fp [ "tmp", "Test1.js" ]) (fp [ "tmp", "TestSymlink.js" ]) FileLink
 
   lstats <- S.lstat (fp [ "tmp", "TestSymlink.js" ])

test/TestDirEntries.purs

@@ -11,6 +11,7 @@ import Effect.Class (liftEffect)
 import Effect.Console (log)
 import Effect.Exception (Error)
 import Node.Encoding (Encoding(..))
+import Node.FS.Aff (opendirOptionsDefault, rmOptionsDefault)
 import Node.FS.Aff as A
 import Node.FS.Aff.Dir (close, entries, read)
 import Node.FS.Dirent (Dirent, DirentNameTypeString)
@@ -24,7 +25,7 @@ outerTmpDir = "./tmp/dir-entries-test"
 
 prepare :: Aff Unit
 prepare = do
-  A.rm' outerTmpDir { force: true, maxRetries: 100, recursive: true, retryDelay: 1000 }
+  A.rm' outerTmpDir (rmOptionsDefault { recursive = true, force = true })
   A.mkdir' outerTmpDir { recursive: true, mode: permsAll }
   A.writeTextFile UTF8 (Path.concat [ outerTmpDir, "1.txt" ]) "1"
   A.writeTextFile UTF8 (Path.concat [ outerTmpDir, "2.txt" ]) "2"
@@ -34,7 +35,7 @@ prepare = do
 
 test1 :: Aff Unit
 test1 = do
-  dir <- A.opendir' outerTmpDir { bufferSize: 32, recursive: true, encoding: UTF8 }
+  dir <- A.opendir' outerTmpDir (opendirOptionsDefault { recursive = true })
   files' <- entries dir
   liftEffect $ assertEqual
     { actual: show files'
@@ -74,7 +75,7 @@ test1 = do
 
 test2 :: Aff Unit
 test2 = do
-  dir <- A.opendir' outerTmpDir { bufferSize: 32, recursive: false, encoding: UTF8 }
+  dir <- A.opendir' outerTmpDir (opendirOptionsDefault { recursive = false })
   read dir >>= \file -> liftEffect $ assertEqual
     { actual: show file
     , expected: "(Just Dirent Dirent {\n  name: 'dir1',\n  parentPath: './tmp/dir-entries-test',\n  path: './tmp/dir-entries-test',\n  [Symbol(type)]: 2\n})"