avh4 / avh4/elm-format

Collapsing Comment blocks

Open
#141 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion
Dominant language
Haskell
Stars
1.3k
Forks
148
PR merge metrics
No merged PRs in 30d

Description

I frequently comment out code while testing, and elm-format is stripping the line indents. This makes it so I can't uncomment the code later. For example:

-- fieldListItem : AvailableField -> Html
-- fieldListItem af =
  -- a
    -- [ class "list-group-item narrow" ]
    -- [ text af.name ]

Elm format turns it into this:

-- fieldListItem : AvailableField -> Html
-- fieldListItem af =
-- a
-- [ class "list-group-item narrow" ]
-- [ text af.name ]

Which if I then uncomment, turns into this, and throws an error (Elm-format never re-indents it).

fieldListItem : AvailableField -> Html
fieldListItem af =
a
[ class "list-group-item narrow" ]
[ text af.name ]

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 reading the issue’s before-and-after examples and tracing how elm-format formats indented Elm comment blocks. Done means formatting preserves the indentation in the example so uncommenting the code retains valid layout.

Written by the indexing model from the issue text.

Assessment

Tech stack
elm, haskell
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.