CHANGELOG.md

Version 1.6 (2024-08-27)

• Add callstacks to generators that can error (#538, @ChickenProp)
• Drop support for GHC 8.0.2 (#538, @ChickenProp)

Version 1.5 (2024-07-25)

• Bump containers and filepath dependencies (#533, @erikd)
• Hedgehog.Internal.Report: Add configPrintShrinkPath (#531, @sol)
• Allow GHC 9.10 (#530, @erikd)
• hedgehog-{example,quickcheck,test-laws}: Raise QuickCheck bound (#529, @JackKelly-Bellroy)
• Allow to omit icons at the start of important output lines (#524, @sol)
• Allow to omit source location from report (#523, @sol)
• Fix "insufficient coverage" message (#521, @sol)
• Support empty property names (#520, @sol)
• Allow to disable the recheckAt-message (#519, @sol)
• Remove redundant Show constraints: evalMaybe, evalMaybeM (#516, @endgame)
• Relax upper bound on ansi-terminal (#515, @moodmosaic)
• Report.hs refactoring (#514, @sol)
• Relax time dependency to < 1.15 (#513, @tomjaguarpaw)
• Bump barbies upper bound (#510, @jchia)
• Support primitive 0.9 (#509, @Vekhir)
• Show less context on failure (#505, @sol)
• Allow GHC 9.8 (#504, @tomjaguarpaw)
• Wrap evalMaybeM and evalEitherM in withFrozenCallStack (#499, @ocharles)

Version 1.4 (2023-08-07)

• Fix skipping to tests/shrinks when tests have been discarded (#489, @ChickenProp)

Version 1.3 (2023-06-22)

• Better documentation for Var (#491, @endgame)
• Bump upper bounds for ansi-terminal (#486, @mpilgrem)
• Better documentation for Gen.filter[T], Gen.mapMaybe[T], Tree.prune (#485, @ChickenProp)
• Update Github CI actions, exclude Haddocks for old GHCs (#482, @ysangkok)
• Support GHC 9.6 (#481, @ysangkok)
• Bump upper bounds for resourcet and primitive (#478, @shlevy)
• Export Hedgehog.Internal.Seed.seed (#477, @sol)
• Better documentation for sample (#468, @parsonsmatt)
• Replace exceptions dependency with safe-exceptions (#466, @ocharles)
• Generalise Hedgehog.Gen.element (#411, @ocharles)

Version 1.2 (2022-08-28)

• Allow skipping to a specific test number or shrink result (#454, @ChickenProp)
  • Export shrinkPathCompress and shrinkPathDecompress (#462, @mbg)
• Support GHC 9.4 (#461, @ysangkok)
• Allow newer dependencies (#457, @ysangkok)
• Add Gen.subset (#451, @chris-martin)
• Add example for Gen.subsequence (#450, @chris-martin)
• Don't drop actions depending on shrunk predecessors (#453, @ChickenProp)

Version 1.1.2 (2022-09-02)

• Support GHC 9.4 (#461, @ysangkok)
• Allow newer dependencies (#457, @ysangkok)

Version 1.1.1 (2022-01-29)

• Support using fixed seed via HEDGEHOG_SEED (#446, @simfleischman / @moodmosaic)
• Compatibility with text-2.0 (#443, @sjakobi)
• Better 'cover' example code in haddocks (#423, @jhrcek)

Version 1.1 (2022-01-27)

• Replace HTraversable with TraversableB (from barbies) (#412, @ocharles)
• Support GHC 9.2 (#436, @patrickt)

Version 1.0.5 (2021-03-12)

• GHC 9 Support (#392, @utdemir)
• Use binary shrinking for integral (#413, @HuwCampbell)
• Build tree from values instead of wrapping and unwrapping (#414, @HuwCampbell)
• Don't shrink the action chosen in state machine testing (#415, @HuwCampbell)
• Support shrinking 1-bit numbers for CLaSH (#397, @jonfowler / @jacobstanley)

Version 1.0.4 (2020-12-11)

• Bump ansi-terminal to 0.11 (#394, @mpilgrem)
• Clean up hedgehog.cabal for GHC 8.0+ (#391, @felixonmars)
• Bump random to 1.2 (#396, @felixonmars)
• Improve the distribution of Range.scaleLinear (#405, @jonfowler / @moodmosaic)
• Change Gen.frequency generator immediately shrink (#406, @ocharles / @HuwCampbell)
• Add Property.evalMaybe, Property.evalMaybeM and Property.evalEitherM (#381, @markus1189 / @moodmosaic)
• Bump QuickCheck to 2.14 (#409, @lehins)
• Bump bytestring to 0.11 (#408, @Bodigrim)
• Minor Haddock formatting improvments (#398, @sshine / @moodmosaic)

Version 1.0.3 (2020-06-26)

• Bump cabal-version to 1.10 (#390, @moodmosaic)
• Don't swallow errors if we can't find the source file (#387, @HuwCampbell)
• Add Property.evalNF (#384, @dcastro)
• Add Gen.either and Gen.either_ (#382, @dcastro)
• Add filterT, justT, and mapMaybeT to Gen exports (#366, @kquick)
• Bump pretty-show to 1.10 which supports quasi-quotes (#365, @jacobstanley)
• Remove undefined in GenT's MonadWriter instance (#344, @HuwCampbell)
• Make Tree.interleave logarithmtic rather than linear (#313, @edsko)

Version 1.0.2 (2020-01-10)

• Support GHC 8.10 (#376, @sjakobi)
• Speed up Tree.splits (#349, @treeowl)
• Speed up Gen.shuffle (#348, @treeowl)
• Add docs on the bounds of Size (#346, @chris-martin)
• Fix performance issues with color handling (#345, @stolyaroleh)
• Add mapMaybe, mapMaybeT, in Tree and Gen (#339, @treeowl)
• Fix some formatting bugs in Haddock (#332, @sshine)
• Add MonadGen instances for StateT (#321, #330, @HuwCampbell / @tomjaguarpaw / @symbiont-sam-halliday)
• Add MonadBaseControl instance for PropertyT (#328, @treeowl)

Version 1.0.1 (2019-09-16)

• Add compatibility with GHC 8.8 (#319, @erikd)
• Include location of failed assertion in report. This enables editors to more easily parse the location of failed test assertions, and provide links/jump functionality (#308, @owickstrom)
• Stop using filter to define unicode (#303, @ajmcmiddlin)
• Export LabelName from main module (#299, @erikd)

Version 1.0 (2019-05-13)

• Add histograms to labels / coverage (#289, @jacobstanley)
• Improved shrinking of lists (#276, @jacobstanley / @edsko)
• Simplify MonadGen, this breaks the use of StateT on the outside of a GenT for the time being, it still works fine on the inside though and you can use distributeT to run it (#276, @jacobstanley)
• Change Applicative GenT to use zipping (#272, @jacobstanley / @edsko)
• Rename Tree -> TreeT, Node -> NodeT (#272, @jacobstanley)
• diff function which takes any a -> a -> Bool comparison function (#196, @chessai / @jacobstanley)
• Labelling of test runs via label, collect (#262, @ruhatch / @jacobstanley)
• Classification of test runs via cover, classify (#253, @felixmulder / @jacobstanley)
• Define proper Applicative instances for NodeT, TreeT and GenT (#173@sjakobi)
• MonadFail instance for PropertyT (#267, @geigerzaehler)
• MonadResource instance for PropertyT (#268, @geigerzaehler)
• Example for the tripping function (#258, @HuwCampbell)
• Improve documentation for state machine testing (#252, @endgame)
• runTests function for running tests from a top level executable, this was later renamed to defaultMain as is the de facto convention (#168, @erikd)
• Show output variables when parallel state machine testing fails to linearise (#235, @HuwCampbell)
• Note about enumBounded danger (#202, @thumphries)
• Expose discoverPrefix to find prefixed properties (#229, @ruhatch)
• Remove use of unix package and replace with lookupEnv (#226, @puffnfresh)

Version 0.6.1 (2018-09-22)

• Fix UTF-8 related rendering bugs on Windows (#218, @moodmosaic)
• Verify that our SplitMix/Seed avoids pathological γ-values (#207, @moodmosaic)
• Avoid weak gamma values in Hedgehog.Internal.Seed (#198, @moodmosaic)

Version 0.6 (2018-05-14)

• Pass Dieharder statistical/randomness tests (#185, @moodmosaic)
• Catch readFile exceptions on the repl (#184, @thumphries)

Version 0.5.3 (2018-03-12)

• Add Semigroup and Monoid instances for GenT that lift the inner Monoid (#156, @andrewthad)
• Gen.unicode no longer generates non-characters (#154, @johnchandlerburnham)
• Documentation improvements (#162, @fisx)
• Documentation fixes (#157, @dredozubov)

Version 0.5.2 (2018-02-05)

• Add doc explaining use of withTests 1 (#134, @chris-martin)
• Explicitly define Semigroup instance for Summary (#142, @gwils)
• Depend on semigroups (#140, @LightAndLight)
• Support transformers-0.4 (#150, @gwils)

Version 0.5.1 (2017-12-06)

• Only invoke setNumCapabilities when using the -threaded runtime (#130, @ekmett)
• Correct mixGamma oddness check (#124, @markhibberd)

Version 0.5 (2017-07-16)

• Parallel state machine testing, allows detection of commands which are not-atomic (#98, @jacobstanley)
• Easier to use variables for state machine testing (#94, @jacobstanley)
• MonadGen class allows the use of transformers like ReaderT and StateT on the outside of generators (#99, @jacobstanley)
• Better error messages for tests which throw exceptions (#95, @jacobstanley)
• Separated test input generation and assertions in to PropertyT and TestT respectively, this allows TestT to have a MonadBaseControl instance (#96, @jacobstanley)
• This document grew links to the pull requests which introduced various changes (#93, @moodmosaic)

Version 0.4.1 (2017-06-28)

• Fixed runtime type error that could occur when shrinking state machine commands (#91, @jacobstanley)

Version 0.4 (2017-06-28)

• Abstract state machine testing, check out Tim Humphries' great blog post or the process registry example to see how it works (#89, @jacobstanley)
• liftCatch, liftCatchIO, withCatch functions for isolating exceptions during tests (#89, @jacobstanley)

Version 0.3 (2017-06-11)

• Exponential range combinators (#43, @chris-martin)
• Roundtrip example, check out the blog post (#85, @thumphries)
• tripping now displays intermediate value (#85, @jacobstanley)
• distribute function for pulling a transformer out to the top level (#83, @jacobstanley)
• withExceptT function for executing tests with an inner ExceptT (e.g. Test (ExceptT x m) a) (#83, @jacobstanley)

Version 0.2.2 (2017-05-16)

• Fixed scope of unicode character generators (#76, @moodmosaic)
• Widen version bounds for some dependencies (#80, @amarpotghan)
• Expose test modules to fix build on nix / hydra (#78, @amarpotghan)
• Fixes for GHC 8.2 RC2 (#77, @erikd)

Version 0.2.1 (2017-05-09)

• Added ascii, latin1, unicode character generators (#73, @jacobstanley)

Version 0.2 (2017-05-06)

• Added a quiet test runner which can be activated by setting HEDGEHOG_VERBOSITY=0 (@jacobstanley)
• Concurrent test runner does not display tests until they are executing (@jacobstanley)
• Test runner now outputs a summary of how many successful / failed tests were run (@jacobstanley)
• checkSequential and checkParallel now allow for tests to be run without Template Haskell (@jacobstanley)
• Auto-discovery of properties is now available via discover instead of being baked in (@jacobstanley)
• annotate allows source code to be annotated inline with extra information (@jacobstanley)
• forAllWith can be used to generate values without a Show instance (@jacobstanley)
• Removed uses of Typeable to allow for generating types which cannot implement it (@jacobstanley)