diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -58,54 +58,15 @@ ## Building the project -Install the dependencies first with either: - - cabal install --only-dependencies - -If you do not wish to build tests or benchmarks, or: - - cabal install --only-dependencies --enable-tests - -If you want to be able to build the tests, or: - - cabal install --only-dependencies --enable-benchmarks - -If you wish to build the benchmarks. - -The project must be "configured" at least once everytime `cassava-conduit.cabal` changes, this can be done with: - - cabal configure - -If you wish to run the unit tests you will have to run: - - cabal configure --enable-tests - -If you wish to run benchmarks you will have to run: - - cabal configure --enable-benchmarks - -At the moment there are issues with using both flags at the same time. Its recommended that you use one flag at a time, use `cabal-dev` or `cabal sandbox` -(see below), and clear your sandbox when switching configurations from one to the other - -Then finally build it with: - - cabal build - -See `cabal build --help` for more build options. +``` Shell +make build +``` ## Running Unit Tests -**After** running `cabal build`, you can run the unit tests with the command: - - cabal test - -## Adding Unit tests - -Unit tests are written with [**doctest**] [doctest-github], for instructions on how to add unit tests -see the **doctest** [**User Guide**] [doctest-userguide]. - -Currently only files in the `src/` directory are searched for tests, it is assumed that the code in `main/` -is a thin layer of code that uses modules from `src/`. +``` Shell +make test +``` ## Running Benchmarks @@ -114,29 +75,3 @@ cabal bench For newer versions of `cabal`, `cabal bench` will run a `cabal build` automatically if necessary.. - -## Development: Cabal Dependency Hell? - -Cabal's great, but its got its own warts, and when you are developing a few different projects with their own dependency chains, sometimes installing all your libraries to the same place causes problems, - -### Cabal version < 1.18 - -Consider trying [`cabal-dev`] [cabal-dev]. Install it with `cabal install cabal-dev` - -In terms of using it, all thats required is replacing `cabal` with `cabal-dev` in all the above command lines. - -It will download and install all the dependencies for your project and install them in a `cabal-dev/` directory in your project directory, and they will only be used for this project. - -### Cabal version >= 1.18 - -Cabal version `1.18` and onwards supports sandboxes, which is basically the same idea as `cabal-dev`. - -In terms of using it all the commands remain the same, just run `cabal sandbox init` in the root directory of the project before running any of them. - ------- - -The related `cabal-dev` and `sandbox` artifacts are already contained in the `.gitignore` file. - -[cabal-dev]: https://github.com/creswick/cabal-dev "creswick/cabal-dev on GitHub.com" -[doctest-github]: https://github.com/sol/doctest-haskell "sol/doctest-haskell on GitHub.com" -[doctest-userguide]: https://github.com/sol/doctest-haskell/blob/master/README.markdown#usage "doctest Usage Guide" diff --git a/Setup.hs b/Setup.hs --- a/Setup.hs +++ b/Setup.hs @@ -5,7 +5,6 @@ import Data.List ( nub ) import Data.Maybe ( catMaybes ) import Data.Version ( showVersion ) -import Control.Applicative import Distribution.Package ( PackageName(PackageName), PackageId, InstalledPackageId, packageVersion, packageName ) import Distribution.PackageDescription ( PackageDescription(), TestSuite(..) ) import Distribution.Simple ( defaultMainWithHooks, UserHooks(..), simpleUserHooks ) diff --git a/cassava-conduit.cabal b/cassava-conduit.cabal --- a/cassava-conduit.cabal +++ b/cassava-conduit.cabal @@ -1,5 +1,5 @@ name: cassava-conduit -version: 0.2.0 +version: 0.2.1 license: BSD3 license-file: etc/LICENCE.md author: Dom De Re @@ -8,10 +8,14 @@ synopsis: Conduit interface for cassava package category: Data description: Conduit interface for cassava package + . + PRs welcome. homepage: https://github.com/domdere/cassava-conduit bug-reports: https://github.com/domdere/cassava-conduit/issues cabal-version: >= 1.18 build-type: Custom +tested-with: GHC == 7.10.1 + , GHC == 7.10.2 extra-source-files: README.md , CHANGELOG.md @@ -28,7 +32,7 @@ build-depends: base < 5 && >= 4 , containers , array - , bifunctors == 4.2.* + , bifunctors == 5.* , bytestring == 0.10.* , cassava == 0.4.* , conduit == 1.2.* @@ -36,10 +40,6 @@ , mtl == 2.2.* ghc-options: -Wall - -fno-warn-unused-imports - -fno-warn-unused-binds - -fno-warn-unused-do-bind - -fno-warn-type-defaults hs-source-dirs: src @@ -49,54 +49,14 @@ default-extensions: NoImplicitPrelude --- doctests are disabled (there are not doctests in the code atm) --- since the latest version of doctests doesnt support GHC 7.4 and 7.6 --- and I would like to maintain support for these versions for a while - ---test-suite doctests --- type: --- exitcode-stdio-1.0 --- --- main-is: --- Main.hs --- --- default-language: --- Haskell2010 --- --- build-depends: --- base >= 4 && < 5 --- , doctest >= 0.9.11 --- , filepath >= 1.3 --- , directory >= 1.1 --- , QuickCheck >= 2.0 --- , template-haskell == 2.9.* --- --- ghc-options: --- -Wall --- -threaded --- --- hs-source-dirs: --- doctests - test-suite quickcheck default-language: Haskell2010 type: exitcode-stdio-1.0 main-is: Main.hs hs-source-dirs: quickcheck build-depends: base >= 4 && < 5 - , QuickCheck == 2.7.6 + , QuickCheck == 2.8.* , cassava-conduit - - --- HLint tests are disabled until the SCC tags dont cause parse errors in HLint - ---test-suite hlint --- default-language: Haskell2010 --- type: exitcode-stdio-1.0 --- main-is: Main.hs --- hs-source-dirs: hlint --- build-depends: base --- , hlint == 1.9.* benchmark benchmarks default-language: Haskell2010 diff --git a/src/LocalPrelude.hs b/src/LocalPrelude.hs --- a/src/LocalPrelude.hs +++ b/src/LocalPrelude.hs @@ -41,5 +41,4 @@ ) where import Prelude -import Control.Applicative import Data.Word