Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.

Commit 892263c

Browse files
incendialincendial
authored
feat: add monorepo flag for check-unused-files command (#684)
* feat: add monorepo flag for check-unused-file command * chore: update changelog * chore: fix analyzer issues * test: add tests
1 parent f81d54a commit 892263c

File tree

16 files changed

+403
-53
lines changed

16 files changed

+403
-53
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Unreleased
44

5+
* fix: add `monorepo` flag for `check-unused-code` command.
56
* fix: ignore a class usage inside `State<T>` for `check-unused-code` command.
67
* fix: correctly handle variables declaration for `check-unused-code` command.
78
* feat: add static code diagnostics `avoid-dynamic`, `prefer-async-await`.

‎lib/src/analyzers/unused_code_analyzer/unused_code_analyzer.dart‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ import 'package:analyzer/dart/analysis/utilities.dart';
66
import 'package:analyzer/dart/element/element.dart';
77
// ignore: implementation_imports
88
import 'package:analyzer/src/dart/element/element.dart';
9-
import 'package:glob/glob.dart';
109
import 'package:path/path.dart';
1110
import 'package:source_span/source_span.dart';
1211

1312
import '../../config_builder/config_builder.dart';
1413
import '../../config_builder/models/analysis_options.dart';
1514
import '../../reporters/models/reporter.dart';
1615
import '../../utils/analyzer_utils.dart';
17-
import '../../utils/file_utils.dart';
1816
import 'models/file_elements_usage.dart';
1917
import 'models/unused_code_file_report.dart';
2018
import 'models/unused_code_issue.dart';
@@ -61,7 +59,7 @@ class UnusedCodeAnalyzer {
6159

6260
final excludes = unusedCodeAnalysisConfig.globalExcludes
6361
.followedBy(unusedCodeAnalysisConfig.analyzerExcludedPatterns);
64-
final filePaths = _getFilePaths(folders, context, rootFolder, excludes);
62+
final filePaths = getFilePaths(folders, context, rootFolder, excludes);
6563

6664
final analyzedFiles =
6765
filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
@@ -111,22 +109,6 @@ class UnusedCodeAnalyzer {
111109
return ConfigBuilder.getUnusedCodeConfig(contextConfig, rootFolder);
112110
}
113111

114-
Set<String> _getFilePaths(
115-
Iterable<String> folders,
116-
AnalysisContext context,
117-
String rootFolder,
118-
Iterable<Glob> excludes,
119-
) {
120-
final contextFolders = folders.where((path) {
121-
final newPath = normalize(join(rootFolder, path));
122-
123-
return newPath == context.contextRoot.root.path ||
124-
context.contextRoot.root.path.startsWith('$newPath/');
125-
}).toList();
126-
127-
return extractDartFilesFromFolders(contextFolders, rootFolder, excludes);
128-
}
129-
130112
FileElementsUsage? _analyzeFileCodeUsages(SomeResolvedUnitResult unit) {
131113
if (unit is ResolvedUnitResult) {
132114
final visitor = UsedCodeVisitor();

‎lib/src/analyzers/unused_files_analyzer/unused_files_analyzer.dart‎

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import 'dart:io';
22

3+
import 'package:analyzer/dart/analysis/analysis_context.dart';
34
import 'package:analyzer/dart/analysis/results.dart';
45
import 'package:analyzer/dart/analysis/utilities.dart';
56
import 'package:path/path.dart';
@@ -8,10 +9,10 @@ import '../../config_builder/config_builder.dart';
89
import '../../config_builder/models/analysis_options.dart';
910
import '../../reporters/models/reporter.dart';
1011
import '../../utils/analyzer_utils.dart';
11-
import '../../utils/file_utils.dart';
1212
import 'models/unused_files_file_report.dart';
1313
import 'reporters/reporter_factory.dart';
1414
import 'reporters/unused_files_report_params.dart';
15+
import 'unused_files_analysis_config.dart';
1516
import 'unused_files_config.dart';
1617
import 'unused_files_visitor.dart';
1718

@@ -45,22 +46,12 @@ class UnusedFilesAnalyzer {
4546
final unusedFiles = <String>{};
4647

4748
for (final context in collection.contexts) {
48-
final analysisOptions = await analysisOptionsFromContext(context) ??
49-
await analysisOptionsFromFilePath(rootFolder);
50-
51-
final contextConfig =
52-
ConfigBuilder.getUnusedFilesConfigFromOption(analysisOptions)
53-
.merge(config);
5449
final unusedFilesAnalysisConfig =
55-
ConfigBuilder.getUnusedFilesConfig(contextConfig, rootFolder);
56-
57-
final contextFolders = folders
58-
.where((path) => normalize(join(rootFolder, path))
59-
.startsWith(context.contextRoot.root.path))
60-
.toList();
50+
await _getAnalysisConfig(context, rootFolder, config);
6151

62-
final filePaths = extractDartFilesFromFolders(
63-
contextFolders,
52+
final filePaths = getFilePaths(
53+
folders,
54+
context,
6455
rootFolder,
6556
unusedFilesAnalysisConfig.globalExcludes,
6657
);
@@ -69,19 +60,18 @@ class UnusedFilesAnalyzer {
6960

7061
final analyzedFiles =
7162
filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
72-
7363
for (final filePath in analyzedFiles) {
7464
final unit = await context.currentSession.getResolvedUnit(filePath);
75-
unusedFiles.removeAll(_analyzeFile(filePath, unit));
65+
unusedFiles.removeAll(_analyzeFile(filePath, unit, config.isMonorepo));
7666
}
7767

7868
final notAnalyzedFiles = filePaths.difference(analyzedFiles);
79-
8069
for (final filePath in notAnalyzedFiles) {
8170
if (unusedFilesAnalysisConfig.analyzerExcludedPatterns
8271
.any((pattern) => pattern.matches(filePath))) {
8372
final unit = await resolveFile2(path: filePath);
84-
unusedFiles.removeAll(_analyzeFile(filePath, unit));
73+
unusedFiles
74+
.removeAll(_analyzeFile(filePath, unit, config.isMonorepo));
8575
}
8676
}
8777
}
@@ -102,9 +92,29 @@ class UnusedFilesAnalyzer {
10292
}
10393
}
10494

105-
Iterable<String> _analyzeFile(String filePath, SomeResolvedUnitResult unit) {
95+
Future<UnusedFilesAnalysisConfig> _getAnalysisConfig(
96+
AnalysisContext context,
97+
String rootFolder,
98+
UnusedFilesConfig config,
99+
) async {
100+
final analysisOptions = await analysisOptionsFromContext(context) ??
101+
await analysisOptionsFromFilePath(rootFolder);
102+
103+
final contextConfig =
104+
ConfigBuilder.getUnusedFilesConfigFromOption(analysisOptions)
105+
.merge(config);
106+
107+
return ConfigBuilder.getUnusedFilesConfig(contextConfig, rootFolder);
108+
}
109+
110+
Iterable<String> _analyzeFile(
111+
String filePath,
112+
SomeResolvedUnitResult unit,
113+
bool ignoreExports,
114+
) {
106115
if (unit is ResolvedUnitResult) {
107-
final visitor = UnusedFilesVisitor(filePath);
116+
final visitor =
117+
UnusedFilesVisitor(filePath, ignoreExports: ignoreExports);
108118
unit.unit.visitChildren(visitor);
109119

110120
return visitor.paths;

‎lib/src/analyzers/unused_files_analyzer/unused_files_config.dart‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ import '../../config_builder/models/analysis_options.dart';
44
class UnusedFilesConfig {
55
final Iterable<String> excludePatterns;
66
final Iterable<String> analyzerExcludePatterns;
7+
final bool isMonorepo;
78

89
const UnusedFilesConfig({
910
required this.excludePatterns,
1011
required this.analyzerExcludePatterns,
12+
required this.isMonorepo,
1113
});
1214

1315
/// Creates the config from analysis [options].
@@ -16,13 +18,18 @@ class UnusedFilesConfig {
1618
excludePatterns: const [],
1719
analyzerExcludePatterns:
1820
options.readIterableOfString(['analyzer', 'exclude']),
21+
isMonorepo: false,
1922
);
2023

2124
/// Creates the config from cli args.
22-
factory UnusedFilesConfig.fromArgs(Iterable<String> excludePatterns) =>
25+
factory UnusedFilesConfig.fromArgs(
26+
Iterable<String> excludePatterns, {
27+
required bool isMonorepo,
28+
}) =>
2329
UnusedFilesConfig(
2430
excludePatterns: excludePatterns,
2531
analyzerExcludePatterns: const [],
32+
isMonorepo: isMonorepo,
2633
);
2734

2835
/// Merges two configs into a single one.
@@ -35,5 +42,6 @@ class UnusedFilesConfig {
3542
...analyzerExcludePatterns,
3643
...overrides.analyzerExcludePatterns,
3744
},
45+
isMonorepo: isMonorepo || overrides.isMonorepo,
3846
);
3947
}

‎lib/src/analyzers/unused_files_analyzer/unused_files_visitor.dart‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ import 'package:analyzer/dart/ast/visitor.dart';
66
import '../../utils/node_utils.dart';
77

88
class UnusedFilesVisitor extends GeneralizingAstVisitor<void> {
9-
final String _currentFilePath;
9+
final String currentFilePath;
10+
final bool ignoreExports;
1011

1112
final _paths = <String>[];
1213

1314
Iterable<String> get paths => _paths;
1415

15-
UnusedFilesVisitor(this._currentFilePath);
16+
UnusedFilesVisitor(this.currentFilePath, {required this.ignoreExports});
1617

1718
@override
1819
void visitUriBasedDirective(UriBasedDirective node) {
@@ -32,15 +33,17 @@ class UnusedFilesVisitor extends GeneralizingAstVisitor<void> {
3233
}
3334
}
3435

35-
if (node is ExportDirective && !_paths.contains(_currentFilePath)) {
36-
_paths.add(_currentFilePath);
36+
if (!ignoreExports &&
37+
node is ExportDirective &&
38+
!_paths.contains(currentFilePath)) {
39+
_paths.add(currentFilePath);
3740
}
3841
}
3942

4043
@override
4144
void visitFunctionDeclaration(FunctionDeclaration node) {
4245
if (isEntrypoint(node.name.name, node.metadata)) {
43-
_paths.add(_currentFilePath);
46+
_paths.add(currentFilePath);
4447
}
4548
}
4649
}

‎lib/src/cli/commands/check_unused_code_command.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ class CheckUnusedCodeCommand extends BaseCommand {
100100
..addSeparator('')
101101
..addFlag(
102102
FlagNames.fatalOnUnused,
103-
help: 'Treat find unused file as fatal.',
103+
help: 'Treat find unused code as fatal.',
104104
// TODO(dkrutrkikh): activate on next major version
105105
// defaultsTo: true,
106106
);

‎lib/src/cli/commands/check_unused_files_command.dart‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,14 @@ class CheckUnusedFilesCommand extends BaseCommand {
3131
final folders = argResults.rest;
3232
final excludePath = argResults[FlagNames.exclude] as String;
3333
final reporterName = argResults[FlagNames.reporter] as String;
34-
34+
final isMonorepo = argResults[FlagNames.isMonorepo] as bool;
3535
final noCongratulate = argResults[FlagNames.noCongratulate] as bool;
3636
final deleteFiles = argResults[FlagNames.deleteFiles] as bool;
3737

38-
final config = ConfigBuilder.getUnusedFilesConfigFromArgs([excludePath]);
38+
final config = ConfigBuilder.getUnusedFilesConfigFromArgs(
39+
[excludePath],
40+
isMonorepo: isMonorepo,
41+
);
3942

4043
final unusedFilesResult = await _analyzer.runCliAnalysis(
4144
folders,
@@ -70,6 +73,7 @@ class CheckUnusedFilesCommand extends BaseCommand {
7073
void _addFlags() {
7174
_usesReporterOption();
7275
addCommonFlags();
76+
_usesIsMonorepoOption();
7377
_usesExitOption();
7478
_usesDeleteUnusedFiles();
7579
}
@@ -90,6 +94,15 @@ class CheckUnusedFilesCommand extends BaseCommand {
9094
);
9195
}
9296

97+
void _usesIsMonorepoOption() {
98+
argParser
99+
..addSeparator('')
100+
..addFlag(
101+
FlagNames.isMonorepo,
102+
help: 'Treats all exported files as unused by default.',
103+
);
104+
}
105+
93106
void _usesExitOption() {
94107
argParser
95108
..addSeparator('')

‎lib/src/config_builder/config_builder.dart‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,10 @@ class ConfigBuilder {
7070

7171
/// Creates a raw unused files config from given [excludePatterns].
7272
static UnusedFilesConfig getUnusedFilesConfigFromArgs(
73-
Iterable<String> excludePatterns,
74-
) =>
75-
UnusedFilesConfig.fromArgs(excludePatterns);
73+
Iterable<String> excludePatterns, {
74+
required bool isMonorepo,
75+
}) =>
76+
UnusedFilesConfig.fromArgs(excludePatterns, isMonorepo: isMonorepo);
7677

7778
/// Creates a raw unused files config from given [options].
7879
static UnusedFilesConfig getUnusedFilesConfigFromOption(

‎lib/src/utils/analyzer_utils.dart‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
// ignore_for_file: implementation_imports
2+
import 'package:analyzer/dart/analysis/analysis_context.dart';
23
import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
34
import 'package:analyzer/file_system/physical_file_system.dart';
45
import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
56
import 'package:analyzer/src/dart/analysis/byte_store.dart';
67
import 'package:analyzer/src/dart/analysis/file_byte_store.dart';
8+
import 'package:glob/glob.dart';
79
import 'package:path/path.dart';
810

11+
import 'file_utils.dart';
12+
913
AnalysisContextCollection createAnalysisContextCollection(
1014
Iterable<String> folders,
1115
String rootFolder,
@@ -22,6 +26,22 @@ AnalysisContextCollection createAnalysisContextCollection(
2226
);
2327
}
2428

29+
Set<String> getFilePaths(
30+
Iterable<String> folders,
31+
AnalysisContext context,
32+
String rootFolder,
33+
Iterable<Glob> excludes,
34+
) {
35+
final contextFolders = folders.where((path) {
36+
final newPath = normalize(join(rootFolder, path));
37+
38+
return newPath == context.contextRoot.root.path ||
39+
context.contextRoot.root.path.startsWith('$newPath/');
40+
}).toList();
41+
42+
return extractDartFilesFromFolders(contextFolders, rootFolder, excludes);
43+
}
44+
2545
/// If the state location can be accessed, return the file byte store,
2646
/// otherwise return the memory byte store.
2747
ByteStore _createByteStore(PhysicalResourceProvider resourceProvider) {

‎test/src/analyzers/lint_analyzer/lint_config_test.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ void main() {
193193
);
194194
expect(result.rules, equals(_defaults.rules));
195195
});
196+
196197
test('empty and overrides configs', () {
197198
final result = _empty.merge(_overrides);
198199

@@ -208,6 +209,7 @@ void main() {
208209
);
209210
expect(result.rules, equals(_overrides.rules));
210211
});
212+
211213
test('defaults and overrides configs', () {
212214
final result = _defaults.merge(_overrides);
213215

0 commit comments

Comments
 (0)