dart-decimate 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Cargo.lock +572 -0
- package/Cargo.toml +41 -0
- package/LICENSE +21 -0
- package/README.md +617 -0
- package/assets/dart-decimate-banner.png +0 -0
- package/npm/bin/dart-decimate-mcp.js +48 -0
- package/npm/bin/dart-decimate.js +48 -0
- package/npm/scripts/postinstall.js +46 -0
- package/npm/scripts/test-npx-local.js +54 -0
- package/npm/scripts/test-npx-mcp-local.js +56 -0
- package/package.json +45 -0
- package/src/baseline.rs +643 -0
- package/src/bin/dart-decimate-mcp.rs +11 -0
- package/src/boundaries/tests.rs +60 -0
- package/src/boundaries.rs +317 -0
- package/src/changed_scope.rs +117 -0
- package/src/ci_template.rs +399 -0
- package/src/cli/analyze.rs +462 -0
- package/src/cli/analyzer_options.rs +82 -0
- package/src/cli/audit_run.rs +327 -0
- package/src/cli/boundary_args.rs +44 -0
- package/src/cli/ci_template_run.rs +196 -0
- package/src/cli/command_name.rs +20 -0
- package/src/cli/common_args.rs +167 -0
- package/src/cli/config_run.rs +78 -0
- package/src/cli/coverage_run.rs +393 -0
- package/src/cli/decision_surface_run.rs +99 -0
- package/src/cli/default_command.rs +69 -0
- package/src/cli/dupes_args.rs +150 -0
- package/src/cli/entry_points.rs +121 -0
- package/src/cli/error.rs +149 -0
- package/src/cli/error_output.rs +68 -0
- package/src/cli/explain_run.rs +72 -0
- package/src/cli/fix_run.rs +162 -0
- package/src/cli/flags_args.rs +23 -0
- package/src/cli/health_args.rs +200 -0
- package/src/cli/hooks_run.rs +191 -0
- package/src/cli/impact_run.rs +95 -0
- package/src/cli/init_run.rs +49 -0
- package/src/cli/inspect_args.rs +20 -0
- package/src/cli/inspect_run.rs +66 -0
- package/src/cli/issue_filter_args.rs +240 -0
- package/src/cli/list_run.rs +311 -0
- package/src/cli/mode_args.rs +72 -0
- package/src/cli/output_format.rs +62 -0
- package/src/cli/regression_args.rs +156 -0
- package/src/cli/request_args.rs +175 -0
- package/src/cli/schema_commands.rs +72 -0
- package/src/cli/scope_args.rs +174 -0
- package/src/cli/security_args.rs +175 -0
- package/src/cli/security_gate_run.rs +66 -0
- package/src/cli/security_summary_run.rs +43 -0
- package/src/cli/summary_args.rs +12 -0
- package/src/cli/tests.rs +516 -0
- package/src/cli/trace_args.rs +67 -0
- package/src/cli/trace_run.rs +131 -0
- package/src/cli/trace_tests.rs +235 -0
- package/src/cli/unsupported_run.rs +116 -0
- package/src/cli/watch_run.rs +153 -0
- package/src/cli.rs +603 -0
- package/src/config/boundary_config.rs +235 -0
- package/src/config/cache.rs +25 -0
- package/src/config/dependencies.rs +114 -0
- package/src/config/health.rs +237 -0
- package/src/config/jsonc.rs +66 -0
- package/src/config/policy.rs +91 -0
- package/src/config/rule_aliases.rs +487 -0
- package/src/config/rules.rs +339 -0
- package/src/config.rs +635 -0
- package/src/coverage.rs +469 -0
- package/src/dart_parser.rs +673 -0
- package/src/decision_surface.rs +405 -0
- package/src/dependencies/analyze.rs +218 -0
- package/src/dependencies/codegen.rs +118 -0
- package/src/dependencies/discovery.rs +60 -0
- package/src/dependencies/overrides.rs +76 -0
- package/src/dependencies/private_src_imports.rs +32 -0
- package/src/dependencies/pubspec_document.rs +86 -0
- package/src/dependencies/pubspec_entry.rs +96 -0
- package/src/dependencies/tests.rs +544 -0
- package/src/dependencies/usage.rs +33 -0
- package/src/dependencies.rs +553 -0
- package/src/dependency_scripts.rs +91 -0
- package/src/dupes/lex.rs +236 -0
- package/src/dupes/tests.rs +119 -0
- package/src/dupes.rs +625 -0
- package/src/explain.rs +692 -0
- package/src/extract/directives.rs +252 -0
- package/src/extract/error_tests.rs +25 -0
- package/src/extract/members.rs +210 -0
- package/src/extract/primary_constructors.rs +421 -0
- package/src/extract/references.rs +151 -0
- package/src/extract/routes.rs +691 -0
- package/src/extract/signatures.rs +266 -0
- package/src/extract/string_tests.rs +18 -0
- package/src/extract/strings.rs +107 -0
- package/src/extract/tests.rs +697 -0
- package/src/extract.rs +680 -0
- package/src/feature_flags/tests.rs +76 -0
- package/src/feature_flags.rs +453 -0
- package/src/finding_identity.rs +60 -0
- package/src/fix.rs +551 -0
- package/src/generated.rs +53 -0
- package/src/graph/augment_tests.rs +212 -0
- package/src/graph/conditionals.rs +74 -0
- package/src/graph/package_config_tests.rs +100 -0
- package/src/graph/parts.rs +248 -0
- package/src/graph/pubspec_tests.rs +119 -0
- package/src/graph/tests.rs +837 -0
- package/src/graph/uri_tests.rs +102 -0
- package/src/graph.rs +644 -0
- package/src/health/coverage.rs +309 -0
- package/src/health/ownership.rs +175 -0
- package/src/health/runtime_coverage.rs +616 -0
- package/src/health/runtime_intelligence.rs +511 -0
- package/src/health/scores.rs +296 -0
- package/src/health/tests.rs +240 -0
- package/src/health/threshold_types.rs +163 -0
- package/src/health/thresholds.rs +229 -0
- package/src/health/types.rs +636 -0
- package/src/health.rs +597 -0
- package/src/hooks/agent_settings.rs +175 -0
- package/src/hooks/templates.rs +51 -0
- package/src/hooks.rs +569 -0
- package/src/impact.rs +287 -0
- package/src/init.rs +237 -0
- package/src/inspect.rs +142 -0
- package/src/intelligence/tests.rs +232 -0
- package/src/intelligence.rs +305 -0
- package/src/lib.rs +198 -0
- package/src/main.rs +5 -0
- package/src/manifest/mcp.rs +565 -0
- package/src/manifest.rs +552 -0
- package/src/mcp/cli_args/value_args.rs +175 -0
- package/src/mcp/cli_args.rs +658 -0
- package/src/mcp/cli_args_tests.rs +522 -0
- package/src/mcp/code_execute.rs +671 -0
- package/src/mcp/tools.rs +660 -0
- package/src/mcp.rs +325 -0
- package/src/output/audit_risk.rs +135 -0
- package/src/output/dependency_findings.rs +327 -0
- package/src/output/duplication_findings.rs +114 -0
- package/src/output/feature_flag_findings.rs +122 -0
- package/src/output/format.rs +31 -0
- package/src/output/graph_findings.rs +461 -0
- package/src/output/health_findings.rs +612 -0
- package/src/output/human.rs +27 -0
- package/src/output/next_steps.rs +92 -0
- package/src/output/route_findings.rs +76 -0
- package/src/output/runtime_coverage.rs +515 -0
- package/src/output/scope.rs +183 -0
- package/src/output/security_findings.rs +390 -0
- package/src/output/security_sarif.rs +150 -0
- package/src/output/suppressions.rs +323 -0
- package/src/output/symbol_findings.rs +257 -0
- package/src/output/tests.rs +114 -0
- package/src/output/types.rs +604 -0
- package/src/output/widget_findings.rs +213 -0
- package/src/output.rs +682 -0
- package/src/package_map.rs +495 -0
- package/src/policy/packs.rs +232 -0
- package/src/policy/tests.rs +134 -0
- package/src/policy.rs +640 -0
- package/src/project_list.rs +376 -0
- package/src/report_schema/inventory.rs +418 -0
- package/src/report_schema.rs +488 -0
- package/src/routes.rs +354 -0
- package/src/scan/tests.rs +250 -0
- package/src/scan.rs +275 -0
- package/src/security/detect.rs +639 -0
- package/src/security/tests.rs +178 -0
- package/src/security.rs +373 -0
- package/src/security_gate.rs +555 -0
- package/src/symbols/path_filters.rs +27 -0
- package/src/symbols/private_type_leaks.rs +125 -0
- package/src/symbols/riverpod.rs +113 -0
- package/src/symbols/tests.rs +692 -0
- package/src/symbols.rs +693 -0
- package/src/trace/tests.rs +225 -0
- package/src/trace.rs +690 -0
- package/src/unsupported.rs +47 -0
- package/src/widgets/lifecycle.rs +484 -0
- package/src/widgets/params.rs +236 -0
- package/src/widgets/tests.rs +430 -0
- package/src/widgets/top_level.rs +110 -0
- package/src/widgets/unrendered.rs +374 -0
- package/src/widgets.rs +590 -0
- package/src/workspace_scope.rs +358 -0
|
@@ -0,0 +1,553 @@
|
|
|
1
|
+
use std::collections::BTreeSet;
|
|
2
|
+
use std::fs;
|
|
3
|
+
use std::path::{Path, PathBuf};
|
|
4
|
+
|
|
5
|
+
use serde::{Deserialize, Serialize};
|
|
6
|
+
use serde_yaml_ng::{Mapping, Value};
|
|
7
|
+
use thiserror::Error;
|
|
8
|
+
|
|
9
|
+
use crate::graph::normalize_path;
|
|
10
|
+
use crate::{DependencyKind, Location};
|
|
11
|
+
|
|
12
|
+
mod analyze;
|
|
13
|
+
mod codegen;
|
|
14
|
+
mod discovery;
|
|
15
|
+
mod overrides;
|
|
16
|
+
mod private_src_imports;
|
|
17
|
+
mod pubspec_document;
|
|
18
|
+
mod pubspec_entry;
|
|
19
|
+
mod usage;
|
|
20
|
+
pub use analyze::analyze_dependency_hygiene;
|
|
21
|
+
use discovery::discover_packages;
|
|
22
|
+
use overrides::misconfigured_dependency_overrides;
|
|
23
|
+
pub use overrides::{DependencyOverrideMisconfigReason, MisconfiguredDependencyOverride};
|
|
24
|
+
pub use private_src_imports::PrivateSrcImport;
|
|
25
|
+
use private_src_imports::imports_private_src;
|
|
26
|
+
use pubspec_document::{declared_dependencies_from_source, dependency_location};
|
|
27
|
+
use usage::{DependencyUsage, allows_dev_dependency};
|
|
28
|
+
|
|
29
|
+
/// Dart pub dependency hygiene findings.
|
|
30
|
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
31
|
+
pub struct DependencyHygieneReport {
|
|
32
|
+
/// Declared dependencies not imported by Dart files in the declaring package.
|
|
33
|
+
pub unused_dependencies: Vec<UnusedPackageDependency>,
|
|
34
|
+
/// Dependency override entries whose key or value cannot be honored by Pub.
|
|
35
|
+
pub misconfigured_dependency_overrides: Vec<MisconfiguredDependencyOverride>,
|
|
36
|
+
/// Imported packages absent from the importing package's pubspec.
|
|
37
|
+
pub unlisted_dependencies: Vec<UnlistedPackageDependency>,
|
|
38
|
+
/// Imports into another package's private `lib/src` implementation tree.
|
|
39
|
+
pub private_src_imports: Vec<PrivateSrcImport>,
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/// A declared pub dependency that has no Dart import/export usage.
|
|
43
|
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
44
|
+
pub struct UnusedPackageDependency {
|
|
45
|
+
/// Package declaring the dependency.
|
|
46
|
+
pub package: String,
|
|
47
|
+
/// Pubspec path that declares the dependency.
|
|
48
|
+
pub pubspec_path: PathBuf,
|
|
49
|
+
/// Dependency package name.
|
|
50
|
+
pub dependency: String,
|
|
51
|
+
/// Pubspec dependency section.
|
|
52
|
+
pub section: DependencySection,
|
|
53
|
+
/// Dependency hygiene issue class.
|
|
54
|
+
pub issue: DependencyIssue,
|
|
55
|
+
/// Best-effort location of the dependency key in `pubspec.yaml`.
|
|
56
|
+
pub location: Location,
|
|
57
|
+
/// Whether Dart Decimate can suggest removal from current evidence alone.
|
|
58
|
+
pub safe_to_delete: bool,
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/// A package import/export missing from the declaring package's pubspec.
|
|
62
|
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
63
|
+
pub struct UnlistedPackageDependency {
|
|
64
|
+
/// Package containing the import/export.
|
|
65
|
+
pub package: String,
|
|
66
|
+
/// Pubspec path for the package containing the import/export.
|
|
67
|
+
pub pubspec_path: PathBuf,
|
|
68
|
+
/// Dart file containing the import/export.
|
|
69
|
+
pub path: PathBuf,
|
|
70
|
+
/// Imported package name.
|
|
71
|
+
pub dependency: String,
|
|
72
|
+
/// Import/export URI.
|
|
73
|
+
pub specifier: String,
|
|
74
|
+
/// Whether the dependency came from an import or export directive.
|
|
75
|
+
pub kind: DependencyKind,
|
|
76
|
+
/// Pubspec section where the dependency is declared, if present in a wrong section.
|
|
77
|
+
pub declared_section: Option<DependencySection>,
|
|
78
|
+
/// Location of the import/export directive.
|
|
79
|
+
pub location: Location,
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/// A dependency declaration found in a local pubspec.
|
|
83
|
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
84
|
+
pub struct DeclaredPackageDependency {
|
|
85
|
+
/// Package declaring the dependency.
|
|
86
|
+
pub package: String,
|
|
87
|
+
/// Pubspec path that declares the dependency.
|
|
88
|
+
pub pubspec_path: PathBuf,
|
|
89
|
+
/// Dependency package name.
|
|
90
|
+
pub dependency: String,
|
|
91
|
+
/// Pubspec dependency section.
|
|
92
|
+
pub section: DependencySection,
|
|
93
|
+
/// Best-effort location of the dependency key in `pubspec.yaml`.
|
|
94
|
+
pub location: Location,
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/// A local pub package discovered under the scan root.
|
|
98
|
+
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
99
|
+
pub struct LocalPubPackage {
|
|
100
|
+
/// Pub package name.
|
|
101
|
+
pub name: String,
|
|
102
|
+
/// Package root directory.
|
|
103
|
+
pub root: PathBuf,
|
|
104
|
+
/// Pubspec path.
|
|
105
|
+
pub pubspec_path: PathBuf,
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/// Pub dependency section.
|
|
109
|
+
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
|
110
|
+
#[serde(rename_all = "snake_case")]
|
|
111
|
+
pub enum DependencySection {
|
|
112
|
+
/// Runtime dependencies.
|
|
113
|
+
Dependencies,
|
|
114
|
+
/// Development-only dependencies.
|
|
115
|
+
DevDependencies,
|
|
116
|
+
/// Temporary dependency overrides.
|
|
117
|
+
DependencyOverrides,
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/// Dependency hygiene issue class.
|
|
121
|
+
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
|
122
|
+
#[serde(rename_all = "kebab-case")]
|
|
123
|
+
pub enum DependencyIssue {
|
|
124
|
+
/// Runtime dependency has no Dart import/export usage.
|
|
125
|
+
UnusedRuntimeDependency,
|
|
126
|
+
/// Development dependency has no Dart import/export usage.
|
|
127
|
+
UnusedDevDependency,
|
|
128
|
+
/// Runtime dependency is imported only from development-only files.
|
|
129
|
+
TestOnlyDependency,
|
|
130
|
+
/// Dependency override is absent from the resolved lockfile package graph.
|
|
131
|
+
UnusedDependencyOverride,
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
impl DependencySection {
|
|
135
|
+
const fn as_pubspec_key(self) -> &'static str {
|
|
136
|
+
match self {
|
|
137
|
+
Self::Dependencies => "dependencies",
|
|
138
|
+
Self::DevDependencies => "dev_dependencies",
|
|
139
|
+
Self::DependencyOverrides => "dependency_overrides",
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/// Errors returned while analyzing pub dependency hygiene.
|
|
145
|
+
#[derive(Debug, Error)]
|
|
146
|
+
pub enum DependencyHygieneError {
|
|
147
|
+
/// A directory could not be read.
|
|
148
|
+
#[error("failed to read directory {path}: {source}")]
|
|
149
|
+
ReadDir {
|
|
150
|
+
/// Directory path.
|
|
151
|
+
path: PathBuf,
|
|
152
|
+
/// Underlying IO error.
|
|
153
|
+
source: std::io::Error,
|
|
154
|
+
},
|
|
155
|
+
/// A directory entry could not be read.
|
|
156
|
+
#[error("failed to read directory entry under {path}: {source}")]
|
|
157
|
+
ReadDirEntry {
|
|
158
|
+
/// Directory being scanned.
|
|
159
|
+
path: PathBuf,
|
|
160
|
+
/// Underlying IO error.
|
|
161
|
+
source: std::io::Error,
|
|
162
|
+
},
|
|
163
|
+
/// A file type could not be read.
|
|
164
|
+
#[error("failed to read file type for {path}: {source}")]
|
|
165
|
+
FileType {
|
|
166
|
+
/// Entry path.
|
|
167
|
+
path: PathBuf,
|
|
168
|
+
/// Underlying IO error.
|
|
169
|
+
source: std::io::Error,
|
|
170
|
+
},
|
|
171
|
+
/// A pubspec could not be read.
|
|
172
|
+
#[error("failed to read pubspec {path}: {source}")]
|
|
173
|
+
ReadPubspec {
|
|
174
|
+
/// Pubspec path.
|
|
175
|
+
path: PathBuf,
|
|
176
|
+
/// Underlying IO error.
|
|
177
|
+
source: std::io::Error,
|
|
178
|
+
},
|
|
179
|
+
/// A pubspec could not be parsed.
|
|
180
|
+
#[error("failed to parse pubspec {path}: {source}")]
|
|
181
|
+
ParsePubspec {
|
|
182
|
+
/// Pubspec path.
|
|
183
|
+
path: PathBuf,
|
|
184
|
+
/// Underlying YAML parse error.
|
|
185
|
+
source: serde_yaml_ng::Error,
|
|
186
|
+
},
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/// Find local pubspec declarations for one dependency package.
|
|
190
|
+
///
|
|
191
|
+
/// # Errors
|
|
192
|
+
///
|
|
193
|
+
/// Returns [`DependencyHygieneError`] if pubspec discovery or parsing fails.
|
|
194
|
+
pub fn declared_package_dependencies(
|
|
195
|
+
root: &Path,
|
|
196
|
+
dependency: &str,
|
|
197
|
+
) -> Result<Vec<DeclaredPackageDependency>, DependencyHygieneError> {
|
|
198
|
+
let packages = discover_packages(root)?;
|
|
199
|
+
let mut declarations = Vec::new();
|
|
200
|
+
for package in packages {
|
|
201
|
+
for declared in package
|
|
202
|
+
.dependencies
|
|
203
|
+
.into_iter()
|
|
204
|
+
.filter(|declared| declared.name == dependency)
|
|
205
|
+
{
|
|
206
|
+
declarations.push(DeclaredPackageDependency {
|
|
207
|
+
package: package.name.clone(),
|
|
208
|
+
pubspec_path: declared.source_path.clone(),
|
|
209
|
+
dependency: declared.name,
|
|
210
|
+
section: declared.section,
|
|
211
|
+
location: declared.location,
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
declarations.sort_by(|left, right| {
|
|
217
|
+
(
|
|
218
|
+
&left.package,
|
|
219
|
+
&left.pubspec_path,
|
|
220
|
+
left.section.as_pubspec_key(),
|
|
221
|
+
&left.dependency,
|
|
222
|
+
)
|
|
223
|
+
.cmp(&(
|
|
224
|
+
&right.package,
|
|
225
|
+
&right.pubspec_path,
|
|
226
|
+
right.section.as_pubspec_key(),
|
|
227
|
+
&right.dependency,
|
|
228
|
+
))
|
|
229
|
+
});
|
|
230
|
+
Ok(declarations)
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/// List local pub packages under a root.
|
|
234
|
+
///
|
|
235
|
+
/// # Errors
|
|
236
|
+
///
|
|
237
|
+
/// Returns [`DependencyHygieneError`] if pubspec discovery or parsing fails.
|
|
238
|
+
pub fn local_pub_packages(root: &Path) -> Result<Vec<LocalPubPackage>, DependencyHygieneError> {
|
|
239
|
+
discover_packages(root).map(|packages| {
|
|
240
|
+
packages
|
|
241
|
+
.into_iter()
|
|
242
|
+
.map(|package| LocalPubPackage {
|
|
243
|
+
name: package.name,
|
|
244
|
+
root: package.root,
|
|
245
|
+
pubspec_path: package.pubspec_path,
|
|
246
|
+
})
|
|
247
|
+
.collect()
|
|
248
|
+
})
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
252
|
+
pub(super) struct PubPackage {
|
|
253
|
+
name: String,
|
|
254
|
+
root: PathBuf,
|
|
255
|
+
pubspec_path: PathBuf,
|
|
256
|
+
dependencies: Vec<DeclaredDependency>,
|
|
257
|
+
misconfigured_dependency_overrides: Vec<MisconfiguredDependencyOverride>,
|
|
258
|
+
locked_packages: Option<BTreeSet<String>>,
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
impl PubPackage {
|
|
262
|
+
fn declares_dependency_for_path(&self, dependency: &str, path: &Path) -> bool {
|
|
263
|
+
let allow_dev_dependencies = allows_dev_dependency(&self.root, path);
|
|
264
|
+
self.dependencies.iter().any(|declared| {
|
|
265
|
+
declared.name == dependency
|
|
266
|
+
&& match declared.section {
|
|
267
|
+
DependencySection::Dependencies => true,
|
|
268
|
+
DependencySection::DevDependencies => allow_dev_dependencies,
|
|
269
|
+
DependencySection::DependencyOverrides => false,
|
|
270
|
+
}
|
|
271
|
+
})
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
fn declared_section(&self, specifier: &str) -> Option<DependencySection> {
|
|
275
|
+
let dependency = package_name(specifier)?;
|
|
276
|
+
self.dependencies
|
|
277
|
+
.iter()
|
|
278
|
+
.find(|declared| declared.name == dependency)
|
|
279
|
+
.map(|declared| declared.section)
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
284
|
+
struct DeclaredDependency {
|
|
285
|
+
name: String,
|
|
286
|
+
source_path: PathBuf,
|
|
287
|
+
section: DependencySection,
|
|
288
|
+
location: Location,
|
|
289
|
+
safe_to_delete: bool,
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
fn dependency_issue(
|
|
293
|
+
dependency: &DeclaredDependency,
|
|
294
|
+
usage: Option<&DependencyUsage>,
|
|
295
|
+
locked_packages: Option<&BTreeSet<String>>,
|
|
296
|
+
) -> Option<DependencyIssue> {
|
|
297
|
+
match dependency.section {
|
|
298
|
+
DependencySection::Dependencies => match usage {
|
|
299
|
+
Some(usage) if usage.production => None,
|
|
300
|
+
Some(usage) if usage.development => Some(DependencyIssue::TestOnlyDependency),
|
|
301
|
+
Some(_) | None => Some(DependencyIssue::UnusedRuntimeDependency),
|
|
302
|
+
},
|
|
303
|
+
DependencySection::DevDependencies => usage
|
|
304
|
+
.is_none()
|
|
305
|
+
.then_some(DependencyIssue::UnusedDevDependency),
|
|
306
|
+
DependencySection::DependencyOverrides => locked_packages.and_then(|locked| {
|
|
307
|
+
(!locked.contains(&dependency.name))
|
|
308
|
+
.then_some(DependencyIssue::UnusedDependencyOverride)
|
|
309
|
+
}),
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
pub(super) fn read_package(path: &Path) -> Result<Option<PubPackage>, DependencyHygieneError> {
|
|
314
|
+
let source = read_pubspec_source(path)?;
|
|
315
|
+
let value = parse_pubspec_value(path, &source)?;
|
|
316
|
+
|
|
317
|
+
let Some(name) = string_field(&value, "name") else {
|
|
318
|
+
return Ok(None);
|
|
319
|
+
};
|
|
320
|
+
|
|
321
|
+
let root = path
|
|
322
|
+
.parent()
|
|
323
|
+
.map_or_else(|| PathBuf::from("."), normalize_path);
|
|
324
|
+
let overrides = read_pubspec_overrides(&root)?;
|
|
325
|
+
|
|
326
|
+
Ok(Some(PubPackage {
|
|
327
|
+
name: name.to_owned(),
|
|
328
|
+
root,
|
|
329
|
+
pubspec_path: path.to_path_buf(),
|
|
330
|
+
dependencies: merged_declared_dependencies(&value, &source, path, overrides.as_ref()),
|
|
331
|
+
misconfigured_dependency_overrides: merged_misconfigured_dependency_overrides(
|
|
332
|
+
&value,
|
|
333
|
+
&source,
|
|
334
|
+
name,
|
|
335
|
+
path,
|
|
336
|
+
overrides.as_ref(),
|
|
337
|
+
),
|
|
338
|
+
locked_packages: read_locked_packages(path),
|
|
339
|
+
}))
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
#[derive(Debug, Clone)]
|
|
343
|
+
struct PubspecOverridesDocument {
|
|
344
|
+
path: PathBuf,
|
|
345
|
+
source: String,
|
|
346
|
+
value: Value,
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
fn read_pubspec_source(path: &Path) -> Result<String, DependencyHygieneError> {
|
|
350
|
+
fs::read_to_string(path).map_err(|source| DependencyHygieneError::ReadPubspec {
|
|
351
|
+
path: path.to_path_buf(),
|
|
352
|
+
source,
|
|
353
|
+
})
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
fn parse_pubspec_value(path: &Path, source: &str) -> Result<Value, DependencyHygieneError> {
|
|
357
|
+
serde_yaml_ng::from_str::<Value>(source).map_err(|source| {
|
|
358
|
+
DependencyHygieneError::ParsePubspec {
|
|
359
|
+
path: path.to_path_buf(),
|
|
360
|
+
source,
|
|
361
|
+
}
|
|
362
|
+
})
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
fn read_pubspec_overrides(
|
|
366
|
+
package_root: &Path,
|
|
367
|
+
) -> Result<Option<PubspecOverridesDocument>, DependencyHygieneError> {
|
|
368
|
+
let path = package_root.join("pubspec_overrides.yaml");
|
|
369
|
+
let source = match fs::read_to_string(&path) {
|
|
370
|
+
Ok(source) => source,
|
|
371
|
+
Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None),
|
|
372
|
+
Err(source) => return Err(DependencyHygieneError::ReadPubspec { path, source }),
|
|
373
|
+
};
|
|
374
|
+
let value = parse_pubspec_value(&path, &source)?;
|
|
375
|
+
Ok(Some(PubspecOverridesDocument {
|
|
376
|
+
path,
|
|
377
|
+
source,
|
|
378
|
+
value,
|
|
379
|
+
}))
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
fn read_locked_packages(pubspec_path: &Path) -> Option<BTreeSet<String>> {
|
|
383
|
+
let lock_path = pubspec_path.with_file_name("pubspec.lock");
|
|
384
|
+
let source = fs::read_to_string(lock_path).ok()?;
|
|
385
|
+
let value = serde_yaml_ng::from_str::<Value>(&source).ok()?;
|
|
386
|
+
let packages = mapping_field(&value, "packages")?;
|
|
387
|
+
Some(
|
|
388
|
+
packages
|
|
389
|
+
.keys()
|
|
390
|
+
.filter_map(Value::as_str)
|
|
391
|
+
.map(ToOwned::to_owned)
|
|
392
|
+
.collect(),
|
|
393
|
+
)
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
fn merged_declared_dependencies(
|
|
397
|
+
value: &Value,
|
|
398
|
+
source: &str,
|
|
399
|
+
source_path: &Path,
|
|
400
|
+
overrides: Option<&PubspecOverridesDocument>,
|
|
401
|
+
) -> Vec<DeclaredDependency> {
|
|
402
|
+
let mut dependencies = declared_dependencies(value, source, source_path);
|
|
403
|
+
if let Some(overrides) = overrides.filter(|document| {
|
|
404
|
+
has_top_level_field(
|
|
405
|
+
&document.value,
|
|
406
|
+
DependencySection::DependencyOverrides.as_pubspec_key(),
|
|
407
|
+
)
|
|
408
|
+
}) {
|
|
409
|
+
dependencies
|
|
410
|
+
.retain(|dependency| dependency.section != DependencySection::DependencyOverrides);
|
|
411
|
+
dependencies.extend(declared_dependencies_for_sections(
|
|
412
|
+
&overrides.value,
|
|
413
|
+
&overrides.source,
|
|
414
|
+
&overrides.path,
|
|
415
|
+
&[DependencySection::DependencyOverrides],
|
|
416
|
+
));
|
|
417
|
+
}
|
|
418
|
+
dependencies
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
fn merged_misconfigured_dependency_overrides(
|
|
422
|
+
value: &Value,
|
|
423
|
+
source: &str,
|
|
424
|
+
package: &str,
|
|
425
|
+
path: &Path,
|
|
426
|
+
overrides: Option<&PubspecOverridesDocument>,
|
|
427
|
+
) -> Vec<MisconfiguredDependencyOverride> {
|
|
428
|
+
if let Some(overrides) = overrides.filter(|document| {
|
|
429
|
+
has_top_level_field(
|
|
430
|
+
&document.value,
|
|
431
|
+
DependencySection::DependencyOverrides.as_pubspec_key(),
|
|
432
|
+
)
|
|
433
|
+
}) {
|
|
434
|
+
return misconfigured_dependency_overrides(
|
|
435
|
+
&overrides.value,
|
|
436
|
+
&overrides.source,
|
|
437
|
+
package,
|
|
438
|
+
&overrides.path,
|
|
439
|
+
);
|
|
440
|
+
}
|
|
441
|
+
misconfigured_dependency_overrides(value, source, package, path)
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
fn declared_dependencies(
|
|
445
|
+
value: &Value,
|
|
446
|
+
source: &str,
|
|
447
|
+
source_path: &Path,
|
|
448
|
+
) -> Vec<DeclaredDependency> {
|
|
449
|
+
let has_declared_sections = [
|
|
450
|
+
DependencySection::Dependencies,
|
|
451
|
+
DependencySection::DevDependencies,
|
|
452
|
+
DependencySection::DependencyOverrides,
|
|
453
|
+
]
|
|
454
|
+
.into_iter()
|
|
455
|
+
.any(|section| mapping_field(value, section.as_pubspec_key()).is_some());
|
|
456
|
+
let sections = [
|
|
457
|
+
DependencySection::Dependencies,
|
|
458
|
+
DependencySection::DevDependencies,
|
|
459
|
+
DependencySection::DependencyOverrides,
|
|
460
|
+
];
|
|
461
|
+
let mut dependencies =
|
|
462
|
+
declared_dependencies_for_sections(value, source, source_path, §ions);
|
|
463
|
+
|
|
464
|
+
if dependencies.is_empty() && !has_declared_sections {
|
|
465
|
+
dependencies = declared_dependencies_from_source(source, source_path);
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
dependencies
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
fn declared_dependencies_for_sections(
|
|
472
|
+
value: &Value,
|
|
473
|
+
source: &str,
|
|
474
|
+
source_path: &Path,
|
|
475
|
+
sections: &[DependencySection],
|
|
476
|
+
) -> Vec<DeclaredDependency> {
|
|
477
|
+
sections
|
|
478
|
+
.iter()
|
|
479
|
+
.copied()
|
|
480
|
+
.filter_map(|section| {
|
|
481
|
+
mapping_field(value, section.as_pubspec_key()).map(|mapping| (section, mapping))
|
|
482
|
+
})
|
|
483
|
+
.flat_map(|(section, mapping)| {
|
|
484
|
+
mapping.iter().filter_map(move |(name, value)| {
|
|
485
|
+
let name = name.as_str()?.to_owned();
|
|
486
|
+
if section == DependencySection::DependencyOverrides
|
|
487
|
+
&& (!valid_dart_package_name(&name) || value.is_null())
|
|
488
|
+
{
|
|
489
|
+
return None;
|
|
490
|
+
}
|
|
491
|
+
let location = dependency_location(source, section, &name);
|
|
492
|
+
Some(DeclaredDependency {
|
|
493
|
+
safe_to_delete: pubspec_entry::is_simple_scalar_dependency(
|
|
494
|
+
source, section, &name, location,
|
|
495
|
+
),
|
|
496
|
+
location,
|
|
497
|
+
name,
|
|
498
|
+
source_path: source_path.to_path_buf(),
|
|
499
|
+
section,
|
|
500
|
+
})
|
|
501
|
+
})
|
|
502
|
+
})
|
|
503
|
+
.collect()
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
fn owning_package<'package>(
|
|
507
|
+
packages: &'package [PubPackage],
|
|
508
|
+
path: &Path,
|
|
509
|
+
) -> Option<&'package PubPackage> {
|
|
510
|
+
packages
|
|
511
|
+
.iter()
|
|
512
|
+
.filter(|package| path.starts_with(&package.root))
|
|
513
|
+
.max_by_key(|package| package.root.components().count())
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
fn package_name(specifier: &str) -> Option<String> {
|
|
517
|
+
specifier
|
|
518
|
+
.strip_prefix("package:")
|
|
519
|
+
.and_then(|rest| rest.split_once('/'))
|
|
520
|
+
.map(|(package, _)| package.to_owned())
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
pub(crate) fn valid_dart_package_name(name: &str) -> bool {
|
|
524
|
+
let mut chars = name.chars();
|
|
525
|
+
let Some(first) = chars.next() else {
|
|
526
|
+
return false;
|
|
527
|
+
};
|
|
528
|
+
(first.is_ascii_lowercase() || first == '_')
|
|
529
|
+
&& chars.all(|ch| ch.is_ascii_lowercase() || ch.is_ascii_digit() || ch == '_')
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
fn mapping_field<'value>(value: &'value Value, field: &str) -> Option<&'value Mapping> {
|
|
533
|
+
value
|
|
534
|
+
.as_mapping()?
|
|
535
|
+
.get(Value::String(field.to_owned()))?
|
|
536
|
+
.as_mapping()
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
fn string_field<'value>(value: &'value Value, field: &str) -> Option<&'value str> {
|
|
540
|
+
value
|
|
541
|
+
.as_mapping()?
|
|
542
|
+
.get(Value::String(field.to_owned()))?
|
|
543
|
+
.as_str()
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
fn has_top_level_field(value: &Value, field: &str) -> bool {
|
|
547
|
+
value
|
|
548
|
+
.as_mapping()
|
|
549
|
+
.is_some_and(|mapping| mapping.contains_key(Value::String(field.to_owned())))
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
#[cfg(test)]
|
|
553
|
+
mod tests;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
use std::fs;
|
|
2
|
+
use std::path::{Path, PathBuf};
|
|
3
|
+
|
|
4
|
+
pub(crate) fn package_used_in_tooling(package_root: &Path, dependency: &str) -> bool {
|
|
5
|
+
pubspec_tooling_section(package_root, dependency)
|
|
6
|
+
|| tooling_files(package_root).into_iter().any(|path| {
|
|
7
|
+
fs::read_to_string(path)
|
|
8
|
+
.ok()
|
|
9
|
+
.is_some_and(|source| source_mentions_dependency(&source, dependency))
|
|
10
|
+
})
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
fn pubspec_tooling_section(package_root: &Path, dependency: &str) -> bool {
|
|
14
|
+
let path = package_root.join("pubspec.yaml");
|
|
15
|
+
fs::read_to_string(path).ok().is_some_and(|source| {
|
|
16
|
+
source.lines().any(|line| {
|
|
17
|
+
let trimmed = line.trim_end();
|
|
18
|
+
!trimmed.starts_with(' ')
|
|
19
|
+
&& !trimmed.starts_with('\t')
|
|
20
|
+
&& trimmed == format!("{dependency}:")
|
|
21
|
+
})
|
|
22
|
+
})
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
fn tooling_files(package_root: &Path) -> Vec<PathBuf> {
|
|
26
|
+
let mut paths = [
|
|
27
|
+
"analysis_options.yaml",
|
|
28
|
+
"build.yaml",
|
|
29
|
+
"melos.yaml",
|
|
30
|
+
"codemagic.yaml",
|
|
31
|
+
"Makefile",
|
|
32
|
+
]
|
|
33
|
+
.into_iter()
|
|
34
|
+
.map(|path| package_root.join(path))
|
|
35
|
+
.filter(|path| path.is_file())
|
|
36
|
+
.collect::<Vec<_>>();
|
|
37
|
+
|
|
38
|
+
collect_matching_files(&package_root.join(".github/workflows"), &mut paths);
|
|
39
|
+
collect_matching_files(&package_root.join("tool"), &mut paths);
|
|
40
|
+
paths
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
fn collect_matching_files(dir: &Path, paths: &mut Vec<PathBuf>) {
|
|
44
|
+
let Ok(entries) = fs::read_dir(dir) else {
|
|
45
|
+
return;
|
|
46
|
+
};
|
|
47
|
+
for entry in entries.flatten() {
|
|
48
|
+
let path = entry.path();
|
|
49
|
+
if path.is_file() && is_tooling_file(&path) {
|
|
50
|
+
paths.push(path);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
fn is_tooling_file(path: &Path) -> bool {
|
|
56
|
+
matches!(
|
|
57
|
+
path.extension().and_then(|extension| extension.to_str()),
|
|
58
|
+
Some("yaml" | "yml" | "sh" | "bash" | "zsh")
|
|
59
|
+
) || path
|
|
60
|
+
.file_name()
|
|
61
|
+
.and_then(|name| name.to_str())
|
|
62
|
+
.is_some_and(|name| name == "Makefile")
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
fn source_mentions_dependency(source: &str, dependency: &str) -> bool {
|
|
66
|
+
source
|
|
67
|
+
.split(|ch: char| !(ch.is_ascii_alphanumeric() || ch == '_' || ch == '-'))
|
|
68
|
+
.any(|token| token == dependency)
|
|
69
|
+
|| source.contains(&format!("{dependency}|"))
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
#[cfg(test)]
|
|
73
|
+
mod tests {
|
|
74
|
+
use super::source_mentions_dependency;
|
|
75
|
+
|
|
76
|
+
#[test]
|
|
77
|
+
fn matches_dependency_tokens_without_substrings() {
|
|
78
|
+
assert!(source_mentions_dependency(
|
|
79
|
+
"builders:\n build_runner|combining_builder:\n",
|
|
80
|
+
"build_runner"
|
|
81
|
+
));
|
|
82
|
+
assert!(source_mentions_dependency(
|
|
83
|
+
"plugins:\n - custom_lint\n",
|
|
84
|
+
"custom_lint"
|
|
85
|
+
));
|
|
86
|
+
assert!(!source_mentions_dependency(
|
|
87
|
+
"some_build_runner_extra",
|
|
88
|
+
"build_runner"
|
|
89
|
+
));
|
|
90
|
+
}
|
|
91
|
+
}
|