chore(dir-structure): move tools and utils behind default feature flags, making the core crate small

dnbln · dnbln · commit 4f39056271de · 2025-09-16T00:07:32.000+02:00
diff --git a/.github/workflows/test-dir-structure.yml b/.github/workflows/test-dir-structure.yml
@@ -46,6 +46,7 @@ jobs:
             "--no-default-features --features ron",
             "--no-default-features --features include_dir",
             "--no-default-features --features derive",
+            "--no-default-features --features tools",
             "--features assert_eq",
             "--features assert_eq,git",
             "--features assert_eq,async",
diff --git a/doc/docs/content/docs/dx/dir-structure/.guide.mdx.doctests b/doc/docs/content/docs/dx/dir-structure/.guide.mdx.doctests
@@ -110,8 +110,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-fmt-wrapper", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-fmt-wrapper", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/DirStructure/] DirStructure
@@ -159,8 +159,8 @@
 ///  />
 /// 
 /// 
-#[cfg_attr(all(feature = "json", feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "json", feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "json", feature = "tools-fmt-wrapper", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "json", feature = "tools-fmt-wrapper", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/DirStructure/] DirStructure
@@ -315,8 +315,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-dir-children", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-dir-children", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/DirStructure/] DirStructure
@@ -374,8 +374,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-dir-children", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-dir-children", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// use std::path::Path;
@@ -446,8 +446,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-dir-children", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-dir-children", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/ext_filter/] ext_filter
@@ -506,8 +506,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-deferred-read", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-deferred-read", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/ext_filter/] ext_filter
@@ -581,8 +581,8 @@
 /// `}
 /// />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-deferred-read-or-own", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-deferred-read-or-own", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/ext_filter/] ext_filter
@@ -664,8 +664,8 @@
 /// `}
 ///  />
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-dir-children", feature = "tools-deferred-read-or-own", feature = "tools-versioned", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-dir-children", feature = "tools-deferred-read-or-own", feature = "tools-versioned", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/ext_filter/] ext_filter
@@ -753,8 +753,8 @@
 ///  />
 /// 
 /// 
-#[cfg_attr(all(feature = "derive", ), doc = r#"```rust,no_run"#)]
-#[cfg_attr(not(all(feature = "derive", )), doc = r#"```rust,compile_fail"#)]
+#[cfg_attr(all(feature = "derive", feature = "tools-dir-children", feature = "tools-deferred-read-or-own", feature = "tools-versioned", ), doc = r#"```rust,no_run"#)]
+#[cfg_attr(not(all(feature = "derive", feature = "tools-dir-children", feature = "tools-deferred-read-or-own", feature = "tools-versioned", )), doc = r#"```rust,compile_fail"#)]
 /// #![deny(unused_imports)]
 /// 
 /// // !tooltip[/ext_filter/] ext_filter
@@ -837,22 +837,5 @@
 /// 
 /// 
 /// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
-/// 
 /// </ScrollyCoding>
 struct Guide;
diff --git a/doc/docs/content/docs/dx/dir-structure/guide.mdx b/doc/docs/content/docs/dx/dir-structure/guide.mdx
@@ -110,6 +110,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-fmt-wrapper
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
@@ -157,8 +158,9 @@ mindmap
 
 
 ```rust ! usage.rs no_run
-// !req-feature json
 // !req-feature derive
+// !req-feature json
+// !req-feature tools-fmt-wrapper
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
@@ -312,6 +314,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
@@ -370,6 +373,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 use std::path::Path;
 // !tooltip[/DirStructure/] DirStructure
@@ -441,6 +445,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
@@ -500,6 +505,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-deferred-read
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
@@ -574,6 +580,7 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-deferred-read-or-own
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
@@ -656,6 +663,9 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-dir-children
+// !req-feature tools-deferred-read-or-own
+// !req-feature tools-versioned
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
@@ -744,6 +754,9 @@ mindmap
 
 ```rust ! usage.rs no_run
 // !req-feature derive
