-
Notifications
You must be signed in to change notification settings - Fork 172
/
rule.dart
326 lines (259 loc) · 8.67 KB
/
rule.dart
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'dart:io';
import 'package:analyzer/src/lint/registry.dart';
import 'package:analyzer/src/lint/state.dart';
import 'package:args/args.dart';
import 'package:linter/src/analyzer.dart';
import 'package:linter/src/rules.dart';
import 'package:linter/src/utils.dart';
import 'package:path/path.dart' as path;
import '../test/test_constants.dart';
import 'changelog.dart';
import 'since.dart';
/// Generates rule and rule test stub files (into `src/rules` and `test/rules`
/// respectively), as well as the rule index (`rules.dart`).
void main(List<String> args) {
var parser = ArgParser()
..addOption('out', abbr: 'o', help: 'Specifies project root.')
..addOption(
'name',
abbr: 'n',
help: 'Specifies lower_underscore rule name.',
mandatory: true,
);
ArgResults options;
try {
options = parser.parse(args);
} on FormatException catch (err) {
printUsage(parser, err.message);
return;
}
var outDir = options['out'] ?? '.';
var d = Directory(outDir as String);
if (!d.existsSync()) {
printToConsole("Directory '${d.path}' does not exist");
return;
}
var ruleName = options['name'];
if (ruleName == null) {
printUsage(parser);
return;
}
// Generate rule stub and update supporting files.
generateRule(ruleName as String, outDir: outDir);
}
var _supportsTestMode = ['use_build_context_synchronously'];
String get _thisYear => DateTime.now().year.toString();
String capitalize(String s) => s.substring(0, 1).toUpperCase() + s.substring(1);
void generateFile(String ruleName, String stubPath, Generator generator,
{String? outDir, bool overwrite = false, bool format = false}) {
var (:file, :contents) = generator(ruleName, toClassName(ruleName));
if (outDir != null) {
var outPath = path.join(outDir, stubPath, file);
var outFile = File(outPath);
if (!overwrite && outFile.existsSync()) {
printToConsole('Warning: stub already exists at $outPath; skipping');
return;
}
printToConsole('Writing to $outPath');
outFile.writeAsStringSync(contents);
if (format) {
Process.runSync('dart', ['format', '-o', 'write', outPath]);
}
} else {
printToConsole(contents);
}
}
void generateRule(String ruleName, {String? outDir}) {
// Generate rule stub.
generateFile(ruleName, path.join('lib', 'src', 'rules'), _generateClass,
outDir: outDir);
// Generate unit test stub.
generateFile(ruleName, ruleTestDir, _generateTest, outDir: outDir);
// Generate test `all.dart` helper.
generateFile(ruleName, ruleTestDir, _generateAllTestsFile,
outDir: outDir, overwrite: true, format: true);
// Generate an example `all.yaml`
generateFile(ruleName, 'example', _generateAllYaml,
outDir: outDir, overwrite: true);
printToConsole('Updating ${SdkVersionFile.filePath}');
SdkVersionFile().addRule(ruleName);
printToConsole('Updating ${Changelog.fileName}');
Changelog().addEntry(RuleStateChange.added, ruleName);
// Update rule registry.
generateFile(ruleName, path.join('lib', 'src'), _generateRulesFile,
outDir: outDir, overwrite: true);
printToConsole('A unit test has been stubbed out in:');
printToConsole(' $ruleTestDir/${ruleName}_test.dart');
}
void printUsage(ArgParser parser, [String? error]) {
var message = error ?? 'Generates rule stubs.';
stdout.write('''$message
Usage: rule
${parser.usage}
''');
}
String toClassName(String ruleName) =>
ruleName.split('_').map(capitalize).join();
GeneratedFile _generateAllTestsFile(String libName, String className) {
registerLintRules();
var sb = StringBuffer();
sb.write('''
// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
''');
var paths = Directory(ruleTestDir).listSync().map((f) => f.path).toList()
..sort();
var testNames = <String>[];
for (var file in paths) {
if (!file.endsWith('_test.dart')) continue;
var filePath = path.relative(file, from: path.join('test', 'rules'));
var testName = path.split(filePath).last.split('_test').first;
testNames.add(testName);
sb.writeln("import '$filePath' as $testName;");
}
sb.write(r'''
void main() {
''');
for (var testName in testNames) {
sb.writeln(' $testName.main();');
}
sb.writeln('}');
return (file: 'all.dart', contents: sb.toString());
}
GeneratedFile _generateAllYaml(String libName, String className) {
registerLintRules();
var sb = StringBuffer();
sb.write('''
# Auto-generated options enabling all lints.
# Add these to your `analysis_options.yaml` file and tailor to fit!
linter:
rules:
''');
var names = Registry.ruleRegistry.rules
.where((r) => !r.state.isDeprecated && !r.state.isRemoved)
.map((r) => r.name)
.toList();
names.add(libName);
names.sort();
for (var rule in names) {
sb.writeln(' - $rule');
}
return (file: 'all.yaml', contents: sb.toString());
}
GeneratedFile _generateClass(String ruleName, String className) => (
file: '$ruleName.dart',
contents: """
// Copyright (c) $_thisYear, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/dart/ast/visitor.dart';
import '../analyzer.dart';
const _desc = r' ';
const _details = r'''
**DO** ...
**BAD:**
```dart
```
**GOOD:**
```dart
```
''';
class $className extends LintRule {
static const LintCode code = LintCode(
'$ruleName', '<add problem message here>',
correctionMessage: '<add correction message here>');
$className()
: super(
name: '$ruleName',
description: _desc,
details: _details,
group: Group.style);
@override
LintCode get lintCode => code;
@override
void registerNodeProcessors(NodeLintRegistry registry, LinterContext context) {
var visitor = _Visitor(this);
registry.addSimpleIdentifier(this, visitor);
}
}
class _Visitor extends SimpleAstVisitor {
final LintRule rule;
_Visitor(this.rule);
@override
void visitSimpleIdentifier(SimpleIdentifier node) {
// TODO: implement
}
}
"""
);
GeneratedFile _generateRulesFile(String libName, String className) {
registerLintRules();
var sb = StringBuffer();
sb.write('''
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'analyzer.dart';
''');
var names = Registry.ruleRegistry.rules.map((r) => r.name).toList();
names.add(libName);
names.sort();
var imports = <String>[];
for (var name in names) {
var pathPrefix = Registry.ruleRegistry.getRule(name)?.group == Group.pub
? path.join('rules', 'pub')
: 'rules';
imports.add("import '$pathPrefix/$name.dart';");
}
//ignore: prefer_foreach
for (var import in imports..sort()) {
sb.writeln(import);
}
sb.write('''
void registerLintRules({bool inTestMode = false}) {
Analyzer.facade.cacheLinterVersion();
Analyzer.facade
''');
for (var (i, name) in names.indexed) {
var className = toClassName(name);
var args = _supportsTestMode.contains(name) ? 'inTestMode: inTestMode' : '';
var suffix = i == names.length - 1 ? ';' : '';
sb.writeln(' ..register($className($args))$suffix');
}
sb.writeln('}');
return (file: 'rules.dart', contents: sb.toString());
}
GeneratedFile _generateTest(String libName, String className) => (
file: '${libName}_test.dart',
contents: '''
// Copyright (c) $_thisYear, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'package:test_reflective_loader/test_reflective_loader.dart';
import '../rule_test_support.dart';
// TODO: add to all.dart
main() {
defineReflectiveSuite(() {
defineReflectiveTests(${className}Test);
});
}
@reflectiveTest
class ${className}Test extends LintRuleTest {
@override
String get lintRule => '$libName';
test_firstTest() async {
await assertDiagnostics(r\'\'\'
\'\'\', [
lint(0, 0),
]);
}
}
'''
);
typedef GeneratedFile = ({String file, String contents});
typedef Generator = GeneratedFile Function(String libName, String className);