diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,11 @@ `co-log-polysemy` uses [PVP Versioning][1]. The changelog is available [on GitHub][2]. +## 0.0.1.2 — Apr 18, 2020 + +* [#186](https://github.com/kowainik/co-log/issues/186): + Support GHC-8.10.1. + ## 0.0.1.1 — Feb 17, 2020 * [#181](https://github.com/kowainik/co-log/issues/181): diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # co-log +[![GitHub CI](https://github.com/kowainik/co-log/workflows/CI/badge.svg)](https://github.com/kowainik/co-log/actions) [![Build status](https://img.shields.io/travis/kowainik/co-log.svg?logo=travis)](https://travis-ci.org/kowainik/co-log) [![Windows build](https://ci.appveyor.com/api/projects/status/github/kowainik/co-log?branch=master&svg=true)](https://ci.appveyor.com/project/kowainik/co-log) [![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](https://github.com/kowainik/co-log/blob/master/LICENSE) + | | | | | | :------------ | :--------------------------------- | :---------------------------------------- | :---------------------------------------------------- | | `co-log-core` | [![Hackage][hk-img-core]][hk-core] | [![Stackage LTS][lts-img-core]][lts-core] | [![Stackage Nightly][nightly-img-core]][nightly-core] | @@ -16,13 +18,13 @@ core, we are striving to provide beginner-friendly API. The library also contains complete documentation with a lot of beginner-friendly examples, explanations and tutorials to guide users. The combination -of pragmatic approach to logging and fundamental Haskell abstractions -allows us to create highly composable and configurable logging +of a pragmatic approach to logging and fundamental Haskell abstractions +allows us to create a highly composable and configurable logging framework. -If you're interested in how different Haskel typeclasses are used to +If you're interested in how different Haskell typeclasses are used to implement core functions of `co-log`, you can read the following blog -post which goes in detail about internal implementation specifics: +post which goes into detail about internal implementation specifics: * [co-log: Composable Contravariant Combinatorial Comonadic Configurable Convenient Logging](https://kowainik.github.io/posts/2018-09-25-co-log) @@ -37,17 +39,17 @@ `co-log-core`. * [`co-log-polysemy`](co-log-polysemy): implementation of logging library based on `co-log-core` and the [`polysemy`](http://hackage.haskell.org/package/polysemy) extensible effects library. -* [`co-log-benchmark`](co-log-benchmark): Benchmarks of the `co-log` library. +* [`co-log-benchmark`](co-log-benchmark): benchmarks of the `co-log` library. -To provide more user-friendly introduction to the library, we've +To provide a more user-friendly introduction to the library, we've created the tutorial series which introduces the main concepts behind `co-log` smoothly: * [Intro: Using `LogAction`](https://github.com/kowainik/co-log/blob/master/co-log/tutorials/1-intro/Intro.md) * [Using custom monad that stores `LogAction` inside its environment](https://github.com/kowainik/co-log/blob/master/co-log/tutorials/2-custom/Custom.md) -`co-log` also cares about concurrent logging. For this purposes we have the `concurrent-playground` -executable where we experiment with different multithreading scenarios to test the library behavior. +`co-log` also cares about concurrent logging. For this purpose we have the `concurrent-playground` +executable where we experiment with different multithreading scenarios to test the library's behavior. You can find it here: * [tutorials/Concurrent.hs](co-log/tutorials/Concurrent.hs) @@ -55,9 +57,9 @@ ## Benchmarks `co-log` is compared with basic functions like `putStrLn`. Since IO overhead is -big enough, every benchmark dumps 10K messages to output. If benchmark name -doesn't contain `Message` then this benchmark simply dumps string `"message"` -to output, otherwise it works with `Message` data type from the `co-log` +big enough, every benchmark dumps 10K messages to output. If a benchmark's name +doesn't contain `Message` then this benchmark simply dumps the string `"message"` +to output, otherwise it works with the `Message` data type from the `co-log` library. To run benchmarks, use the following command: diff --git a/co-log-polysemy.cabal b/co-log-polysemy.cabal --- a/co-log-polysemy.cabal +++ b/co-log-polysemy.cabal @@ -1,6 +1,6 @@ cabal-version: 2.4 name: co-log-polysemy -version: 0.0.1.1 +version: 0.0.1.2 synopsis: Composable Contravariant Comonadic Logging Library description: Implementation of the [co-log](http://hackage.haskell.org/package/co-log-core) @@ -27,35 +27,38 @@ stability: provisional extra-doc-files: CHANGELOG.md README.md -tested-with: GHC == 8.2.2 - GHC == 8.4.4 +tested-with: GHC == 8.4.4 GHC == 8.6.5 - GHC == 8.8.2 + GHC == 8.8.3 + GHC == 8.10.1 source-repository head type: git location: https://github.com/kowainik/co-log.git common common-options - build-depends: base >= 4.10.1.0 && < 4.14 + build-depends: base >= 4.10.1.0 && < 4.15 - ghc-options: -Wall - -Wincomplete-uni-patterns - -Wincomplete-record-updates + -- 8.2 lacks <> + if impl(ghc < 8.4) + buildable: False + + ghc-options: -O2 + -Wall -Wcompat -Widentities + -Wincomplete-uni-patterns + -Wincomplete-record-updates -Wredundant-constraints - -fhide-source-paths - -freverse-errors + if impl(ghc >= 8.2) + ghc-options: -fhide-source-paths + if impl(ghc >= 8.4) + ghc-options: -Wmissing-export-lists -Wpartial-fields - -O2 - if impl(ghc >= 8.8.1) + if impl(ghc >= 8.8) ghc-options: -Wmissing-deriving-strategies - -Werror=missing-deriving-strategies - - -- 8.2 lacks <> - if impl(ghc < 8.4) - buildable: False + if impl(ghc >= 8.10) + ghc-options: -Wunused-packages -- special options to make @polysemy@ fast if impl(ghc >= 8.6) diff --git a/example/Main.hs b/example/Main.hs --- a/example/Main.hs +++ b/example/Main.hs @@ -1,4 +1,4 @@ -module Main where +module Main (main) where import Prelude hiding (log)