+// !req-feature tools-dir-children
+// !req-feature tools-deferred-read-or-own
+// !req-feature tools-versioned
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/doc/guides/dx/dir-structure/guide/steps/complex-data-types/code.rs b/doc/guides/dx/dir-structure/guide/steps/complex-data-types/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-fmt-wrapper
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
diff --git a/doc/guides/dx/dir-structure/guide/steps/deferred-read-or-own/code.rs b/doc/guides/dx/dir-structure/guide/steps/deferred-read-or-own/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-deferred-read-or-own
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/doc/guides/dx/dir-structure/guide/steps/deferred-read/code.rs b/doc/guides/dx/dir-structure/guide/steps/deferred-read/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-deferred-read
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/doc/guides/dx/dir-structure/guide/steps/even-more-complex-structures/code.rs b/doc/guides/dx/dir-structure/guide/steps/even-more-complex-structures/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
diff --git a/doc/guides/dx/dir-structure/guide/steps/extension-only-filters/code.rs b/doc/guides/dx/dir-structure/guide/steps/extension-only-filters/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/doc/guides/dx/dir-structure/guide/steps/filter-subdirs/code.rs b/doc/guides/dx/dir-structure/guide/steps/filter-subdirs/code.rs
@@ -1,4 +1,5 @@
 // !req-feature derive
+// !req-feature tools-dir-children
 // !lints
 use std::path::Path;
 // !tooltip[/DirStructure/] DirStructure
diff --git a/doc/guides/dx/dir-structure/guide/steps/serde-types/code.rs b/doc/guides/dx/dir-structure/guide/steps/serde-types/code.rs
@@ -1,5 +1,6 @@
-// !req-feature json
 // !req-feature derive
+// !req-feature json
+// !req-feature tools-fmt-wrapper
 // !lints
 // !tooltip[/DirStructure/] DirStructure
 // !tooltip[/DirStructureItem/] DirStructureItem
diff --git a/doc/guides/dx/dir-structure/guide/steps/versioned-changed/code.rs b/doc/guides/dx/dir-structure/guide/steps/versioned-changed/code.rs
@@ -1,4 +1,7 @@
 // !req-feature derive
+// !req-feature tools-dir-children
+// !req-feature tools-deferred-read-or-own
+// !req-feature tools-versioned
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/doc/guides/dx/dir-structure/guide/steps/versioned/code.rs b/doc/guides/dx/dir-structure/guide/steps/versioned/code.rs
@@ -1,4 +1,7 @@
 // !req-feature derive
+// !req-feature tools-dir-children
+// !req-feature tools-deferred-read-or-own
+// !req-feature tools-versioned
 // !lints
 // !tooltip[/ext_filter/] ext_filter
 use dir_structure::ext_filter;
