ndmitchell/hlint

Support restricting a function in certain modules

Open

#1,392 opened on Jul 2, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Haskell (1,594 stars) (208 forks)batch import
good first issue

Description

It's possible to restrict a function in all modules except certain modules:

- functions:
  - {name: [fromIntegral], within: 'modules_where_fromIntegral_is_ok'}

But it doesn't seem possible to restrict a function only in certain modules. This would be a useful feature to add.

Contributor guide

Tech stack
None
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic HaskellFamiliarity with hlint's configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The current implementation supports restricting a function in all modules except a list using 'within'. To add the inverse, look at how the YAML configuration is parsed in hlint, specifically the handling of the 'within' field. Then implement a new field (e.g., 'only') that restricts to only those modules. Check the test suite for existing restriction tests and add tests for the new feature. The code likely resides in files related to configuration parsing and hint application.
Support restricting a function in certain modules · ndmitchell/hlint#1392 | Good First Issue