-
Notifications
You must be signed in to change notification settings - Fork 3
/
lib.rs
235 lines (200 loc) · 8.15 KB
/
lib.rs
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
mod import_collector;
use std::{
collections::{HashMap, HashSet},
fs,
path::{Path, PathBuf},
process::ExitCode,
str::FromStr,
sync::atomic::{AtomicUsize, Ordering},
};
use anyhow::Result;
use bpaf::Bpaf;
use cargo_metadata::{Dependency, Metadata, MetadataCommand, Package};
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use walkdir::{DirEntry, WalkDir};
use crate::import_collector::collect_imports;
#[derive(Debug)]
pub struct Error;
// options("shear") + the "batteries" feature will strip name using `bpaf::cargo_helper` from `cargo shear"
// See <https://docs.rs/bpaf/latest/bpaf/batteries/fn.cargo_helper.html>
#[derive(Debug, Clone, Bpaf)]
#[bpaf(options("shear"))]
pub struct CargoShearOptions {
#[bpaf(long)]
fix: bool,
#[bpaf(positional("PATH"), fallback(PathBuf::from(".")))]
path: PathBuf,
}
pub struct CargoShear {
options: CargoShearOptions,
unused_dependencies: AtomicUsize,
}
type Deps = HashSet<String>;
impl CargoShear {
#[must_use]
pub fn new(options: CargoShearOptions) -> Self {
Self { options, unused_dependencies: AtomicUsize::default() }
}
#[must_use]
pub fn run(self) -> ExitCode {
match self.shear() {
Ok(()) => {
let no_deps = self.unused_dependencies.load(Ordering::SeqCst) == 0;
// returns 0 if no deps, 1 if has deps
ExitCode::from(u8::from(no_deps))
}
Err(err) => {
println!("{err}");
ExitCode::from(2)
}
}
}
fn shear(&self) -> Result<()> {
let metadata = MetadataCommand::new().current_dir(&self.options.path).exec()?;
let workspace_root = metadata.workspace_root.as_std_path();
let package_dependencies = metadata
.workspace_packages()
.par_iter()
.map(|package| self.shear_package(workspace_root, package))
.collect::<Result<Vec<Deps>>>()?
.into_iter()
.fold(HashSet::new(), |a, b| a.union(&b).cloned().collect());
self.shear_workspace(&metadata, &package_dependencies)
}
/// Returns the number of unused dependencies.
fn shear_workspace(&self, metadata: &Metadata, all_pkg_deps: &Deps) -> Result<()> {
if metadata.workspace_packages().len() <= 1 {
return Ok(());
}
let metadata_path = metadata.workspace_root.as_std_path();
let cargo_toml_path = metadata_path.join("Cargo.toml");
let metadata = cargo_toml::Manifest::from_path(&cargo_toml_path)?;
let Some(workspace) = &metadata.workspace else { return Ok(()) };
let workspace_deps = workspace.dependencies.keys().cloned().collect::<HashSet<String>>();
let unused_deps = workspace_deps.difference(all_pkg_deps).cloned().collect::<Vec<_>>();
if unused_deps.is_empty() {
return Ok(());
}
println!("root: {unused_deps:?}");
self.try_fix_package(&cargo_toml_path, &unused_deps)?;
self.unused_dependencies.fetch_add(unused_deps.len(), Ordering::SeqCst);
Ok(())
}
/// Returns the remaining dependencies and number of unused dependencies.
fn shear_package(&self, workspace_root: &Path, package: &Package) -> Result<Deps> {
let dir = package
.manifest_path
.parent()
.unwrap_or_else(|| panic!("failed to get parent path {}", &package.manifest_path))
.as_std_path();
let dependency_names =
package.dependencies.iter().map(Self::dependency_name).collect::<Deps>();
let package_deps_map = dependency_names
.iter()
.map(|dep_name| {
// change `package-name` and `Package_name` to `package_name`
let mod_name = dep_name.clone().replace('-', "_").to_lowercase();
(mod_name, dep_name.clone())
})
.collect::<HashMap<String, String>>();
let ignored_names = package
.metadata
.as_object()
.and_then(|object| object.get("cargo-shear").and_then(|object| object.get("ignored")))
.and_then(|ignored| {
ignored.as_array().map(|ignored| {
ignored.iter().filter_map(|item| item.as_str()).collect::<HashSet<_>>()
})
})
.unwrap_or_default();
let mod_names = package_deps_map
.keys()
.filter(|name| !ignored_names.contains(name.as_str()))
.cloned()
.collect::<HashSet<_>>();
let rust_file_deps = Self::get_package_dependencies_from_rust_files(package)?;
let unused_deps = mod_names.difference(&rust_file_deps).collect::<Vec<_>>();
if unused_deps.is_empty() {
return Ok(dependency_names);
}
let unused_dep_names =
unused_deps.into_iter().map(|name| package_deps_map[name].clone()).collect::<Vec<_>>();
self.try_fix_package(package.manifest_path.as_std_path(), &unused_dep_names)?;
let path = dir.strip_prefix(workspace_root).unwrap_or(dir);
println!("{path:?}: {unused_dep_names:?}");
self.unused_dependencies.fetch_add(unused_dep_names.len(), Ordering::SeqCst);
let dependency_names = dependency_names
.difference(&HashSet::from_iter(unused_dep_names))
.cloned()
.collect::<Deps>();
Ok(dependency_names)
}
fn get_package_dependencies_from_rust_files(package: &Package) -> Result<Deps> {
Ok(Self::get_package_rust_files(package)
.par_iter()
.map(|path| Self::process_rust_source(path))
.collect::<Result<Vec<Deps>>>()?
.into_iter()
.fold(HashSet::new(), |a, b| a.union(&b).cloned().collect()))
}
fn get_package_rust_files(package: &Package) -> Vec<PathBuf> {
package
.targets
.iter()
.flat_map(|target| {
if target.kind.iter().any(|s| s == "custom-build") {
vec![target.src_path.clone().into_std_path_buf()]
} else {
let target_dir = target.src_path.parent().unwrap_or_else(|| {
panic!("failed to get parentp path {}", &target.src_path)
});
WalkDir::new(target_dir)
.into_iter()
.filter_map(Result::ok)
.filter(|e| e.path().extension().is_some_and(|ext| ext == "rs"))
.map(DirEntry::into_path)
.collect::<Vec<_>>()
}
})
.collect()
}
fn dependency_name(dependency: &Dependency) -> String {
dependency.rename.as_ref().unwrap_or(&dependency.name).clone()
}
fn process_rust_source(path: &Path) -> Result<Deps> {
let source_text = fs::read_to_string(path)?;
let imports = collect_imports(&source_text)?;
Ok(imports)
}
fn try_fix_package(&self, cargo_toml_path: &Path, unused_dep_names: &[String]) -> Result<()> {
if !self.options.fix {
return Ok(());
}
let manifest = fs::read_to_string(cargo_toml_path)?;
let mut manifest = toml_edit::DocumentMut::from_str(&manifest)?;
// Try `[workspace.dependencies]`
if let Some(dependencies) = manifest
.get_mut("workspace")
.and_then(|item| item.as_table_mut())
.and_then(|table| table.get_mut("dependencies"))
.and_then(|item| item.as_table_mut())
{
for k in unused_dep_names {
dependencies.remove(k);
}
}
// Try `[dependencies]`, `[dev-dependencies]`, `[build-dependencies]`
for table_name in ["dependencies", "dev-dependencies", "build-dependencies"] {
if let Some(dependencies) =
manifest.get_mut(table_name).and_then(|item| item.as_table_mut())
{
for k in unused_dep_names {
dependencies.remove(k);
}
}
}
let serialized = manifest.to_string();
fs::write(cargo_toml_path, serialized)?;
Ok(())
}
}