/
require-named-capture-group.js
87 lines (75 loc) · 2.69 KB
/
require-named-capture-group.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
* @fileoverview Rule to enforce requiring named capture groups in regular expression.
* @author Pig Fang <https://github.com/g-plane>
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const regexpp = require("regexpp");
//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------
const parser = new regexpp.RegExpParser();
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "enforce using named capture group in regular expression",
category: "Best Practices",
recommended: false,
url: "https://eslint.org/docs/rules/require-named-capture-group"
},
schema: [],
messages: {
required: "Capture group '{{group}}' in regular expression should be named."
}
},
create(context) {
/**
* Function to check regular expression.
*
* @param {string} regex The regular expression to be check.
* @param {ASTNode} node AST node which contains regular expression.
* @returns {void}
*/
function checkRegex(regex, node) {
const ast = parser.parsePattern(regex);
regexpp.visitRegExpAST(ast, {
onCapturingGroupEnter(group) {
if (!group.name) {
context.report({
node,
messageId: "required",
data: {
group: group.raw
}
});
}
}
});
}
return {
Literal(node) {
if (node.regex) {
checkRegex(node.regex.pattern, node);
}
},
"NewExpression, CallExpression"(node) {
const { callee, arguments: [firstArg] } = node;
if (
callee.type === "Identifier" &&
callee.name === "RegExp" &&
firstArg &&
firstArg.type === "Literal" &&
typeof firstArg.value === "string"
) {
checkRegex(firstArg.value, node);
}
}
}
}
}