haskell/haskell-ide-engine

Provide code action to turn off a hlint warning in a project

Open

#955 opened on Nov 21, 2018

View on GitHub
 (3 comments) (3 reactions) (0 assignees)Haskell (2,358 stars) (205 forks)batch import
good first issuetype: enhancement

Description

When a hlint warning is provided, e.g. "use camelCase", you do not always want to apply it in the project.

Provide a code action to add it to the file .hlint.yaml in the project root, creating that file if it does not exist.

- ignore: {name: "Use camelCase"}

If possible, provide another one for a single override at this location. If hlint provides such a feature.

Contributor guide

Tech stack
None
Domain
developer experience
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 HaskellhlintLSP code actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the existing code action implementations in the haskell ide engine repository. Look for similar features that modify project configuration files. The issue requests adding an ignore entry to .hlint.yaml, creating the file if needed. Check comments or linked discussions for any additional constraints.