ndmitchell / ndmitchell/hlint

Feature request: Mark functions as requiring type annotations

Open
#616 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
1.6k
Forks
210
PR merge metrics
No merged PRs in 30d

Description

The function show not a safe function to use because it has instances on nearly every time and during refactoring we may accidentally run show on the wrong type by accident.

It would be very useful to have a rule that tells hlint to warn on functions like show to assert that they should always be called with type applications to make it obvious if show is accidentally called with an argument of the wrong type.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating HLint's existing rule definitions and configuration for function-level warnings. Define how a configured function such as show is identified and how the warning should require an explicit type application; done means the rule warns on the intended calls without affecting safe calls and has coverage for the requested behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.