haskell/haskell-ide-engine

Report when dist and .stack-work exist

Open

#358 opened on Nov 20, 2017

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

Description

ghc-mod has a heuristic to choose between cabal and stack based projects.

This is (partly) based on the presence of a dist dir, which is taken to indicate a cabal project.

Issue a warning message on startup if both dist and .stack-work are present in the project root.

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
Haskell basicsKnowledge of cabal and stack build systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the ghc mod source code, likely in the project root or src/ directory, where the heuristic for detecting cabal vs stack projects is implemented. Specifically locate the code that checks for the presence of a dist directory. Add a similar check for .stack work and issue a warning message if both exist. Review the issue comments for any additional context or maintainer suggestions.