mirror of
https://seed.radicle.dev/rad:z6cFWeWpnZNHh9rUW8phgA3b5yGt.git
synced 2026-11-04 02:40:53 +08:00
Fintan Halpenny
42093a2fe1
The current `error::Error` type aggregated a lot of different error scenarios that were not for the actual repo actions, instead they would be for the domains that the repo actions would return. This is a reorganisation of those by localising error variants in their modules: * namespace::Error * commit::Error * glob::Error * adding `type Error` to ToCommit * adding `type Error` to Revision The main Error type now consists of these other Error types and lives in the `repo` module. It is re-exported at the top-level since RepositoryRef is the main interaction with the library. During this refactor, some reorganisation of functions was done as well: * Move `get_file` from `Commit` to `RepositoryRef` as `get_commit_file`. * Have a blanket implementation of `ToCommit` for any `Revision`, instead of repeating the implementations. Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
radicle-surf
A code surfing library for VCS file systems 🏄♀️🏄♂️
Welcome to radicle-surf!
radicle-surf is a system to describe a file-system in a VCS world.
We have the concept of files and directories, but these objects can change over time while people iterate on them.
Thus, it is a file-system within history and we, the user, are viewing the file-system at a particular snapshot.
Alongside this, we will wish to take two snapshots and view their differences.
Contributing
To get started on contributing you can check out our developing guide, and also our LICENSE file.
The Community
Join our community disccussions at radicle.community!
Example
To a taste for the capabilities of radicle-surf we provide an example below, but we also
keep our documentation and doc-tests up to date.
use radicle_surf::vcs::git;
use radicle_surf::file_system::{Label, Path, SystemType};
use radicle_surf::file_system::unsound;
use pretty_assertions::assert_eq;
use std::str::FromStr;
// We're going to point to this repo.
let repo = git::Repository::new("./data/git-platinum")?;
// Here we initialise a new Broswer for a the git repo.
let mut browser = git::Browser::new(&repo, "master")?;
// Set the history to a particular commit
let commit = git::Oid::from_str("80ded66281a4de2889cc07293a8f10947c6d57fe")?;
browser.commit(commit)?;
// Get the snapshot of the directory for our current HEAD of history.
let directory = browser.get_directory()?;
// Let's get a Path to the memory.rs file
let memory = unsound::path::new("src/memory.rs");
// And assert that we can find it!
assert!(directory.find_file(memory).is_some());
let root_contents = directory.list_directory();
assert_eq!(root_contents, vec![
SystemType::file(unsound::label::new(".i-am-well-hidden")),
SystemType::file(unsound::label::new(".i-too-am-hidden")),
SystemType::file(unsound::label::new("README.md")),
SystemType::directory(unsound::label::new("bin")),
SystemType::directory(unsound::label::new("src")),
SystemType::directory(unsound::label::new("text")),
SystemType::directory(unsound::label::new("this")),
]);
let src = directory
.find_directory(Path::new(unsound::label::new("src")))
.expect("failed to find src");
let src_contents = src.list_directory();
assert_eq!(src_contents, vec![
SystemType::file(unsound::label::new("Eval.hs")),
SystemType::file(unsound::label::new("Folder.svelte")),
SystemType::file(unsound::label::new("memory.rs")),
]);