Skip to content
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

Add a barebones hlint configuration to kickstart discussion. #14

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions hlint/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Hlint Rules Aiming To Promote Stability

## Wishlist Of Hlint Features

There are some features we do not have access to from hlint, but that would help us write more
rules.

1. A default typeclass method is overridden.

For example, the `Eq` typeclass has a method, `(/=)`, that is being considered for removal from the
class. To promote stability, we would like to be able to write a rule that would trigger a warning
when this method is manually defined. However we cannot, as of this writing, construct such a rule.
9 changes: 9 additions & 0 deletions hlint/stability_hlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Turn off all rules by default so we only include our explicit configuration.
- ignore: { }

# Turn on restricted module configurations to be warnings.
- warn: {name: "Avoid restricted module"}

- modules:
- {name: Control.Monad.Trans.Error, within: []} # This module is deprecated.
- {name: Control.Monad.Trans.List, within: []} # This module is deprecated.