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

Improved error message and docs for regexp/no-useless-non-capturing-group #668

Merged
merged 3 commits into from
Oct 23, 2023
Merged

Improved error message and docs for regexp/no-useless-non-capturing-group #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cb3fa4
Improved error message and docs for `regexp/no-useless-non-capturing-…
RunDevelopment Oct 21, 2023
87a20b3
Create flat-snakes-raise.md
RunDevelopment Oct 21, 2023
9279c46
Updated tests
RunDevelopment Oct 21, 2023
File filter

Filter by extension

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

Improved error message and docs for `regexp/no-useless-non-capturing-group`
5 changes: 3 additions & 2 deletions docs/rules/no-useless-non-capturing-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ since: "v0.4.0"

## :book: Rule Details

This rule reports unnecessary non-capturing group
This rule reports unnecessary non-capturing groups. Unnecessary groups are just clutter that make regexes harder to read, so they should be removed.

<eslint-code-block fix>

Expand All @@ -34,6 +34,7 @@ var foo = /(?:abcd)/.test(str)
var foo = /(?:[a-d])/.test(str)
var foo = /(?:[a-d])|e/.test(str)
var foo = /(?:a|(?:b|c)|d)/.test(str)
var foo = /a(?:b)+/.test(str)
```

</eslint-code-block>
Expand All @@ -49,7 +50,7 @@ var foo = /(?:a|(?:b|c)|d)/.test(str)
```

- `"allowTop"`:
Whether a top-level non-capturing group is allowed. Defaults to `"partial"`.
Whether a top-level non-capturing group is allowed (e.g. `/(?:foo|bar)/`). Defaults to `"partial"`.

Sometimes it's useful to wrap a whole pattern into a non-capturing group (e.g. when the pattern is used as a building block to construct more complex patterns). Use this option to allow top-level non-capturing groups.
- `"partial"`:
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-useless-non-capturing-group.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ export default createRule("no-useless-non-capturing-group", {
},
],
messages: {
unexpected: "Unexpected quantifier Non-capturing group.",
unexpected:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
},
type: "suggestion", // "problem",
},
Expand Down
82 changes: 60 additions & 22 deletions tests/lib/rules/no-useless-non-capturing-group.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ tester.run("no-useless-non-capturing-group", rule as any, {
output: `/abcd/.test(str)`,
errors: [
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 2,
endLine: 1,
Expand All @@ -96,7 +97,8 @@ tester.run("no-useless-non-capturing-group", rule as any, {
output: `/abcd/v.test(str)`,
errors: [
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 2,
endLine: 1,
Expand All @@ -109,7 +111,8 @@ tester.run("no-useless-non-capturing-group", rule as any, {
output: `/[abcd]/.test(str)`,
errors: [
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 2,
endLine: 1,
Expand All @@ -120,19 +123,24 @@ tester.run("no-useless-non-capturing-group", rule as any, {
{
code: `/(?:ab|cd)/.test(str)`,
output: `/ab|cd/.test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: `/a(?:ab|(?:.|a|b))/`,
output: `/a(?:ab|.|a|b)/`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: `/(?:[abcd]+?)/.test(str)`,
output: `/[abcd]+?/.test(str)`,
errors: [
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 2,
},
Expand All @@ -143,12 +151,14 @@ tester.run("no-useless-non-capturing-group", rule as any, {
output: String.raw`/0/.test(str); /\1(?:0)/.test(str); /1/.test(str); /\1(?:1)/.test(str)`,
errors: [
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 2,
},
{
message: "Unexpected quantifier Non-capturing group.",
message:
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
line: 1,
column: 42,
},
Expand All @@ -157,7 +167,9 @@ tester.run("no-useless-non-capturing-group", rule as any, {
{
code: String.raw`/(?:a\n)/.test(str)`,
output: String.raw`/a\n/.test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String.raw`
Expand All @@ -166,61 +178,83 @@ tester.run("no-useless-non-capturing-group", rule as any, {
output: String.raw`
const s = "a\\n"
;(new RegExp(s)).test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String.raw`
const s = "(?:a"+"\\n)"
;(new RegExp(s)).test(str)`,
output: null,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},

{
code: `/(?:a)/.test(str)`,
output: `/a/.test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/(?:a)+/),
output: String(/a+/),
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String.raw`/(?:\w)/.test(str)`,
output: String.raw`/\w/.test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/(?:[abc])*/),
output: String(/[abc]*/),
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/foo(?:[abc]*)bar/),
output: String(/foo[abc]*bar/),
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/foo(?:bar)/),
output: String(/foobar/),
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: `/(?:a|b)/.test(str)`,
output: `/a|b/.test(str)`,
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/a|(?:b|c)/),
output: String(/a|b|c/),
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: String(/a|(?:b|c)/),
output: String(/a|b|c/),
options: [{ allowTop: "always" }],
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: `
Expand All @@ -238,7 +272,9 @@ tester.run("no-useless-non-capturing-group", rule as any, {
// { allowTop: "partial" }
`,
options: [{ allowTop: "partial" }],
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
{
code: `
Expand All @@ -250,7 +286,9 @@ tester.run("no-useless-non-capturing-group", rule as any, {
`,
output: null,
options: [{ allowTop: "never" }],
errors: ["Unexpected quantifier Non-capturing group."],
errors: [
"Unexpected unnecessary non-capturing group. This group can be removed without changing the behaviour of the regex.",
],
},
],
})