Feedback on new core APIs for Streams, Shell Commands, Spinners, Continuation Style

[dillonkearns]

I would love any feedback before I wrap up the docs and release these new APIs!

Notable new features:

• You can capture FileStats for Glob matches
• Glob.fromString
• Spinners for shell scripts
• Run shell commands through Script.command and Script.exec
• New BackendTask.Stream API for creating and running/reading a pipeline of Stream's (goes through NodeJS's native Stream APIs)
• BackendTask.Do module for some helpers for using continuation-style in your scripts or BackendTask definitions

I haven't written up the docs for some of these yet, but I'm moving into that phase to do the final wrapup. Any and all feedback is welcome and appreciated!

ADDED MODULES - MINOR

BackendTask.Do
BackendTask.Stream
Pages.Script.Spinner

BackendTask - MINOR

Added

do :
BackendTask.BackendTask error value
-> BackendTask.BackendTask error ()
doEach :
List.List (BackendTask.BackendTask error ())
-> BackendTask.BackendTask error ()
failIf :
Basics.Bool
-> FatalError.FatalError
-> BackendTask.BackendTask FatalError.FatalError ()
inDir :
String.String
-> BackendTask.BackendTask error value
-> BackendTask.BackendTask error value
quiet :
BackendTask.BackendTask error value
-> BackendTask.BackendTask error value
sequence :
List.List (BackendTask.BackendTask error value)
-> BackendTask.BackendTask error (List.List value)
withEnv :
String.String
-> String.String
-> BackendTask.BackendTask error value
-> BackendTask.BackendTask error value

BackendTask.Glob - MINOR

Added

type alias FileStats =
{ fullPath : String.String
, sizeInBytes : Basics.Int
, lastContentChange : Time.Posix
, lastAccess : Time.Posix
, lastFileChange : Time.Posix
, createdAt : Time.Posix
, isDirectory : Basics.Bool
}
captureStats :
BackendTask.Glob.Glob (BackendTask.Glob.FileStats -> value)
-> BackendTask.Glob.Glob value
fromString :
String.String
-> BackendTask.BackendTask error (List.List String.String)
fromStringWithOptions :
BackendTask.Glob.Options
-> String.String
-> BackendTask.BackendTask error (List.List String.String)

Pages.Script - MINOR

Added

command :
String.String
-> List.List String.String
-> BackendTask.BackendTask FatalError.FatalError String.String
doThen :
BackendTask.BackendTask error value
-> BackendTask.BackendTask error ()
-> BackendTask.BackendTask error value
exec :
String.String
-> List.List String.String
-> BackendTask.BackendTask FatalError.FatalError ()
expectWhich :
String.String
-> BackendTask.BackendTask FatalError.FatalError String.String
question : String.String -> BackendTask.BackendTask error String.String
sleep : Basics.Int -> BackendTask.BackendTask error ()
which :
String.String
-> BackendTask.BackendTask error (Maybe.Maybe String.String)

[miniBill]

It's weird that fileRead's error is ()

[dillonkearns]

Yeah, I could have an error type for that, but it would only be accessible if it was the last part of the chain. So seems kind of niche, because at that point you may as well use the BackendTask.File APIs. So I'm not sure it's worth all the extra API surface area.

[miniBill]

The example in Do.glob says it calls rm -rf but it doesn't

[dillonkearns]

Fixed! Thank you for the feedback 🙏

[miniBill]

I still think Do.allowFatal makes sense

[dillonkearns]

Added! Thank you for the reminder 🙏