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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
mod constraints;
mod rule;
mod rule_collection;
use serde::{Deserialize, Serialize};
use serde_yaml::{with::singleton_map_recursive::deserialize, Deserializer, Result};
use ast_grep_core::language::Language;
pub use rule::{
try_deserialize_matchers, try_from_serializable as deserialize_rule, Rule, RuleConfig,
RuleWithConstraint, SerializableMetaVarMatcher, SerializableRule, Severity,
};
pub use rule_collection::RuleCollection;
fn from_str<'de, T: Deserialize<'de>>(s: &'de str) -> Result<T> {
let deserializer = Deserializer::from_str(s);
deserialize(deserializer)
}
#[derive(Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct AstGrepConfig {
pub rule_dirs: Vec<String>,
pub rules: Option<Vec<()>>,
}
pub fn deserialize_sgconfig(source: &str) -> Result<AstGrepConfig> {
from_str(source)
}
pub fn from_yaml_string<'a, L: Language + Deserialize<'a>>(
yamls: &'a str,
) -> Result<Vec<RuleConfig<L>>> {
let mut ret = vec![];
for yaml in Deserializer::from_str(yamls) {
let config: RuleConfig<L> = deserialize(yaml)?;
ret.push(config);
}
Ok(ret)
}
#[cfg(test)]
mod test {
use super::*;
use ast_grep_core::language::TSLanguage;
#[derive(Clone, Deserialize, PartialEq, Eq)]
pub enum TypeScript {
Tsx,
}
impl Language for TypeScript {
fn get_ts_language(&self) -> TSLanguage {
tree_sitter_typescript::language_tsx().into()
}
}
fn test_rule_match(yaml: &str, source: &str) {
let config = &from_yaml_string::<TypeScript>(yaml).expect("rule should parse")[0];
let grep = config.language.ast_grep(source);
assert!(grep.root().find(config.get_matcher()).is_some());
}
fn test_rule_unmatch(yaml: &str, source: &str) {
let config = &from_yaml_string::<TypeScript>(yaml).expect("rule should parse")[0];
let grep = config.language.ast_grep(source);
assert!(grep.root().find(config.get_matcher()).is_none());
}
fn make_yaml(rule: &str) -> String {
format!(
r"
id: test
message: test rule
severity: info
language: Tsx
rule:
{rule}
"
)
}
#[test]
fn test_deserialize_rule_config() {
let yaml = &make_yaml(
"
pattern: let a = 123
",
);
test_rule_match(yaml, "let a = 123; let b = 33;");
test_rule_match(yaml, "class B { func() {let a = 123; }}");
test_rule_unmatch(yaml, "const a = 33");
}
#[test]
fn test_deserialize_nested() {
let yaml = &make_yaml(
"
all:
- pattern: let $A = 123
- pattern: let a = $B
",
);
test_rule_match(yaml, "let a = 123; let b = 33;");
test_rule_match(yaml, "class B { func() {let a = 123; }}");
test_rule_unmatch(yaml, "const a = 33");
test_rule_unmatch(yaml, "let a = 33");
}
#[test]
fn test_deserialize_kind() {
let yaml = &make_yaml(
"
kind: class_body
",
);
test_rule_match(yaml, "class B { func() {let a = 123; }}");
test_rule_unmatch(yaml, "const B = { func() {let a = 123; }}");
}
#[test]
fn test_deserialize_inside() {
let yaml = &make_yaml(
"
all:
- inside:
kind: class_body
- pattern: let a = 123
",
);
test_rule_unmatch(yaml, "let a = 123; let b = 33;");
test_rule_match(yaml, "class B { func() {let a = 123; }}");
test_rule_unmatch(yaml, "let a = 123");
}
#[test]
fn test_deserialize_not_inside() {
let yaml = &make_yaml(
"
all:
- not:
inside:
kind: class_body
- pattern: let a = 123
",
);
test_rule_match(yaml, "let a = 123; let b = 33;");
test_rule_unmatch(yaml, "class B { func() {let a = 123; }}");
test_rule_unmatch(yaml, "let a = 13");
}
#[test]
fn test_deserialize_meta_var() {
let yaml = &make_yaml(
"
all:
- inside:
any:
- pattern: function $A($$$) { $$$ }
- pattern: let $A = ($$$) => $$$
- pattern: $A($$$)
",
);
test_rule_match(yaml, "function recursion() { recursion() }");
test_rule_match(yaml, "let recursion = () => { recursion() }");
test_rule_unmatch(yaml, "function callOther() { other() }");
}
}