Repository navigation
Expand file tree
/
Copy pathadd_rule.py
More file actions
executable file
·269 lines (231 loc) · 7.01 KB
/
Copy pathadd_rule.py
File metadata and controls
executable file
·269 lines (231 loc) · 7.01 KB
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
#!/usr/bin/env python3
#
# /// script
# requires-python = ">=3.12"
# dependencies = []
#
# [tool.ty.rules]
# truthiness-test-of-none-union = "warn"
# blanket-ignore-comment = "warn"
# missing-type-argument = "warn"
# possibly-unresolved-reference = "warn"
# unsound-return-statement = "warn"
# unsound-yield = "warn"
# unsupported-dynamic-base = "warn"
# division-by-zero = "warn"
# dynamic-function-decorator-return = "warn"
# unsound-assignment = "warn"
# redundant-condition-strict = "warn"
# disjoint-cast = "warn"
# missing-direct-dependency = "warn"
#
# [tool.uv]
# no-build = true
# exclude-newer = "P7D"
# ///
"""Generate boilerplate for a new rule.
Example usage:
python scripts/add_rule.py \
--name PreferListBuiltin \
--prefix PIE \
--code 807 \
--linter flake8-pie \
--category pedantic
"""
from __future__ import annotations
import argparse
import re
import subprocess
from pathlib import Path
ROOT_DIR = Path(__file__).resolve().parent.parent
def dir_name(linter_name: str) -> str:
return linter_name.replace("-", "_")
def pascal_case(linter_name: str) -> str:
"""Convert from snake-case to PascalCase."""
return "".join(word.title() for word in linter_name.split("-"))
def snake_case(name: str) -> str:
"""Convert from PascalCase to snake_case."""
return "".join(
f"_{word.lower()}" if word.isupper() else word for word in name
).lstrip("_")
def get_indent(line: str) -> str:
return re.match(r"^\s*", line).group() # type: ignore[union-attr, ty:unresolved-attribute]
def main(*, name: str, prefix: str, code: str, linter: str, category: str) -> None:
"""Generate boilerplate for a new rule."""
# Create a test fixture.
filestem = f"{prefix}{code}" if linter != "pylint" else snake_case(name)
with (
ROOT_DIR
/ "crates/ruff_linter/resources/test/fixtures"
/ dir_name(linter)
/ f"{filestem}.py"
).open("a"):
pass
plugin_module = ROOT_DIR / "crates/ruff_linter/src/rules" / dir_name(linter)
rule_name_snake = snake_case(name)
# Add the relevant `#testcase` macro.
mod_rs = plugin_module / "mod.rs"
content = mod_rs.read_text()
with mod_rs.open("w") as fp:
has_added_testcase = False
lines = []
for line in content.splitlines():
if not has_added_testcase and (
line.strip() == "fn rules(rule_code: Rule, path: &Path) -> Result<()> {"
):
indent = get_indent(line)
lines.append(
f'{indent}#[test_case(Rule::{name}, Path::new("{filestem}.py"))]',
)
fp.write("\n".join(lines))
fp.write("\n")
lines.clear()
has_added_testcase = True
if has_added_testcase:
fp.write(line)
fp.write("\n")
elif line.strip() == "":
fp.write("\n".join(lines))
fp.write("\n\n")
lines.clear()
else:
lines.append(line)
# Add the exports
rules_dir = plugin_module / "rules"
rules_mod = rules_dir / "mod.rs"
contents = rules_mod.read_text()
parts = contents.split("\n\n")
new_pub_use = f"pub(crate) use {rule_name_snake}::*"
new_mod = f"mod {rule_name_snake};"
if len(parts) == 2:
new_contents = parts[0]
new_contents += "\n" + new_pub_use + ";"
new_contents += "\n\n"
new_contents += parts[1] + new_mod
new_contents += "\n"
rules_mod.write_text(new_contents)
else:
with rules_mod.open("a") as fp:
fp.write(f"{new_pub_use};")
fp.write("\n\n")
fp.write(f"{new_mod}")
fp.write("\n")
# Add the relevant rule function.
with (rules_dir / f"{rule_name_snake}.rs").open("w") as fp:
fp.write(
f"""\
use ruff_macros::{{ViolationMetadata, derive_message_formats}};
use crate::Violation;
use crate::checkers::ast::Checker;
use crate::codes::Category;
/// ## What it does
///
/// ## Why is this bad?
///
/// ## Example
/// ```python
/// ```
///
/// Use instead:
/// ```python
/// ```
#[derive(ViolationMetadata)]
#[violation_metadata(preview_since = "NEXT_RUFF_VERSION", category = Category::{pascal_case(category)})]
pub(crate) struct {name};
impl Violation for {name} {{
#[derive_message_formats]
fn message(&self) -> String {{
format!("TODO: write message: {{}}", todo!("implement message"))
}}
}}
""",
)
fp.write(
f"""
/// {prefix}{code}
pub(crate) fn {rule_name_snake}(checker: &mut Checker) {{}}
""",
)
text = ""
with (ROOT_DIR / "crates/ruff_linter/src/codes.rs").open("r") as fp:
while (line := next(fp)).strip() != f"// {linter}":
text += line
text += line
lines = []
while (line := next(fp)).strip() != "":
lines.append(line)
variant = pascal_case(linter)
linter_name = linter.split(" ", maxsplit=1)[0].replace("-", "_")
rule = f"""rules::{linter_name}::rules::{name}"""
lines.append(
" " * 8 + f"""({variant}, "{code}") => {rule},\n""",
)
lines.sort()
text += "".join(lines)
text += "\n"
text += fp.read()
with (ROOT_DIR / "crates/ruff_linter/src/codes.rs").open("w") as fp:
fp.write(text)
_rustfmt(rules_mod)
def _rustfmt(path: str | Path) -> None:
subprocess.run(["rustfmt", path], check=True)
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Generate boilerplate for a new rule.",
epilog=(
"python scripts/add_rule.py "
"--name PreferListBuiltin --code PIE807 --linter flake8-pie "
"--category pedantic"
),
)
parser.add_argument(
"--name",
type=str,
required=True,
help=(
"The name of the check to generate, in PascalCase "
"(e.g., 'PreferListBuiltin')."
),
)
parser.add_argument(
"--prefix",
type=str,
required=True,
help="Prefix code for the plugin (e.g. 'PIE').",
)
parser.add_argument(
"--code",
type=str,
required=True,
help="The code of the check to generate (e.g., '807').",
)
parser.add_argument(
"--linter",
type=str,
required=True,
help="The source with which the check originated (e.g., 'flake8-pie').",
)
parser.add_argument(
"--category",
choices=(
"correctness",
"suspicious",
"complexity",
"performance",
"style",
"security",
"formatting",
"pedantic",
"restriction",
),
required=True,
help="The semantic category for the rule.",
)
args = parser.parse_args()
main(
name=args.name,
prefix=args.prefix,
code=args.code,
linter=args.linter,
category=args.category,
)