4.0.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 4.0.0
+
+Moved the `currentWorkingDirectory` to the main `Shikensu` module so that it can use the `Error` type instead for ease of use.
+
 ## 3.0.0
 
 * Added `Shikensu.perform`

gren.json

@@ -4,7 +4,7 @@
     "name": "icidasset/shikensu-gren",
     "summary": "Run a sequence of functions on in-memory representations of files",
     "license": "BSD-3-Clause",
-    "version": "3.0.0",
+    "version": "4.0.0",
     "exposed-modules": [
         "Shikensu",
         "Shikensu.Bundle",

src/Shikensu.gren

@@ -1,16 +1,21 @@
-module Shikensu exposing ( Program, Task, list, perform, program, programs, read, write, writeDefinition )
+module Shikensu exposing ( Program, Task, currentWorkingDirectory, list, perform, program, programs, read, write, writeDefinition )
 
 {-|
 
 # 🚀
 
-@docs program, programs, Program, list, perform, Task
+@docs program, programs, Program, Task, list, perform
 
 
 # IO
 
 @docs read, write, writeDefinition
 
+
+# 🛠️
+
+@docs currentWorkingDirectory
+
 -}
 
 import Bytes.Encode
@@ -153,8 +158,7 @@ If you run `./binary/app` the resulting path will be `~/code/example/`.
 list : FileSystem.Permission -> Focus -> Task
 list fsPermission focus =
     fsPermission
-        |> Path.currentWorkingDirectory
-        |> Task.mapError neverError
+        |> currentWorkingDirectory
         |> Task.andThen
                 (\cwd ->
                     let
@@ -327,12 +331,28 @@ writeDefinition permission destinationDirectory def =
 
 
 
--- ㊙️
+-- 🛠️
+
+
+{-| Get the absolute directory path of the current working directory.
+-}
+currentWorkingDirectory : FileSystem.Permission -> Task.Task Error (Path Directory)
+currentWorkingDirectory permission =
+    permission
+        |> FileSystem.currentWorkingDirectory
+        |> Task.map
+                (\a ->
+                    if String.endsWith "/" a then
+                        a
+                    else
+                        a ++ "/"
+                )
+        |> Task.map (Path.fromPosix >> Path.unwrap >> Path.directory)
+        |> Task.mapError (\_ -> ErrorMessage "Never ever have I 🤫")
 
 
-neverError : Never -> Error
-neverError _ =
-    ErrorMessage "Never ever have I 🤫"
+
+-- ㊙️
 
 
 recursiveList : FileSystem.Permission -> Path Directory -> Path Directory -> Task.Task Error (Array Definition)

src/Shikensu/Path.gren

@@ -1,4 +1,4 @@
-module Shikensu.Path exposing ( Path, Directory, File, Encapsulated, Kind(..), currentWorkingDirectory, directory, length, file, fromPosix, toPosix, encapsulate, combine, kind, map, unwrap )
+module Shikensu.Path exposing ( Path, Directory, File, Encapsulated, Kind(..), directory, length, file, fromPosix, toPosix, encapsulate, combine, kind, map, unwrap )
 
 {-|
 
@@ -9,7 +9,7 @@ module Shikensu.Path exposing ( Path, Directory, File, Encapsulated, Kind(..), c
 
 # Creation
 
-@docs directory, file, currentWorkingDirectory
+@docs directory, file
 
 
 # POSIX
@@ -28,8 +28,6 @@ module Shikensu.Path exposing ( Path, Directory, File, Encapsulated, Kind(..), c
 
 -}
 
-import FileSystem
-import Task exposing ( Task )
 
 
 {-| Path type.
@@ -96,22 +94,6 @@ file =
     Path File
 
 
-{-| Get the absolute directory path of the current working directory.
--}
-currentWorkingDirectory : FileSystem.Permission -> Task Never (Path Directory)
-currentWorkingDirectory permission =
-    permission
-        |> FileSystem.currentWorkingDirectory
-        |> Task.map
-                (\a ->
-                    if String.endsWith "/" a then
-                        a
-                    else
-                        a ++ "/"
-                )
-        |> Task.map (fromPosix >> unwrap >> directory)
-
-
 
 -- POSIX