/
assist.dart
475 lines (465 loc) · 15.8 KB
/
assist.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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
// Copyright (c) 2014, 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:analysis_server/plugin/edit/assist/assist_dart.dart';
import 'package:analysis_server/src/services/correction/fix_processor.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/instrumentation/service.dart';
import 'package:analyzer_plugin/utilities/assist/assist.dart';
import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
/// The implementation of [DartAssistContext].
class DartAssistContextImpl implements DartAssistContext {
@override
final InstrumentationService instrumentationService;
@override
final ChangeWorkspace workspace;
@override
final ResolvedUnitResult resolveResult;
@override
final Map<ProducerGenerator, Set<String>> producerGeneratorsForLintRules;
@override
final int selectionOffset;
@override
final int selectionLength;
DartAssistContextImpl(
this.instrumentationService,
this.workspace,
this.resolveResult,
this.producerGeneratorsForLintRules,
this.selectionOffset,
this.selectionLength,
);
}
/// An enumeration of possible assist kinds.
class DartAssistKind {
static const ADD_DIAGNOSTIC_PROPERTY_REFERENCE = AssistKind(
'dart.assist.add.diagnosticPropertyReference',
DartAssistKindPriority.DEFAULT,
'Add a debug reference to this property',
);
static const ADD_RETURN_TYPE = AssistKind(
'dart.assist.add.returnType',
DartAssistKindPriority.DEFAULT,
'Add return type',
);
static const ADD_TYPE_ANNOTATION = AssistKind(
'dart.assist.add.typeAnnotation',
DartAssistKindPriority.DEFAULT,
'Add type annotation',
);
static const ASSIGN_TO_LOCAL_VARIABLE = AssistKind(
'dart.assist.assignToVariable',
DartAssistKindPriority.DEFAULT,
'Assign value to new local variable',
);
static const CONVERT_CLASS_TO_ENUM = AssistKind(
'dart.assist.convert.classToEnum',
DartAssistKindPriority.DEFAULT,
'Convert class to an enum',
);
static const CONVERT_CLASS_TO_MIXIN = AssistKind(
'dart.assist.convert.classToMixin',
DartAssistKindPriority.DEFAULT,
'Convert class to a mixin',
);
static const CONVERT_DOCUMENTATION_INTO_BLOCK = AssistKind(
'dart.assist.convert.blockComment',
DartAssistKindPriority.DEFAULT,
'Convert to block documentation comment',
);
static const CONVERT_DOCUMENTATION_INTO_LINE = AssistKind(
'dart.assist.convert.lineComment',
DartAssistKindPriority.DEFAULT,
'Convert to line documentation comment',
);
static const CONVERT_INTO_ASYNC_BODY = AssistKind(
'dart.assist.convert.bodyToAsync',
DartAssistKindPriority.PRIORITY,
'Convert to async function body',
);
static const CONVERT_INTO_BLOCK_BODY = AssistKind(
'dart.assist.convert.bodyToBlock',
DartAssistKindPriority.DEFAULT,
'Convert to block body',
);
static const CONVERT_INTO_EXPRESSION_BODY = AssistKind(
'dart.assist.convert.bodyToExpression',
DartAssistKindPriority.DEFAULT,
'Convert to expression body',
);
static const CONVERT_INTO_FINAL_FIELD = AssistKind(
'dart.assist.convert.getterToFinalField',
DartAssistKindPriority.DEFAULT,
'Convert to final field',
);
static const CONVERT_INTO_FOR_INDEX = AssistKind(
'dart.assist.convert.forEachToForIndex',
DartAssistKindPriority.DEFAULT,
'Convert to for-index loop',
);
static const CONVERT_INTO_GENERIC_FUNCTION_SYNTAX = AssistKind(
'dart.assist.convert.toGenericFunctionSyntax',
DartAssistKindPriority.DEFAULT,
"Convert into 'Function' syntax",
);
static const CONVERT_INTO_GETTER = AssistKind(
'dart.assist.convert.finalFieldToGetter',
DartAssistKindPriority.DEFAULT,
'Convert to getter',
);
static const CONVERT_INTO_IS_NOT = AssistKind(
'dart.assist.convert.isNot',
DartAssistKindPriority.DEFAULT,
'Convert to is!',
);
static const CONVERT_INTO_IS_NOT_EMPTY = AssistKind(
'dart.assist.convert.isNotEmpty',
DartAssistKindPriority.DEFAULT,
"Convert to 'isNotEmpty'",
);
static const CONVERT_PART_OF_TO_URI = AssistKind(
'dart.assist.convert.partOfToPartUri',
DartAssistKindPriority.DEFAULT,
'Convert to use a URI',
);
static const CONVERT_TO_DOUBLE_QUOTED_STRING = AssistKind(
'dart.assist.convert.toDoubleQuotedString',
DartAssistKindPriority.DEFAULT,
'Convert to double quoted string',
);
static const CONVERT_TO_FIELD_PARAMETER = AssistKind(
'dart.assist.convert.toConstructorFieldParameter',
DartAssistKindPriority.DEFAULT,
'Convert to field formal parameter',
);
static const CONVERT_TO_FOR_ELEMENT = AssistKind(
'dart.assist.convert.toForElement',
DartAssistKindPriority.DEFAULT,
"Convert to a 'for' element",
);
static const CONVERT_TO_IF_CASE_STATEMENT = AssistKind(
'dart.assist.convert.ifCaseStatement',
DartAssistKindPriority.DEFAULT,
"Convert to 'if-case' statement",
);
static const CONVERT_TO_IF_CASE_STATEMENT_CHAIN = AssistKind(
'dart.assist.convert.ifCaseStatementChain',
DartAssistKindPriority.DEFAULT,
"Convert to 'if-case' statement chain",
);
static const CONVERT_TO_IF_ELEMENT = AssistKind(
'dart.assist.convert.toIfElement',
DartAssistKindPriority.DEFAULT,
"Convert to an 'if' element",
);
static const CONVERT_TO_INT_LITERAL = AssistKind(
'dart.assist.convert.toIntLiteral',
DartAssistKindPriority.DEFAULT,
'Convert to an int literal',
);
static const CONVERT_TO_MAP_LITERAL = AssistKind(
'dart.assist.convert.toMapLiteral',
DartAssistKindPriority.DEFAULT,
'Convert to map literal',
);
static const CONVERT_TO_MULTILINE_STRING = AssistKind(
'dart.assist.convert.toMultilineString',
DartAssistKindPriority.DEFAULT,
'Convert to multiline string',
);
static const CONVERT_TO_NORMAL_PARAMETER = AssistKind(
'dart.assist.convert.toConstructorNormalParameter',
DartAssistKindPriority.DEFAULT,
'Convert to normal parameter',
);
static const CONVERT_TO_NULL_AWARE = AssistKind(
'dart.assist.convert.toNullAware',
DartAssistKindPriority.DEFAULT,
"Convert to use '?.'",
);
static const CONVERT_TO_PACKAGE_IMPORT = AssistKind(
'dart.assist.convert.relativeToPackageImport',
DartAssistKindPriority.DEFAULT,
"Convert to 'package:' import",
);
static const CONVERT_TO_RELATIVE_IMPORT = AssistKind(
'dart.assist.convert.packageToRelativeImport',
DartAssistKindPriority.DEFAULT,
'Convert to a relative import',
);
static const CONVERT_TO_SET_LITERAL = AssistKind(
'dart.assist.convert.toSetLiteral',
DartAssistKindPriority.DEFAULT,
'Convert to set literal',
);
static const CONVERT_TO_SINGLE_QUOTED_STRING = AssistKind(
'dart.assist.convert.toSingleQuotedString',
DartAssistKindPriority.DEFAULT,
'Convert to single quoted string',
);
static const CONVERT_TO_SPREAD = AssistKind(
'dart.assist.convert.toSpread',
DartAssistKindPriority.DEFAULT,
'Convert to a spread',
);
static const CONVERT_TO_SUPER_PARAMETERS = AssistKind(
'dart.assist.convert.toSuperParameters',
DartAssistKindPriority.DEFAULT,
'Convert to using super parameters',
);
static const CONVERT_TO_SWITCH_EXPRESSION = AssistKind(
'dart.assist.convert.switchExpression',
DartAssistKindPriority.DEFAULT,
'Convert to switch expression',
);
static const DESTRUCTURE_LOCAL_VARIABLE_ASSIGNMENT = AssistKind(
'dart.assist.destructureLocalVariableAssignment',
DartAssistKindPriority.DEFAULT,
'Destructure variable assignment',
);
static const CONVERT_TO_SWITCH_STATEMENT = AssistKind(
'dart.assist.convert.switchStatement',
DartAssistKindPriority.DEFAULT,
'Convert to switch statement',
);
static const ENCAPSULATE_FIELD = AssistKind(
'dart.assist.encapsulateField',
DartAssistKindPriority.DEFAULT,
'Encapsulate field',
);
static const EXCHANGE_OPERANDS = AssistKind(
'dart.assist.exchangeOperands',
DartAssistKindPriority.DEFAULT,
'Exchange operands',
);
static const FLUTTER_CONVERT_TO_CHILDREN = AssistKind(
'dart.assist.flutter.convert.childToChildren',
DartAssistKindPriority.DEFAULT,
'Convert to children:',
);
static const FLUTTER_CONVERT_TO_STATEFUL_WIDGET = AssistKind(
'dart.assist.flutter.convert.toStatefulWidget',
DartAssistKindPriority.DEFAULT,
'Convert to StatefulWidget',
);
static const FLUTTER_CONVERT_TO_STATELESS_WIDGET = AssistKind(
'dart.assist.flutter.convert.toStatelessWidget',
DartAssistKindPriority.DEFAULT,
'Convert to StatelessWidget',
);
static const FLUTTER_WRAP_GENERIC = AssistKind(
'dart.assist.flutter.wrap.generic',
DartAssistKindPriority.FLUTTER_WRAP_GENERAL,
'Wrap with widget...',
);
static const FLUTTER_WRAP_BUILDER = AssistKind(
'dart.assist.flutter.wrap.builder',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Builder',
);
static const FLUTTER_WRAP_CENTER = AssistKind(
'dart.assist.flutter.wrap.center',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Center',
);
static const FLUTTER_WRAP_COLUMN = AssistKind(
'dart.assist.flutter.wrap.column',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Column',
);
static const FLUTTER_WRAP_CONTAINER = AssistKind(
'dart.assist.flutter.wrap.container',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Container',
);
static const FLUTTER_WRAP_PADDING = AssistKind(
'dart.assist.flutter.wrap.padding',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Padding',
);
static const FLUTTER_WRAP_ROW = AssistKind(
'dart.assist.flutter.wrap.row',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with Row',
);
static const FLUTTER_WRAP_SIZED_BOX = AssistKind(
'dart.assist.flutter.wrap.sizedBox',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with SizedBox',
);
static const FLUTTER_WRAP_STREAM_BUILDER = AssistKind(
'dart.assist.flutter.wrap.streamBuilder',
DartAssistKindPriority.FLUTTER_WRAP_SPECIFIC,
'Wrap with StreamBuilder',
);
static const FLUTTER_SWAP_WITH_CHILD = AssistKind(
'dart.assist.flutter.swap.withChild',
DartAssistKindPriority.FLUTTER_SWAP,
'Swap with child',
);
static const FLUTTER_SWAP_WITH_PARENT = AssistKind(
'dart.assist.flutter.swap.withParent',
DartAssistKindPriority.FLUTTER_SWAP,
'Swap with parent',
);
static const FLUTTER_MOVE_DOWN = AssistKind(
'dart.assist.flutter.move.down',
DartAssistKindPriority.FLUTTER_MOVE,
'Move widget down',
);
static const FLUTTER_MOVE_UP = AssistKind(
'dart.assist.flutter.move.up',
DartAssistKindPriority.FLUTTER_MOVE,
'Move widget up',
);
static const FLUTTER_REMOVE_WIDGET = AssistKind(
'dart.assist.flutter.removeWidget',
DartAssistKindPriority.FLUTTER_REMOVE,
'Remove this widget',
);
static const IMPORT_ADD_SHOW = AssistKind(
'dart.assist.add.showCombinator',
DartAssistKindPriority.DEFAULT,
"Add explicit 'show' combinator",
);
static const INLINE_INVOCATION = AssistKind(
'dart.assist.inline',
DartAssistKindPriority.DEFAULT,
"Inline invocation of '{0}'",
);
static const INVERT_IF_STATEMENT = AssistKind(
'dart.assist.invertIf',
DartAssistKindPriority.DEFAULT,
"Invert 'if' statement",
);
static const JOIN_IF_WITH_INNER = AssistKind(
'dart.assist.joinWithInnerIf',
DartAssistKindPriority.DEFAULT,
"Join 'if' statement with inner 'if' statement",
);
static const JOIN_IF_WITH_OUTER = AssistKind(
'dart.assist.joinWithOuterIf',
DartAssistKindPriority.DEFAULT,
"Join 'if' statement with outer 'if' statement",
);
static const JOIN_VARIABLE_DECLARATION = AssistKind(
'dart.assist.joinVariableDeclaration',
DartAssistKindPriority.DEFAULT,
'Join variable declaration',
);
static const REMOVE_TYPE_ANNOTATION = AssistKind(
// TODO(pq): unify w/ fix
'dart.assist.remove.typeAnnotation',
DartAssistKindPriority.PRIORITY,
'Remove type annotation',
);
static const REPLACE_CONDITIONAL_WITH_IF_ELSE = AssistKind(
'dart.assist.convert.conditionalToIfElse',
DartAssistKindPriority.DEFAULT,
"Replace conditional with 'if-else'",
);
static const REPLACE_IF_ELSE_WITH_CONDITIONAL = AssistKind(
'dart.assist.convert.ifElseToConditional',
DartAssistKindPriority.DEFAULT,
"Replace 'if-else' with conditional ('c ? x : y')",
);
static const REPLACE_WITH_VAR = AssistKind(
'dart.assist.replace.withVar',
DartAssistKindPriority.DEFAULT,
"Replace type annotation with 'var'",
);
static const SHADOW_FIELD = AssistKind(
'dart.assist.shadowField',
DartAssistKindPriority.DEFAULT,
'Create a local variable that shadows the field',
);
static const SORT_CHILD_PROPERTY_LAST = AssistKind(
'dart.assist.sort.child.properties.last',
DartAssistKindPriority.DEFAULT,
'Move child property to end of arguments',
);
static const SPLIT_AND_CONDITION = AssistKind(
'dart.assist.splitIfConjunction',
DartAssistKindPriority.DEFAULT,
'Split && condition',
);
static const SPLIT_VARIABLE_DECLARATION = AssistKind(
'dart.assist.splitVariableDeclaration',
DartAssistKindPriority.DEFAULT,
'Split variable declaration',
);
static const SURROUND_WITH_BLOCK = AssistKind(
'dart.assist.surround.block',
DartAssistKindPriority.SURROUND_WITH_BLOCK,
'Surround with block',
);
static const SURROUND_WITH_DO_WHILE = AssistKind(
'dart.assist.surround.doWhile',
DartAssistKindPriority.SURROUND_WITH_DO_WHILE,
"Surround with 'do-while'",
);
static const SURROUND_WITH_FOR = AssistKind(
'dart.assist.surround.forEach',
DartAssistKindPriority.SURROUND_WITH_FOR,
"Surround with 'for'",
);
static const SURROUND_WITH_FOR_IN = AssistKind(
'dart.assist.surround.forIn',
DartAssistKindPriority.SURROUND_WITH_FOR_IN,
"Surround with 'for-in'",
);
static const SURROUND_WITH_IF = AssistKind(
'dart.assist.surround.if',
DartAssistKindPriority.SURROUND_WITH_IF,
"Surround with 'if'",
);
static const SURROUND_WITH_SET_STATE = AssistKind(
'dart.assist.surround.setState',
DartAssistKindPriority.SURROUND_WITH_SET_STATE,
"Surround with 'setState'",
);
static const SURROUND_WITH_TRY_CATCH = AssistKind(
'dart.assist.surround.tryCatch',
DartAssistKindPriority.SURROUND_WITH_TRY_CATCH,
"Surround with 'try-catch'",
);
static const SURROUND_WITH_TRY_FINALLY = AssistKind(
'dart.assist.surround.tryFinally',
DartAssistKindPriority.SURROUND_WITH_TRY_FINALLY,
"Surround with 'try-finally'",
);
static const SURROUND_WITH_WHILE = AssistKind(
'dart.assist.surround.while',
DartAssistKindPriority.SURROUND_WITH_WHILE,
"Surround with 'while'",
);
static const UNWRAP_IF_BODY = AssistKind(
'dart.assist.unwrap.if',
DartAssistKindPriority.DEFAULT,
"Unwrap 'if' body",
);
static const USE_CURLY_BRACES = AssistKind(
'dart.assist.surround.curlyBraces',
DartAssistKindPriority.DEFAULT,
'Use curly braces',
);
}
/// The priorities associated with various groups of assists.
class DartAssistKindPriority {
static const int FLUTTER_REMOVE = 25;
static const int FLUTTER_MOVE = 26;
static const int FLUTTER_SWAP = 27;
static const int FLUTTER_WRAP_SPECIFIC = 28;
static const int FLUTTER_WRAP_GENERAL = 29;
static const int DEFAULT = 30;
static const int PRIORITY = 31;
static const int SURROUND_WITH_TRY_FINALLY = 31;
static const int SURROUND_WITH_TRY_CATCH = 32;
static const int SURROUND_WITH_DO_WHILE = 33;
static const int SURROUND_WITH_SET_STATE = 33;
static const int SURROUND_WITH_FOR = 34;
static const int SURROUND_WITH_FOR_IN = 35;
static const int SURROUND_WITH_WHILE = 36;
static const int SURROUND_WITH_IF = 37;
static const int SURROUND_WITH_BLOCK = 38;
}