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

feat: prefer-named-capture-group add suggestions #16544

Merged
merged 6 commits into from Nov 27, 2022
Merged

feat: prefer-named-capture-group add suggestions #16544

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
446a12b
feat: [prefer-named-capture-group] add suggestions
JoshuaKGoldberg Nov 12, 2022
c57ed1a
Add test for proper parenthesis matching
JoshuaKGoldberg Nov 14, 2022
cf6044f
fix: only suggest when there are no \s
JoshuaKGoldberg Nov 15, 2022
c487982
More granular checking of suggestion viability
JoshuaKGoldberg Nov 17, 2022
f8de928
Feedback: return null in more cases, no more indexOf, suggestions: null
JoshuaKGoldberg Nov 19, 2022
a2c4ed1
Account for existing temps
JoshuaKGoldberg Nov 27, 2022
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
39 changes: 34 additions & 5 deletions lib/rules/prefer-named-capture-group.js
View file
Open in desktop
Expand Up @@ -38,23 +38,29 @@ module.exports = {
url: "https://eslint.org/docs/rules/prefer-named-capture-group"
},

hasSuggestions: true,

schema: [],

messages: {
addGroupName: "Add name to capture group.",
addNonCapture: "Convert group to non-capturing.",
required: "Capture group '{{group}}' should be converted to a named or non-capturing group."
}
},

create(context) {
const sourceCode = context.getSourceCode();

/**
* Function to check regular expression.
* @param {string} pattern The regular expression pattern to be check.
* @param {ASTNode} node AST node which contains regular expression.
* @param {ASTNode} node AST node which contains regular expression or a call/new expression.
* @param {ASTNode} regexNode AST node which contains regular expression.
* @param {boolean} uFlag Flag indicates whether unicode mode is enabled or not.
* @returns {void}
*/
function checkRegex(pattern, node, uFlag) {
function checkRegex(pattern, node, regexNode, uFlag) {
let ast;

try {
Expand All @@ -68,12 +74,35 @@ module.exports = {
regexpp.visitRegExpAST(ast, {
onCapturingGroupEnter(group) {
if (!group.name) {
const rawText = sourceCode.getText(regexNode);
const start = regexNode.range[0] + rawText.indexOf("(", group.start) + 1;
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

context.report({
node,
messageId: "required",
data: {
group: group.raw
}
},
suggest: [
{
fix(fixer) {
return fixer.insertTextBeforeRange(
[start, start],
`?<temp${((pattern.match(/temp\d+/gu) || []).length || 0) + 1}>`
);
},
messageId: "addGroupName"
},
{
fix(fixer) {
return fixer.insertTextBeforeRange(
[start, start],
"?:"
);
},
messageId: "addNonCapture"
}
]
});
}
}
Expand All @@ -83,7 +112,7 @@ module.exports = {
return {
Literal(node) {
if (node.regex) {
checkRegex(node.regex.pattern, node, node.regex.flags.includes("u"));
checkRegex(node.regex.pattern, node, node, node.regex.flags.includes("u"));
}
},
Program() {
Expand All @@ -101,7 +130,7 @@ module.exports = {
const flags = getStringIfConstant(node.arguments[1]);

if (regex) {
checkRegex(regex, node, flags && flags.includes("u"));
checkRegex(regex, node, node.arguments[0], flags && flags.includes("u"));
}
}
}
Expand Down