-
Notifications
You must be signed in to change notification settings - Fork 24
Release preparations #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
f2ae87e
to
bdebf48
Compare
(Thanks to HLS for the suggestions.) This should harden the code base against ecosystem changes like what happened for random-1.3. QuickCheck and HUnit are not imported qualified everywhere yet, because HLS failed on some modules.
7396a74
to
44b4af2
Compare
Outcome of a discussion with Simon Hengel.
I had a phone conversation with @sol resulting in a new README. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should directly link to the README. I opened a PR against your branch for that:
Other than that, this looks great. Thank you Andreas! 🙏🎉
|
||
- [hspec](https://hackage.haskell.org/package/hspec) | ||
- [tasty](https://hackage.haskell.or/package/tasty) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be helpful to guide users how to migrate to modern frameworks. Here is an instruction for tasty
:
### Migration to `tasty`
The following steps are sufficient for the majority of packages:
* Replace packages in `build-depends`:
* `test-framework` -> `tasty`,
* `test-framework-hunit` -> `tasty-hunit`,
* `test-framework-quickcheck2` -> `tasty-quickcheck`.
* Replace module imports:
* `Test.Framework` -> `Test.Tasty`,
* `Test.Framework.Providers.HUnit` -> `Test.Tasty.HUnit`,
* `Test.Framework.Providers.QuickCheck2` -> `Test.Tasty.QuickCheck`.
* Replace in type signatures:
* `Test` -> `TestTree`.
* Replace `defaultMain tests` with `defaultMain (testGroup "All" tests)`.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is for "new users" and kept brief on purpose.
- For existing users, there is no need to necessarily migrate to anything.
- If existing users choose to migrate to something else, I trust them to be able to figure out themselves how to do this.
- If you want to provide instructions on how to migrate from
test-framework
to your project then I think this belongs into the documentation of your project.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, for what it's worth:
### Migration to `hspec`
The following steps are sufficient:
* Add to `build-depends`:
* `hspec-test-framework`
* Remove from`build-depends`:
* `test-framework`
* `test-framework-hunit`
* `test-framework-quickcheck2`
* Replace `test-framework-th` with `hspec-test-framework-th`
But really, I don't think any of this belongs here.
Co-authored-by: Simon Hengel <sol@typeful.net> Co-authored-by: ˌbodʲɪˈɡrʲim <andrew.lelechenko@gmail.com>
I merged your suggestions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Spare users of this library the compilation warnings.
acb7d59
to
39a5f41
Compare
Published! |
@sol I am accepting reformulations of the READMEs if you want to suggest some, see
Closes #71, closes #72.