]> git.immae.eu Git - github/fretlink/text-pipes.git/blobdiff - pipes-text.cabal
try fancy hvr travis
[github/fretlink/text-pipes.git] / pipes-text.cabal
index a6c2971d596cc540bb775d742b6f114225141f89..07659aeb4b5d4cb2b393227a844e60cb899a358e 100644 (file)
@@ -1,17 +1,23 @@
 name:                pipes-text
-version:             0.0.0.7
-synopsis:            Text pipes.
-description:         (This package will be in a draft, or testing, phase until version 0.0.1. Please report any api objections or installation difficulties on the github page!)
-
-                     This organization of the package follows the rule 
+version:             0.0.2.3
+synopsis:            properly streaming text
+description:         /New in version 0.0.2.x/: The new module @Pipes.Prelude.Text@ exports line-based @Text@ producers and consumers as a drop-in replacement for the @String@ material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that module.
+                     .
+                     The organization of this package follows the rule:
                      .
                      * @pipes-text : pipes-bytestring :: text : bytestring@ 
                      .
-                     Familiarity with the other three packages should give one an idea what to expect where. The package has three modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. 
+                     Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library.
+                     .
+                     The module @Pipes.Text.IO@ is present as a convenience.  Official pipes IO uses @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@.  In particular, the @Pipes.Text.IO@ functions use Text exceptions, while @Pipes.Text@ uses the standard pipes practice of breaking with a failed parse. Thus, for example, the type of @decodeUtf8@ is
+                     .
+                     * @decodeUtf8 :: Monad m => Producer ByteString m r -> Producer Text m (Producer ByteString m r)@
                      .
-                     Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@).  Official pipes IO would use @Pipes.ByteString@ and the decoding functions present here, based on the new Michael Snoyman's new @text-stream-decoding@ package.  In particular, the @Pipes.Text.IO@ functions use Text exceptions. 
+                     where any unparsed bytes are returned.
                      .
-                     @Pipes.Text.IO@ uses version 0.11.3 or later of the @text@ library. It thus works with the version of @text@ that came with the 2013 Haskell Platform. To use an older @text@, install with the flag @-fnoio@
+                     @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library; older versions of @text@ can be used with the flag @-fnoio@
+
+
 
 homepage:            https://github.com/michaelt/text-pipes
 bug-reports:         https://github.com/michaelt/text-pipes/issues
@@ -23,7 +29,7 @@ category:            Text, Pipes
 build-type:          Simple
 cabal-version:       >=1.10
 
-extra-source-files: README.md include/*.h changelog
+extra-source-files: README.md changelog
 source-repository head
     type: git
     location: https://github.com/michaelt/text-pipes
@@ -34,22 +40,20 @@ flag noio
 
 library
   exposed-modules:     Pipes.Text, Pipes.Text.Encoding
-  build-depends:       base >= 4                  && < 5  ,
-                       bytestring >= 0.9                  ,
-                       text >=0.11.2              && < 1.2,
-                       text-stream-decode >= 0.1  && < 0.2,  
-                       profunctors  >= 3.1.1      && < 4.1,
-                       pipes >=4.0                && < 4.2,
-                       pipes-group  >= 1.0.0      && < 1.1,
-                       pipes-parse >=2.0          && < 3.1,
-                       pipes-safe, 
-                       pipes-bytestring >= 1.0    && < 2.1,
-                       transformers >= 0.2.0.0    && < 0.4
+  build-depends:       base              >= 4       && < 5  ,
+                       bytestring        >= 0.9.2.1 && < 0.11,
+                       text              >= 0.11.2  && < 1.3 ,
+                       streaming-commons >= 0.1     && < 0.2 ,  
+                       pipes             >= 4.0     && < 4.2 ,
+                       pipes-group       >= 1.0.0   && < 1.1 ,
+                       pipes-parse       >= 3.0.0   && < 3.1 ,
+                       pipes-safe        >= 2.1     && < 2.3 , 
+                       pipes-bytestring  >= 1.0     && < 2.2 ,
+                       transformers      >= 0.2.0.0 && < 0.6
+
   other-extensions:    RankNTypes
   default-language:    Haskell2010
-  ghc-options: -O2
 
   if !flag(noio)
-    exposed-modules:   Pipes.Text.IO
-    build-depends:     text >=0.11.3              && < 1.2
-
+    exposed-modules:   Pipes.Text.IO, Pipes.Text.Tutorial,  Pipes.Prelude.Text
+    build-depends:     text >=0.11.3              && < 1.3