ndmitchell / ndmitchell/hlint

Support preprocessors

Open
#501 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When building in CI hlint was unable to parse the README.lhs in this PR
https://github.com/frontrowed/faktory_worker_haskell/pull/13#issuecomment-398427029

This build utilizes the fpco docker build of lts-11.9, which contains https://www.stackage.org/lts-11.9/package/hlint-2.1.5

hlint .
Warning: unknown directive #faktory\_worker\_haskell
in ./README.lhs  at line 1 col 1
Warning: unknown directive ##
in ./README.lhs  at line 34 col 1
Warning: unknown directive ##
in ./README.lhs  at line 38 col 1
Warning: unknown directive ##
in ./README.lhs  at line 43 col 1
Warning: unknown directive ###
in ./README.lhs  at line 62 col 1
Warning: unknown directive ###
in ./README.lhs  at line 77 col 1
Warning: unknown directive ###
in ./README.lhs  at line 92 col 1
Warning: unknown directive ###
in ./README.lhs  at line 107 col 1
Warning: unknown directive ##
in ./README.lhs  at line 117 col 1
Warning: unknown directive ##
in ./README.lhs  at line 157 col 1
No hints

I did not have the same issues locally with:

$ hlint --version
HLint v2.0.10, (C) Neil Mitchell 2006-2017

However when I upgraded my local hlint I did see them.

$ hlint .
Warning: unknown directive #faktory\_worker\_haskell
in ./README.lhs  at line 1 col 1
Warning: unknown directive ##
in ./README.lhs  at line 34 col 1
Warning: unknown directive ##
in ./README.lhs  at line 38 col 1
Warning: unknown directive ##
in ./README.lhs  at line 43 col 1
Warning: unknown directive ###
in ./README.lhs  at line 63 col 1
Warning: unknown directive ###
in ./README.lhs  at line 78 col 1
Warning: unknown directive ###
in ./README.lhs  at line 93 col 1
Warning: unknown directive ###
in ./README.lhs  at line 108 col 1
Warning: unknown directive ##
in ./README.lhs  at line 118 col 1
Warning: unknown directive ##
in ./README.lhs  at line 158 col 1
No hints

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

Reproduce the report by running hlint . on the referenced README.lhs with a current HLint version. Start by tracing how literate Haskell and its preprocessor directives are handled, then establish the expected behavior for the reported directives. Done means the README.lhs input is processed without the listed unknown-directive warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.