This repository has been archived by the owner on Jul 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 258
/
unused_code_analyzer.dart
218 lines (182 loc) · 6.5 KB
/
unused_code_analyzer.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
import 'dart:io';
import 'package:analyzer/dart/analysis/analysis_context.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/analysis/utilities.dart';
import 'package:analyzer/dart/element/element.dart';
// ignore: implementation_imports
import 'package:analyzer/src/dart/element/element.dart';
import 'package:path/path.dart';
import 'package:source_span/source_span.dart';
import '../../config_builder/config_builder.dart';
import '../../config_builder/models/analysis_options.dart';
import '../../reporters/models/reporter.dart';
import '../../utils/analyzer_utils.dart';
import 'models/file_elements_usage.dart';
import 'models/unused_code_file_report.dart';
import 'models/unused_code_issue.dart';
import 'public_code_visitor.dart';
import 'reporters/reporter_factory.dart';
import 'reporters/unused_code_report_params.dart';
import 'unused_code_analysis_config.dart';
import 'unused_code_config.dart';
import 'used_code_visitor.dart';
/// The analyzer responsible for collecting unused code reports.
class UnusedCodeAnalyzer {
const UnusedCodeAnalyzer();
/// Returns a reporter for the given [name]. Use the reporter
/// to convert analysis reports to console, JSON or other supported format.
Reporter<UnusedCodeFileReport, void, UnusedCodeReportParams>? getReporter({
required String name,
required IOSink output,
}) =>
reporter(
name: name,
output: output,
);
/// Returns a list of unused code reports
/// for analyzing all files in the given [folders].
/// The analysis is configured with the [config].
Future<Iterable<UnusedCodeFileReport>> runCliAnalysis(
Iterable<String> folders,
String rootFolder,
UnusedCodeConfig config, {
String? sdkPath,
}) async {
final collection =
createAnalysisContextCollection(folders, rootFolder, sdkPath);
final codeUsages = FileElementsUsage();
final publicCode = <String, Set<Element>>{};
for (final context in collection.contexts) {
final unusedCodeAnalysisConfig =
_getAnalysisConfig(context, rootFolder, config);
final filePaths = getFilePaths(
folders,
context,
rootFolder,
unusedCodeAnalysisConfig.globalExcludes,
);
final analyzedFiles =
filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
for (final filePath in analyzedFiles) {
final unit = await context.currentSession.getResolvedUnit(filePath);
final codeUsage = _analyzeFileCodeUsages(unit);
if (codeUsage != null) {
codeUsages.merge(codeUsage);
}
publicCode[filePath] = _analyzeFilePublicCode(unit);
}
final notAnalyzedFiles = filePaths.difference(analyzedFiles);
for (final filePath in notAnalyzedFiles) {
if (unusedCodeAnalysisConfig.analyzerExcludedPatterns
.any((pattern) => pattern.matches(filePath))) {
final unit = await resolveFile2(path: filePath);
final codeUsage = _analyzeFileCodeUsages(unit);
if (codeUsage != null) {
codeUsages.merge(codeUsage);
}
}
}
}
if (!config.isMonorepo) {
codeUsages.exports.forEach(publicCode.remove);
}
return _getReports(codeUsages, publicCode, rootFolder);
}
UnusedCodeAnalysisConfig _getAnalysisConfig(
AnalysisContext context,
String rootFolder,
UnusedCodeConfig config,
) {
final analysisOptions = analysisOptionsFromContext(context) ??
analysisOptionsFromFilePath(rootFolder, context);
final contextConfig =
ConfigBuilder.getUnusedCodeConfigFromOption(analysisOptions)
.merge(config);
return ConfigBuilder.getUnusedCodeConfig(contextConfig, rootFolder);
}
FileElementsUsage? _analyzeFileCodeUsages(SomeResolvedUnitResult unit) {
if (unit is ResolvedUnitResult) {
final visitor = UsedCodeVisitor();
unit.unit.visitChildren(visitor);
return visitor.fileElementsUsage;
}
return null;
}
Set<Element> _analyzeFilePublicCode(SomeResolvedUnitResult unit) {
if (unit is ResolvedUnitResult) {
final visitor = PublicCodeVisitor();
unit.unit.visitChildren(visitor);
return visitor.topLevelElements;
}
return {};
}
Iterable<UnusedCodeFileReport> _getReports(
FileElementsUsage codeUsages,
Map<String, Set<Element>> publicCodeElements,
String rootFolder,
) {
final unusedCodeReports = <UnusedCodeFileReport>[];
publicCodeElements.forEach((path, elements) {
final issues = <UnusedCodeIssue>[];
for (final element in elements) {
if (_isUnused(codeUsages, path, element)) {
final unit = element.thisOrAncestorOfType<CompilationUnitElement>();
if (unit != null) {
issues.add(_createUnusedCodeIssue(element as ElementImpl, unit));
}
}
}
final relativePath = relative(path, from: rootFolder);
if (issues.isNotEmpty) {
unusedCodeReports.add(UnusedCodeFileReport(
path: path,
relativePath: relativePath,
issues: issues,
));
}
});
return unusedCodeReports;
}
bool _isUsed(Element usedElement, Element element) =>
element == usedElement ||
element is PropertyInducingElement && element.getter == usedElement;
bool _isUnused(
FileElementsUsage codeUsages,
String path,
Element element,
) =>
!codeUsages.elements.any(
(usedElement) => _isUsed(usedElement, element),
) &&
!codeUsages.usedExtensions.any(
(usedElement) => _isUsed(usedElement, element),
) &&
!codeUsages.prefixMap.values.any(
(usage) =>
usage.paths.contains(path) &&
usage.elements.any((usedElement) =>
_isUsed(usedElement, element) ||
(usedElement.name == element.name &&
usedElement.kind == element.kind)),
);
UnusedCodeIssue _createUnusedCodeIssue(
ElementImpl element,
CompilationUnitElement unit,
) {
final offset = element.codeOffset!;
// ignore: unnecessary_non_null_assertion
final lineInfo = unit.lineInfo!;
final offsetLocation = lineInfo.getLocation(offset);
final sourceUrl = element.source!.uri;
return UnusedCodeIssue(
declarationName: element.displayName,
declarationType: element.kind.displayName,
location: SourceLocation(
offset,
sourceUrl: sourceUrl,
line: offsetLocation.lineNumber,
column: offsetLocation.columnNumber,
),
);
}
}