sindresorhus/eslint-plugin-unicorn

Improve `prefer-string-slice` autofix

Open

#2,505 opened on Dec 6, 2024

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
enhancementhelp wanted

Description

unicorn/prefer-string-slice is good when all the parameters are constants, or when there is only one parameter. But when there are two parameters and they're variables, the autofixes will do things like this:

editsummary = editsummary.substr(0, editsummary.length - 2); // remove trailing comma -> editsummary = editsummary.slice(0, Math.max(0, editsummary.length - 2)); // remove trailing comma

I find the Math.max pretty hard to read. I'd prefer that it not autofix that particular sub-pattern. Any interest in adding an option to this rule so that it can be configured to skip that particular sub-pattern when autofixing?

Contributor guide

Tech stack
javascript
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.
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
JavaScriptESLint plugin developmentFamiliarity with the rule's source code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the source code of the `prefer string slice` rule in the eslint plugin unicorn repository (likely in `rules/prefer string slice.js`). Focus on the autofix logic that handles cases with two parameters. Look for existing options or patterns for skipping autofixes. Check the issue comments for any further discussion on implementation details. Review the test file for the rule to understand expected behavior and to ensure new option does not break existing tests.
Improve `prefer-string-slice` autofix · sindresorhus/eslint-plugin-unicorn#2505 | Good First Issue