chore: cleanup API

Author: cachebag

Cargo.lock

@@ -4,9 +4,11 @@ resolver = "3"
 
 [workspace.package]
 edition = "2024"
-rust-version = "1.93"
-license = "MIT, APACHE-2.0"
+rust-version = "1.94"
+license = "MIT OR Apache-2.0"
+authors = ["Akrm Al-Hakimi <alhakimiakrmj@gmail.com>"]
 repository = "https://github.com/cachebag/unrot"
+homepage = "https://github.com/cachebag/unrot"
 
 [profile.bench]
 debug = true

Cargo.toml

@@ -1,12 +1,21 @@
 [package]
-name = "unrot_cli"
+name = "unrot"
 version = "0.1.0"
-edition = "2024"
+description = "Find and interactively repair broken symlinks with fuzzy matching"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+repository.workspace = true
+homepage.workspace = true
+documentation = "https://github.com/cachebag/unrot"
+keywords = ["symlink", "broken-symlink", "fuzzy-matching", "filesystem", "cli"]
+categories = ["command-line-utilities", "filesystem"]
 
 [[bin]]
 name = "unrot"
 path = "src/main.rs"
 
 [dependencies]
 clap = { version = "4.6.0", features = ["derive"] }
-unrot_core = { path = "../core" }
+unrot_core = { version = "0.1.0", path = "../core" }

cli/Cargo.toml

@@ -1,7 +1,16 @@
 [package]
 name = "unrot_core"
 version = "0.1.0"
-edition = "2024"
+description = "Core library for unrot — find and repair broken symlinks with fuzzy matching"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+repository.workspace = true
+homepage.workspace = true
+documentation = "https://docs.rs/unrot_core"
+keywords = ["symlink", "broken-symlink", "fuzzy-matching", "filesystem"]
+categories = ["command-line-utilities", "filesystem"]
 
 [dependencies]
 walkdir = "2.5.0"

core/Cargo.toml

@@ -8,7 +8,7 @@ use crate::scanner::BrokenSymlink;
 //
 // We could easily use a library for this, but it's trivial
 // enough in our case to where it's not worth the dependency here.
-pub fn levenshtein(a: &str, b: &str) -> usize {
+pub(crate) fn levenshtein(a: &str, b: &str) -> usize {
     let a: Vec<char> = a.chars().collect();
     let b: Vec<char> = b.chars().collect();
     let (m, n) = (a.len(), b.len());
@@ -46,7 +46,7 @@ fn dir_components(path: &Path) -> Vec<String> {
         .collect()
 }
 
-pub fn score_candidate(broken: &BrokenSymlink, candidate: &Path, search_root: &Path) -> f64 {
+fn score_candidate(broken: &BrokenSymlink, candidate: &Path, search_root: &Path) -> f64 {
     let target_name = broken
         .target
         .file_name()

core/src/fuzzy.rs

@@ -2,6 +2,6 @@ pub mod fuzzy;
 pub mod resolver;
 pub mod scanner;
 
-pub use fuzzy::{DEFAULT_IGNORE, ScoredCandidate, find_candidates};
-pub use resolver::{Action, RepairCase, Resolution, Summary, TerminalIO, run};
+pub use fuzzy::{find_candidates, ScoredCandidate, DEFAULT_IGNORE};
+pub use resolver::{run, Action, RepairCase, ResolverIO, Summary, TerminalIO};
 pub use scanner::{BrokenSymlink, find_broken_symlinks};

core/src/lib.rs

@@ -1,17 +1,13 @@
-pub mod action;
-pub mod confirm;
-pub mod display;
-pub mod fs_ops;
-pub mod input;
+pub(crate) mod action;
+pub(crate) mod confirm;
+pub(crate) mod display;
+pub(crate) mod fs_ops;
+pub(crate) mod input;
 pub mod io;
 pub mod model;
-pub mod session;
+pub(crate) mod session;
 
-pub use action::{Resolved, resolve, resolve_custom};
-pub use confirm::{format_confirmation, needs_confirmation, parse_confirmation};
-pub use display::{format_actions, format_candidates, format_header, present};
-pub use fs_ops::{FsError, execute};
-pub use input::{ParseError, ParsedInput, parse_choice};
+pub use display::present;
 pub use io::{ResolverIO, TerminalIO};
-pub use model::{Action, RepairCase, Resolution, Summary};
+pub use model::{Action, RepairCase, Summary};
 pub use session::run;

core/src/resolver/mod.rs

@@ -53,11 +53,6 @@ pub enum Action {
     Skip,
 }
 
-pub struct Resolution {
-    pub link: PathBuf,
-    pub action: Action,
-}
-
 #[derive(Debug, Default)]
 pub struct Summary {
     pub relinked: usize,
@@ -125,16 +120,6 @@ mod tests {
         assert!(case.has_candidates());
     }
 
-    #[test]
-    fn resolution_pairs_link_with_action() {
-        let Resolution { link, action } = Resolution {
-            link: "/some/link".into(),
-            action: Action::Remove,
-        };
-        assert_eq!(link, PathBuf::from("/some/link"));
-        assert_eq!(action, Action::Remove);
-    }
-
     #[test]
     fn action_equality() {
         assert_eq!(Action::Relink("/a".into()), Action::Relink("/a".into()));