diff --git a/src/dev/dir-structure/Cargo.toml b/src/dev/dir-structure/Cargo.toml
@@ -13,7 +13,10 @@ rustdoc-args = ["--cfg", "docsrs"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
-default = ["derive"]
+default = [
+    "derive",
+    "tools",
+]
 json = ["dep:serde", "dep:serde_json"]
 toml = ["dep:serde", "dep:toml"]
 yaml = ["dep:serde", "dep:serde_yaml"]
@@ -22,7 +25,10 @@ async = ["dep:pin-project", "dep:futures", "dir-structure-macros/async"]
 tokio = ["dep:tokio", "async"]
 include_dir = ["dep:include_dir"]
 git = ["dep:git2"]
-resolve-path = ["dir-structure-macros/resolve-path"]
+resolve-path = ["derive", "dir-structure-macros/resolve-path"]
+assert_eq = ["dep:assert_eq"]
+derive = ["dep:dir-structure-macros"]
+
 image = ["dep:image", "tokio/rt"]
 image-format-png = ["image", "image/png"]
 image-format-gif = ["image", "image/gif"]
@@ -38,8 +44,28 @@ image-format-pnm = ["image", "image/pnm"]
 image-format-ff = ["image", "image/ff"]
 image-format-avif = ["image", "image/avif"]
 image-format-qoi = ["image", "image/qoi"]
-assert_eq = ["dep:assert_eq"]
-derive = ["dep:dir-structure-macros"]
+
+tools-clean-dir = []
+tools-deferred-read = []
+tools-deferred-read-or-own = []
+tools-dir-children = []
+tools-dir-descendants = []
+tools-fmt-wrapper = []
+tools-try-parse = []
+tools-versioned = []
+tools-versioned-hash = []
+tools = [
+    "tools-clean-dir",
+    "tools-deferred-read",
+    "tools-deferred-read-or-own",
+    "tools-dir-children",
+    "tools-dir-descendants",
+    "tools-fmt-wrapper",
+    "tools-try-parse",
+    "tools-versioned",
+    "tools-versioned-hash",
+]
+
 _all = [
     "json",
     "toml",
@@ -50,6 +76,8 @@ _all = [
     "include_dir",
     "git",
     "resolve-path",
+    "assert_eq",
+    "derive",
     "image",
     "image-format-png",
     "image-format-gif",
@@ -65,8 +93,7 @@ _all = [
     "image-format-ff",
     "image-format-avif",
     "image-format-qoi",
-    "assert_eq",
-    "derive",
+    "tools",
 ]
 
 [dev-dependencies]
@@ -103,12 +130,12 @@ git2 = { workspace = true, optional = true }
 [[test]]
 name = "async_tests"
 path = "tests/async_tests.rs"
-required-features = ["async", "tokio", "assert_eq", "derive"]
+required-features = ["async", "tokio", "assert_eq", "derive", "tools"]
 
 [[test]]
 name = "tests"
 path = "tests/tests.rs"
-required-features = ["assert_eq", "derive"]
+required-features = ["assert_eq", "derive", "tools"]
 
 [[example]]
 name = "reading_from_include_dir_vfs"
@@ -118,7 +145,7 @@ required-features = ["include_dir", "derive"]
 [[example]]
 name = "reading_dir_children_from_include_dir_vfs"
 path = "examples/reading_dir_children_from_include_dir_vfs.rs"
-required-features = ["include_dir", "derive"]
+required-features = ["include_dir", "derive", "tools-dir-children"]
 
 [[example]]
 name = "reading_from_git_vfs"
@@ -153,7 +180,7 @@ required-features = ["derive"]
 [[example]]
 name = "deferred_read"
 path = "examples/deferred_read.rs"
-required-features = ["derive"]
+required-features = ["derive", "tools-deferred-read"]
 
 [[example]]
 name = "reading"
@@ -168,12 +195,12 @@ required-features = ["derive"]
 [[example]]
 name = "reading_dir_children"
 path = "examples/reading_dir_children.rs"
-required-features = ["derive"]
+required-features = ["derive", "tools-dir-children"]
 
 [[example]]
 name = "writing_dir_children"
 path = "examples/writing_dir_children.rs"
-required-features = ["derive"]
+required-features = ["derive", "tools-dir-children"]
 
 [lints]
 workspace = true
diff --git a/src/dev/dir-structure/src/lib.rs b/src/dev/dir-structure/src/lib.rs
diff --git a/src/dev/narxia-workspace/Cargo.toml b/src/dev/narxia-workspace/Cargo.toml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`// !req-feature derive`
	`2`	`+// !req-feature tools-fmt-wrapper`
`2`	`3`	`// !lints`
`3`	`4`	`// !tooltip[/DirStructure/] DirStructure`
`4`	`5`	`// !tooltip[/DirStructureItem/] DirStructureItem`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`// !req-feature derive`
	`2`	`+// !req-feature tools-deferred-read-or-own`
`2`	`3`	`// !lints`
`3`	`4`	`// !tooltip[/ext_filter/] ext_filter`
`4`	`5`	`use dir_structure::ext_filter;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`// !req-feature derive`
	`2`	`+// !req-feature tools-deferred-read`
`2`	`3`	`// !lints`
`3`	`4`	`// !tooltip[/ext_filter/] ext_filter`
`4`	`5`	`use dir_structure::ext_filter;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`// !req-feature derive`
	`2`	`+// !req-feature tools-dir-children`
`2`	`3`	`// !lints`
`3`	`4`	`// !tooltip[/DirStructure/] DirStructure`
`4`	`5`	`// !tooltip[/DirStructureItem/] DirStructureItem`