Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ksxgithub/build-fs-tree
Generate a filesystem tree from a macro or a YAML tree
https://github.com/ksxgithub/build-fs-tree
binary crate filesystem json library rust serde tree
Last synced: 9 days ago
JSON representation
Generate a filesystem tree from a macro or a YAML tree
- Host: GitHub
- URL: https://github.com/ksxgithub/build-fs-tree
- Owner: KSXGitHub
- License: mit
- Created: 2021-04-08T07:02:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T03:27:11.000Z (2 months ago)
- Last Synced: 2024-10-30T01:56:04.806Z (10 days ago)
- Topics: binary, crate, filesystem, json, library, rust, serde, tree
- Language: Rust
- Homepage: https://crates.io/crates/build-fs-tree
- Size: 395 KB
- Stars: 23
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# build-fs-tree
[](https://github.com/KSXGitHub/build-fs-tree/actions?query=workflow%3ATest)
[](https://crates.io/crates/build-fs-tree)
Generate a filesystem tree from a macro or a YAML tree.
## Description
When I write integration tests, I often find myself needing to create temporary files and directories. Therefore, I created this crate which provides both a library to use in a Rust code and a CLI program that generates a filesystem tree according to a YAML structure.
## Usage Examples
### The Library
Go to [docs.rs](https://docs.rs/build-fs-tree/) for the full API reference.
#### `FileSystemTree`
`FileSystemTree::build` is faster than `MergeableFileSystemTree::build` but it does not write over an existing directory and it does not create parent directories when they don't exist.
```rust
use build_fs_tree::{FileSystemTree, Build, dir, file};
let tree: FileSystemTree<&str, &str> = dir! {
"index.html" => file!(r#"
"#)
"scripts" => dir! {
"main.js" => file!(r#"document.write('Hello World')"#)
}
"styles" => dir! {
"style.css" => file!(r#":root { color: red; }"#)
}
};
tree.build("public").unwrap();
```
#### `MergeableFileSystemTree`
Unlike `FileSystemTree::build`, `MergeableFileSystemTree::build` can write over an existing directory and create parent directories that were not exist before at the cost of performance.
You can convert a `FileSystemTree` into a `MergeableFileSystemTree` via `From::from`/`Into::into` and vice versa.
```rust
use build_fs_tree::{MergeableFileSystemTree, Build, dir, file};
let tree = MergeableFileSystemTree::<&str, &str>::from(dir! {
"public" => dir! {
"index.html" => file!(r#"
"#)
"scripts/main.js" => file!(r#"document.write('Hello World')"#)
"scripts/style.css" => file!(r#":root { color: red; }"#)
}
});
tree.build(".").unwrap();
```
#### Serialization and Deserialization
Both `FileSystemTree` and `MergeableFileSystemTree` implement `serde::Deserialize` and `serde::Serialize`.
### The Program
The name of the command is `build-fs-tree`. It has 2 subcommands: [`create`](#create) and [`populate`](#populate).
#### `create`
This command reads YAML from stdin and creates a new filesystem tree. It is the CLI equivalent of [`FileSystemTree`](#filesystemtree).
_Create two text files in a new directory:_
```sh
echo '{ foo.txt: HELLO, bar.txt: WORLD }' | build-fs-tree create foo-and-bar
```
_Create a text file and its parent directories:_
```sh
echo '{ text-files: { foo.txt: HELLO } }' | build-fs-tree create files
```
_Create a new filesystem tree from a YAML file:_
```sh
build-fs-tree create root < fs-tree.yaml
```
#### `populate`
This command reads YAML from stdin and either creates a new filesystem tree or add files and directories to an already existing directories. It is the CLI equivalent of [`MergeableFileSystemTree`](#mergeablefilesystemtree).
_Create two text files in the current directory:_
```sh
echo '{ foo.txt: HELLO, bar.txt: WORLD }' | build-fs-tree populate .
```
_Create a text file and its parent directories:_
```sh
echo '{ files/text-files/foo.txt: HELLO }' | build-fs-tree populate .
```
_Populate the current directory with filesystem tree as described in a YAML file:_
```sh
build-fs-tree populate . < fs-tree.yaml
```
## Packaging Status
[](https://repology.org/project/build-fs-tree/versions)
## Frequently Asked Questions
### Why YAML?
It has the features I desired: Easy to read and write, multiline strings done right.
### What about this cool configuration format?
According to the UNIX philosophy, you may pipe your cool configuration format to a program that converts it to JSON (YAML is a superset of JSON) and then pipe the JSON output to `build-fs-tree`.
## License
[MIT](https://git.io/JOkew) © [Hoàng Văn Khải](https://ksxgithub.github.io/).