Implement 'out', 'outLn', 'err' and 'errLn' functions for outputting 'Text' to corresponding handlers #107

Activity

1. chshersh

   added

   enhancementNew feature or requestNew feature or request

   good first issueGood for newcomersGood for newcomers

   terminal

   on Feb 28, 2023
2. chshersh

   removed

   terminal

   on Mar 22, 2023
3. martinhelmer commented on Mar 23, 2023

   

   martinhelmer

   on Mar 23, 2023

   Last edited by martinhelmer

   Collaborator

   More actions

   i'll take care of this.
   should i migrate existing internal IO usage as well?
   (such as the IO in Question.hs and Formatting.hs)
4. chshersh commented on Mar 25, 2023

   

   chshersh

   on Mar 25, 2023

   OwnerAuthor

   More actions

   Feel free to take care of this issue!

   I think using these functions in others would be a good idea indeed. As long as there're no cyclic dependencies.
5. chshersh

   assigned

   martinhelmer

   on Mar 25, 2023
6. chshersh

   added this to the v0.3.0.0: More batteries milestone on Mar 25, 2023
7. chshersh

   added this to Iris Projecton Mar 25, 2023
8. martinhelmer commented on Mar 25, 2023

   

   martinhelmer

   on Mar 25, 2023

   Collaborator

   More actions

   so after this we have slight inconsistencies in naming
   raw output

   Iris.out
   Iris.outLn
   Iris.err
   Iris.errLn
   

   colored output

   Iris.putStdoutColoured
   Iris.putStdoutColouredLn
   Iris.putStderrColoured
   Iris.putStderrColouredLn
   

   OK with that?

   Ideally i'd prefer renaming the colored ones to

   Iris.outColoured
   Iris.outColouredLn
   Iris.errColoured
   Iris.errColouredLn
   

   but that's not backwards compatible
9. martinhelmer commented on Mar 25, 2023

   

   martinhelmer

   on Mar 25, 2023

   Collaborator

   More actions

   Would you like some tests using System.IO.Silently (capture) to capture and check stderr + stdout

   or

   skip the tests for this since the definitions are trivial.
10. martinhelmer commented on Mar 26, 2023

    

    martinhelmer

    on Mar 26, 2023

    Last edited by martinhelmer

    Collaborator

    More actions

    overkill example:

    import System.IO.Silently (capture_, hCapture_, silence, hCapture, hSilence)
    import System.IO (stderr, stdout)
    
    import Iris.IO 
    import qualified Iris as IO
    
    
    checkStdErr f = hCapture_ [stderr] (hSilence [stdout] f)
    checkStdOut f = hCapture_ [stdout] (hSilence [stderr] f)
    
    ioSpec :: Spec
    ioSpec =
        describe "IO" $ do
            describe "out" $ do 
                it "writes to stdout, no LF " $ checkStdOut (IO.out "TEXT") >>= shouldBe "TEXT"
                it "does not write to stderr " $ checkStdErr (IO.out "TEXT") >>= shouldBe ""
            describe "outLn" $ do 
                it "writes to stdout,  LF " $ checkStdOut (IO.outLn "TEXT") >>= shouldBe "TEXT\n"
                it "does not write to stderr " $ checkStdErr (IO.outLn "TEXT") >>= shouldBe ""
            describe "err" $ do 
                it "writes to sterr, no LF " $ checkStdErr (IO.err "TEXT") >>= shouldBe "TEXT"
                it "does not write to stdout " $ checkStdOut (IO.err "TEXT") >>= shouldBe ""
            describe "errLn" $ do 
                it "writes to stderr,  LF " $ checkStdErr (IO.errLn "TEXT") >>= shouldBe "TEXT\n"
                it "does not write to stdout " $ checkStdOut (IO.errLn "TEXT") >>= shouldBe ""
    

      IO
        out
          writes to stdout, no LF  [✔]
          does not write to stderr  [✔]
        outLn
          writes to stdout,  LF  [✔]
          does not write to stderr  [✔]
        err
          writes to sterr, no LF  [✔]
          does not write to stdout  [✔]
        errLn
          writes to stderr,  LF  [✔]
          does not write to stdout  [✔]
    
11. chshersh commented on Mar 26, 2023

    

    chshersh

    on Mar 26, 2023

    OwnerAuthor

    More actions

    @martinhelmer I like these tests with silently, so let's add them to the implementation as well! 👍🏻

    so after this we have slight inconsistencies in naming

    My plan is to remove put*Coloured functions completely, so I wouldn't bother with changing their names for now 🙂

    Initially, I implemented a design with a separate formatting function, so it could be used in a combination with something like pretty-terminal:

    Iris.putStderrColouredLn
        (Pretty.style Pretty.Bold . Pretty.color Pretty.Green)
        "my message"

    But I'd rather do #110 properly, so functions like putStderrColouredLn could be removed completely, and the above example will look like:

    Iris.errLn $ Iris.bold $ Iris.green "my message"
12. martinhelmer commented on Mar 26, 2023

    

    martinhelmer

    on Mar 26, 2023

    Last edited by martinhelmer

    Collaborator

    More actions

    ok. roger that. what about the tests? like / no like ?
    you answered that already. doh'
13. martinhelmer

    added 3 commits that reference this issue on Mar 26, 2023

    chshersh#107 add IO module and functions

    b99f3ac

    chshersh#107 formatting

    2834a7b

    chshersh#107 MonadIO => , make tests nicer

    019a9e1