jfmengels/elm-review-simplify

Simplifications for Parser

Open

#288 opened on Feb 20, 2024

View on GitHub
 (16 comments) (0 reactions) (0 assignees)Elm (10 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (22 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Parser.map simplifications
  • Parser.andThen simplifications
  • Parser.succeed () |. p -> p
    • Only if p is a Parser ()
    • For styling purposes, should only be done when there is only a single pipe in the expression, and is at the beginning of the chain
  • Parser.succeed identity |= p -> p
    • Same styling requirements as above
  • [ ] Parser.succeed x |. Parser.succeed y -> Parser.succeed x
  • [ ] Parser.succeed always |= p |= q -> Parser.succeed identity |. p |= q
  • Parser.succeed (\_ y -> x) |= p -> Parser.succeed (\y -> x) |. p (Note, may need import of the |. operator)
  • Parser.chompIf (always False) -> Parser.succeed ()
  • Parser.chompWhile (always False) -> Parser.succeed ()
  • Parser.mapChompedString (always f) p -> Parser.map f p
  • Parser.getChompedString (Parser.succeed x) -> Parser.succeed ""

As far as I can tell, all of these would also apply to Parser.Advanced.

Contributor guide

Research direction
Review the existing Parser module implementations for patterns matching the simplifications listed, then implement each simplification following the existing codebase conventions.
Tech stack
None
Domain
developer experiencetooling
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitElm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75