jfmengels/elm-review-simplify

Detect when numbers cancel each other out in expression

Open

#123 opened on Aug 15, 2023

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

Repository metrics

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

Description

This would be a follow-up to the idea in #41 and the PR done in #122.

The rule currently reports the following:

n - n
--> 0

-n + n
--> 0

but it doesn't catch something like this

something + n + else - n -- notice the 2 n cancel each other out
--> something + else

This would be nice to have, and I think that this will catch more problems than n - n.

Just like n - n, this simplification should not be enabled when we the rule is configured with expectNaN.

Contributor guide

Research direction
Examine the existing simplification rule for number cancellation patterns like 'n n' and ' n + n', then devise logic to detect when numbers cancel out in larger expressions (e.g., 'something + n + else n'). Consider the 'expectNaN' configuration.
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.
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.
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.
65