Linebreaks in output

[jonkri]

Writing a simple parsing for print-api files, I realized that some types and instances are broken up over several lines in print-api's output.

Here is an example from aftovolio-0.7.1.0:

  argsProcessing ::
    Aftovolio.General.Base.GWritingSystemPRPLX
    -> [(GHC.Types.Char, GHC.Types.Char)]
    -> Aftovolio.General.Syllables.CharPhoneticClassification
    -> Aftovolio.General.Syllables.SegmentRulesG
    -> Aftovolio.General.Syllables.BasicSpaces
    -> Aftovolio.General.Syllables.AdditionalDelimiters
    -> ([[[Aftovolio.General.Syllables.PhoneticPhenomenonRep]]] -> [[GHC.Word.Word8]])
    -> [[GHC.Base.String]]
    -> [[GHC.Base.String]]
    -> GHC.Base.String
    -> GHC.Types.IO (GHC.Types.Int, GHC.Types.Int, Aftovolio.General.Distance.Compards, GHC.Types.Bool, GHC.Types.Bool, GHC.IO.FilePath, GHC.Base.String, GHC.Base.String, GHC.Base.String, GHC.Types.Int, GHC.Types.Bool, GHC.Int.Int8, GHC.IO.FilePath, GHC.Types.Int, GHC.Types.Bool, GHC.Base.String, [GHC.Types.Int], [GHC.Base.String])

Here is an example from aztecs-0.3.0.0:

instance [safe] forall i o.
                (Data.Aztecs.Entity.FromEntity i, Data.Aztecs.Entity.ToEntity o, Data.Aztecs.Entity.Intersect (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o), Data.Aztecs.Query.Queryable (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)), Data.Aztecs.Entity.Difference (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o), Data.Aztecs.Query.Queryable (Data.Aztecs.Entity.DifferenceT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)),
                 Data.Aztecs.Entity.Sort (Data.Aztecs.Entity.ConcatT (Data.Aztecs.Entity.DifferenceT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)) (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o))) (Data.Aztecs.Entity.EntityT i), Data.Aztecs.Entity.Sort (Data.Aztecs.Entity.EntityT o) (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o))) =>
                Data.Aztecs.Query.Map GHC.Types.False i o

Perhaps I'm biased since I'm writing a parser, but I would have preferred single lines, without breaks, like so:

  argsProcessing :: Aftovolio.General.Base.GWritingSystemPRPLX -> [(GHC.Types.Char, GHC.Types.Char)] -> Aftovolio.General.Syllables.CharPhoneticClassification -> Aftovolio.General.Syllables.SegmentRulesG -> Aftovolio.General.Syllables.BasicSpaces -> Aftovolio.General.Syllables.AdditionalDelimiters -> ([[[Aftovolio.General.Syllables.PhoneticPhenomenonRep]]] -> [[GHC.Word.Word8]]) -> [[GHC.Base.String]] -> [[GHC.Base.String]] -> GHC.Base.String -> GHC.Types.IO (GHC.Types.Int, GHC.Types.Int, Aftovolio.General.Distance.Compards, GHC.Types.Bool, GHC.Types.Bool, GHC.IO.FilePath, GHC.Base.String, GHC.Base.String, GHC.Base.String, GHC.Types.Int, GHC.Types.Bool, GHC.Int.Int8, GHC.IO.FilePath, GHC.Types.Int, GHC.Types.Bool, GHC.Base.String, [GHC.Types.Int], [GHC.Base.String])

instance [safe] forall i o. (Data.Aztecs.Entity.FromEntity i, Data.Aztecs.Entity.ToEntity o, Data.Aztecs.Entity.Intersect (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o), Data.Aztecs.Query.Queryable (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)), Data.Aztecs.Entity.Difference (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o), Data.Aztecs.Query.Queryable (Data.Aztecs.Entity.DifferenceT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)), Data.Aztecs.Entity.Sort (Data.Aztecs.Entity.ConcatT (Data.Aztecs.Entity.DifferenceT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o)) (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o))) (Data.Aztecs.Entity.EntityT i), Data.Aztecs.Entity.Sort (Data.Aztecs.Entity.EntityT o) (Data.Aztecs.Entity.IntersectT (Data.Aztecs.Entity.EntityT i) (Data.Aztecs.Entity.EntityT o))) => Data.Aztecs.Query.Map GHC.Types.False i o

By the way, there are some pretty long lines not being wrapped in print-api's output.

Thanks!

[Kleidukos]

@jonkri Hi! I am currently recovering from an arms / hands injury that prevents me from spending too much time on a keyboard, but I would be delighted to review a PR that introduces line breaks. I'm thinking that maybe a CLI flag would be most appropriate, in order for this new, more readable format to be opt-in.

Let me know your thoughts.

[jonkri]

Oh, I'm sorry to hear of your injury. I wish you a speedy recovery. 💐

Just to clarify, I think I was suggesting a less readable format – one in which every function signature and instance is necessarily on one line. Since this would be close to what print-api is doing today, I think it could be the default format.