Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add suggestions for regexp/no-lazy-ends #624

Merged
merged 5 commits into from
Oct 1, 2023
Merged

Add suggestions for regexp/no-lazy-ends #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d471cdf
Add suggestions for `regexp/no-lazy-ends`
RunDevelopment Sep 26, 2023
2ea274b
Create rare-spiders-drop.md
RunDevelopment Sep 26, 2023
3d36f5d
Added a little hint
RunDevelopment Sep 28, 2023
9f75101
Merge branch 'no-lazy-ends-suggest' of https://github.com/ota-meshi/e…
RunDevelopment Sep 28, 2023
cb3c0b9
Update rules.ts
ota-meshi Oct 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rare-spiders-drop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"eslint-plugin-regexp": minor
---

Add suggestions for `regexp/no-lazy-ends`
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ The `plugin:regexp/all` config enables all rules. It's meant for testing, not fo
| [no-empty-lookarounds-assertion](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-empty-lookarounds-assertion.html) | disallow empty lookahead assertion or empty lookbehind assertion | ✅ | | | |
| [no-escape-backspace](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-escape-backspace.html) | disallow escape backspace (`[\b]`) | ✅ | | | |
| [no-invalid-regexp](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-invalid-regexp.html) | disallow invalid regular expression strings in `RegExp` constructors | ✅ | | | |
| [no-lazy-ends](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-lazy-ends.html) | disallow lazy quantifiers at the end of an expression | | ✅ | | |
| [no-lazy-ends](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-lazy-ends.html) | disallow lazy quantifiers at the end of an expression | | ✅ | | 💡 |
| [no-misleading-capturing-group](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-misleading-capturing-group.html) | disallow capturing groups that do not behave as one would expect | ✅ | | | 💡 |
| [no-misleading-unicode-character](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-misleading-unicode-character.html) | disallow multi-code-point characters in character classes and quantifiers | ✅ | | 🔧 | 💡 |
| [no-missing-g-flag](https://ota-meshi.github.io/eslint-plugin-regexp/rules/no-missing-g-flag.html) | disallow missing `g` flag in patterns used in `String#matchAll` and `String#replaceAll` | ✅ | | 🔧 | |
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ sidebarDepth: 0
| [no-empty-lookarounds-assertion](no-empty-lookarounds-assertion.md) | disallow empty lookahead assertion or empty lookbehind assertion | ✅ | | | |
| [no-escape-backspace](no-escape-backspace.md) | disallow escape backspace (`[\b]`) | ✅ | | | |
| [no-invalid-regexp](no-invalid-regexp.md) | disallow invalid regular expression strings in `RegExp` constructors | ✅ | | | |
| [no-lazy-ends](no-lazy-ends.md) | disallow lazy quantifiers at the end of an expression | | ✅ | | |
| [no-lazy-ends](no-lazy-ends.md) | disallow lazy quantifiers at the end of an expression | | ✅ | | 💡 |
| [no-misleading-capturing-group](no-misleading-capturing-group.md) | disallow capturing groups that do not behave as one would expect | ✅ | | | 💡 |
| [no-misleading-unicode-character](no-misleading-unicode-character.md) | disallow multi-code-point characters in character classes and quantifiers | ✅ | | 🔧 | 💡 |
| [no-missing-g-flag](no-missing-g-flag.md) | disallow missing `g` flag in patterns used in `String#matchAll` and `String#replaceAll` | ✅ | | 🔧 | |
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-lazy-ends.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ since: "v0.8.0"

⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.

💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

<!-- end auto-generated rule header -->

> disallow lazy quantifiers at the end of an expression
Expand Down
56 changes: 56 additions & 0 deletions lib/rules/no-lazy-ends.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { RegExpVisitor } from "@eslint-community/regexpp/visitor"
import type { Alternative, Quantifier } from "@eslint-community/regexpp/ast"
import type { RegExpContext } from "../utils"
import type { Rule } from "eslint"
import { createRule, defineRegexpVisitor } from "../utils"
import { UsageOfPattern } from "../utils/get-usage-of-pattern"

Expand Down Expand Up @@ -57,13 +58,23 @@ export default createRule("no-lazy-ends", {
additionalProperties: false,
},
],
hasSuggestions: true,
messages: {
uselessElement:
"The quantifier and the quantified element can be removed because the quantifier is lazy and has a minimum of 0.",
uselessQuantifier:
"The quantifier can be removed because the quantifier is lazy and has a minimum of 1.",
uselessRange:
"The quantifier can be replaced with '{{{min}}}' because the quantifier is lazy and has a minimum of {{min}}.",

suggestMakeGreedy:
"Make the quantifier greedy. (This changes the behavior of the regex.)",
suggestRemoveElement:
"Remove the quantified element. (This does not changes the behavior of the regex.)",
suggestRemoveQuantifier:
"Remove the quantifier. (This does not changes the behavior of the regex.)",
suggestRange:
"Replace the quantifier with '{{{min}}}'. (This does not changes the behavior of the regex.)",
},
type: "problem",
},
Expand All @@ -74,6 +85,7 @@ export default createRule("no-lazy-ends", {
node,
getRegexpLocation,
getUsageOfPattern,
fixReplaceNode,
}: RegExpContext): RegExpVisitor.Handlers {
if (ignorePartial) {
const usageOfPattern = getUsageOfPattern()
Expand All @@ -88,17 +100,48 @@ export default createRule("no-lazy-ends", {
for (const lazy of extractLazyEndQuantifiers(
pNode.alternatives,
)) {
const makeGreedy: Rule.SuggestionReportDescriptor = {
messageId: "suggestMakeGreedy",
fix: fixReplaceNode(lazy, lazy.raw.slice(0, -1)),
}

if (lazy.min === 0) {
// we have to replace the quantifier with (?:) to
// avoid creating invalid patterns. E.g. /a??/ -> /(?:)/
const replacement =
pNode.alternatives.length === 1 &&
pNode.alternatives[0].elements.length === 1 &&
pNode.alternatives[0].elements[0] === lazy
? "(?:)"
: ""

context.report({
node,
loc: getRegexpLocation(lazy),
messageId: "uselessElement",
suggest: [
{
messageId: "suggestRemoveElement",
fix: fixReplaceNode(lazy, replacement),
},
makeGreedy,
],
})
} else if (lazy.min === 1) {
context.report({
node,
loc: getRegexpLocation(lazy),
messageId: "uselessQuantifier",
suggest: [
{
messageId: "suggestRemoveQuantifier",
fix: fixReplaceNode(
lazy,
lazy.element.raw,
),
},
makeGreedy,
],
})
} else {
context.report({
Expand All @@ -108,6 +151,19 @@ export default createRule("no-lazy-ends", {
data: {
min: String(lazy.min),
},
suggest: [
{
messageId: "suggestRange",
data: {
min: String(lazy.min),
},
fix: fixReplaceNode(
lazy,
`${lazy.element.raw}{${lazy.min}}`,
),
},
makeGreedy,
],
})
}
}
Expand Down
28 changes: 28 additions & 0 deletions tests/lib/rules/no-lazy-ends.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier and the quantified element can be removed because the quantifier is lazy and has a minimum of 0.",
line: 1,
column: 2,
suggestions: [
{ output: "/(?:)/.test(str)" },
{ output: "/a?/.test(str)" },
],
},
],
},
Expand All @@ -49,6 +53,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier and the quantified element can be removed because the quantifier is lazy and has a minimum of 0.",
line: 1,
column: 2,
suggestions: [
{ output: "/(?:)/.test(str)" },
{ output: "/a*/.test(str)" },
],
},
],
},
Expand All @@ -60,6 +68,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier can be removed because the quantifier is lazy and has a minimum of 1.",
line: 1,
column: 2,
suggestions: [
{ output: "/a/.test(str)" },
{ output: "/a+/.test(str)" },
],
},
],
},
Expand All @@ -71,6 +83,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier can be replaced with '{3}' because the quantifier is lazy and has a minimum of 3.",
line: 1,
column: 2,
suggestions: [
{ output: "/a{3}/.test(str)" },
{ output: "/a{3,7}/.test(str)" },
],
},
],
},
Expand All @@ -82,6 +98,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier can be replaced with '{3}' because the quantifier is lazy and has a minimum of 3.",
line: 1,
column: 2,
suggestions: [
{ output: "/a{3}/.test(str)" },
{ output: "/a{3,}/.test(str)" },
],
},
],
},
Expand All @@ -94,6 +114,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier can be removed because the quantifier is lazy and has a minimum of 1.",
line: 1,
column: 9,
suggestions: [
{ output: `/(?:a|b(c))/.test(str)` },
{ output: `/(?:a|b(c+))/.test(str)` },
],
},
],
},
Expand All @@ -105,6 +129,10 @@ tester.run("no-lazy-ends", rule as any, {
"The quantifier can be removed because the quantifier is lazy and has a minimum of 1.",
line: 1,
column: 9,
suggestions: [
{ output: `/a(?:c|ab)?/.test(str)` },
{ output: `/a(?:c|ab+)?/.test(str)` },
],
},
],
},
Expand Down
4 changes: 1 addition & 3 deletions tests/lib/utils/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,7 @@ describe("Check if the strict of all rules is correct", () => {
it(messageId, () => {
const message = rule.meta.messages[messageId]
assert.ok(
message.endsWith(".") ||
message.endsWith("?") ||
message.endsWith("}}"),
/(?:[.?]|\}\})\)?$/u.test(message),
"Doesn't end with a dot.",
)
})
Expand Down
Loading