initial version of the gix-dir crate

Byron · Byron · commit 74fcbe317652 · 2023-12-20T10:54:01.000+01:00
It's main purpose is to hold the traversal algorithm which is used
to determine which files are tracked, untracked, ignored or precious.

It's also automatically ignoring anything called '.git'.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -239,6 +239,7 @@ members = [
     "gix-diff",
     "gix-date",
     "gix-traverse",
+    "gix-dir",
     "gix-index",
     "gix-bitmap",
     "gix-worktree",
diff --git a/README.md b/README.md
@@ -133,6 +133,7 @@ is usable to some extent.
   * `gitoxide-core`
 * **very early**  _(possibly without any documentation and many rough edges)_
   * [gix-date](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-date)
+  * [gix-dir](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-dir)
 * **idea** _(just a name placeholder)_
   * [gix-note](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-note)
   * [gix-fetchhead](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-fetchhead)
diff --git a/crate-status.md b/crate-status.md
@@ -608,6 +608,18 @@ A plumbing crate with shared functionality regarding EWAH compressed bitmaps, as
   * [x] decode on-disk representation
   * [ ] encode on-disk representation
 
+### gix-dir
+
+A git directory walk.
+
+* [ ] list untracked files
+    - [ ] `normal` - files and directories
+    - [ ] `all` - expand to untracked files in untracked directories
+* [ ] list ignored files
+    - [ ] `matching` mode (show every ignored file, do not aggregate into parent directory)
+    - [ ] `traditional` mode (aggregate all ignored files of a folder into ignoring the folder itself)
+* [ ] accelerated walk with `untracked`-cache (as provided by `UNTR` extension of `gix_index::File`)
+
 ### gix-index
 
 The git staging area.
diff --git a/gix-dir/CHANGELOG.md b/gix-dir/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
diff --git a/gix-dir/Cargo.toml b/gix-dir/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+name = "gix-dir"
+version = "0.0.0"
+repository = "https://github.com/Byron/gitoxide"
+license = "MIT OR Apache-2.0"
+description = "A crate of the gitoxide project dealing with directory walks"
+authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
+edition = "2021"
+rust-version = "1.65"
+
+[lib]
+doctest = false
+
+[dependencies]
diff --git a/gix-dir/LICENSE-APACHE b/gix-dir/LICENSE-APACHE
@@ -0,0 +1 @@
+../LICENSE-APACHE
diff --git a/gix-dir/LICENSE-MIT b/gix-dir/LICENSE-MIT
@@ -0,0 +1 @@
+../LICENSE-MIT
diff --git a/gix-dir/src/lib.rs b/gix-dir/src/lib.rs
@@ -0,0 +1,3 @@
+//! A crate for handling a git-style directory walk.
+#![deny(rust_2018_idioms)]
+#![forbid(unsafe_code)]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+//! A crate for handling a git-style directory walk.`
	`2`	`+#![deny(rust_2018_idioms)]`
	`3`	`+#![forbid(unsafe_code)]`