refactor: move ark-cli folders inside a crate

Signed-off-by: Tarek <[email protected]>
tareknaser · Mar 12, 2024 · 0d22f55 · 0d22f55
1 parent 83a57b6
commit 0d22f55
Show file tree

Hide file tree

Showing 20 changed files with 687 additions and 124 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,6 @@
 [workspace]
 members = [
+    "ark-cli",
     "data-error",
     "data-json",
     "data-link",
@@ -12,6 +13,7 @@ members = [
 ]
 
 default-members = [
+    "ark-cli",
     "data-error",
     "data-json",
     "data-link",

diff --git a/README.md b/README.md
@@ -14,6 +14,7 @@ The purpose of the library is to manage _resource index_ of folders with various
 
 | Package         | Description                              |
 | --------------- | ---------------------------------------- |
+| `ark-cli`       | The CLI tool to interact with ark crates |
 | `data-resource` | Resource hashing and ID construction     |
 | `fs-index`      | Resource Index construction and updating |
 | `fs-storage`    | Filesystem storage for resources         |
@@ -67,120 +68,3 @@ Our benchmark suite includes tests on local files and directories. These benchma
 You have the flexibility to benchmark specific files or folders by modifying the variables within the benchmark files. By default, the benchmarks operate on the [`test-assets/`](test-assets/) directory and its contents. You can change the directory/files by setting the `DIR_PATH` and `FILE_PATHS` variables to the desired values.
 
 For pre-benchmark assessment of required time to index a huge local folder, you can modify `test_build_resource_index` test case in `src/index.rs`.
-
-# Ark-CLI
-
-### Installation
-
-To compile you will need openssl libraries and headers:
-
-```shell
-# macOS (Homebrew)
-$ brew install openssl@3
-
-# macOS (MacPorts)
-$ sudo port install openssl
-
-# macOS (pkgsrc)
-$ sudo pkgin install openssl
-
-# Arch Linux
-$ sudo pacman -S pkg-config openssl
-
-# Debian and Ubuntu
-$ sudo apt-get install pkg-config libssl-dev
-
-# Fedora
-$ sudo dnf install pkg-config perl-FindBin openssl-devel
-
-# Alpine Linux
-$ apk add pkgconfig openssl-dev
-```
-
-### Usage
-
-```shell
-ark-cli <SUBCOMMAND>
-
-OPTIONS:
-    -h, --help    Print help information
-
-SUBCOMMANDS:
-    backup
-    collisions
-    help          Print this message or the help of the given subcommand(s)
-    link
-    monitor
-    render
-
-```
-
-#### Backup
-
-```shell
-USAGE:
-    ark-cli backup [ROOTS_CFG]
-
-ARGS:
-    <ROOTS_CFG>
-
-OPTIONS:
-    -h, --help    Print help information
-```
-
-#### Collisions
-
-```shell
-USAGE:
-    ark-cli collisions [ROOT_DIR]
-
-ARGS:
-    <ROOT_DIR>
-
-OPTIONS:
-    -h, --help    Print help information
-```
-
-#### Link
-
-```shell
-USAGE:
-    ark-cli link <SUBCOMMAND>
-
-OPTIONS:
-    -h, --help    Print help information
-
-SUBCOMMANDS:
-    create
-    help      Print this message or the help of the given subcommand(s)
-    load
-```
-
-#### Monitor
-
-```shell
-USAGE:
-    ark-cli monitor [ARGS]
-
-ARGS:
-    <ROOT_DIR>
-    <INTERVAL>
-
-OPTIONS:
-    -h, --help    Print help information
-```
-
-#### Render
-
-```shell
-USAGE:
-    ark-cli render [ARGS]
-
-ARGS:
-    <PATH>
-    <QUALITY>
-
-OPTIONS:
-    -h, --help    Print help information
-
-```
diff --git a/ark-cli/Cargo.toml b/ark-cli/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "ark-cli"
+version = "0.1.0"
+edition = "2021"
+
+[[bin]]
+name = "ark-cli"
+
+[dependencies]
+tokio = { version = "1.35.1", features = ["full"] }
+arklib = { git = "https://github.com/ARK-Builders/arklib", rev = "2c7ceda" }
+clap = { version = "3.0.10", features = ["derive"] }
+env_logger = "0.9.0"
+fs_extra = "1.2.0"
+walkdir = "2.3.2"
+home = "0.5.3"
+url = { version = "2.2.2", features = ["serde"] }
+serde_json = "1.0.82"
+serde = { version = "1.0.138", features = ["derive"] }
+chrono = "0.4.34"
+anyhow = "1.0.80"
+thiserror = "1.0.57"
diff --git a/ark-cli/README.md b/ark-cli/README.md
@@ -0,0 +1,111 @@
+# Ark-CLI
+
+### Installation
+
+To compile you will need openssl libraries and headers:
+
+```shell
+# macOS (Homebrew)
+$ brew install openssl@3
+
+# macOS (MacPorts)
+$ sudo port install openssl
+
+# macOS (pkgsrc)
+$ sudo pkgin install openssl
+
+# Arch Linux
+$ sudo pacman -S pkg-config openssl
+
+# Debian and Ubuntu
+$ sudo apt-get install pkg-config libssl-dev
+
+# Fedora
+$ sudo dnf install pkg-config perl-FindBin openssl-devel
+
+# Alpine Linux
+$ apk add pkgconfig openssl-dev
+```
+
+### Usage
+
+```shell
+ark-cli <SUBCOMMAND>
+
+OPTIONS:
+    -h, --help    Print help information
+
+SUBCOMMANDS:
+    backup        
+    collisions    
+    help          Print this message or the help of the given subcommand(s)
+    link          
+    monitor       
+    render        
+
+```
+
+#### Backup
+```shell
+USAGE:
+    ark-cli backup [ROOTS_CFG]
+
+ARGS:
+    <ROOTS_CFG>    
+
+OPTIONS:
+    -h, --help    Print help information
+```
+
+#### Collisions
+```shell
+USAGE:
+    ark-cli collisions [ROOT_DIR]
+
+ARGS:
+    <ROOT_DIR>    
+
+OPTIONS:
+    -h, --help    Print help information
+```
+
+#### Link
+```shell
+USAGE:
+    ark-cli link <SUBCOMMAND>
+
+OPTIONS:
+    -h, --help    Print help information
+
+SUBCOMMANDS:
+    create    
+    help      Print this message or the help of the given subcommand(s)
+    load
+```
+
+#### Monitor
+```shell
+USAGE:
+    ark-cli monitor [ARGS]
+
+ARGS:
+    <ROOT_DIR>    
+    <INTERVAL>    
+
+OPTIONS:
+    -h, --help    Print help information
+```
+
+#### Render
+```shell
+USAGE:
+    ark-cli render [ARGS]
+
+ARGS:
+    <PATH>       
+    <QUALITY>    
+
+OPTIONS:
+    -h, --help    Print help information
+
+```
diff --git a/USAGE.md → ark-cli/USAGE.md b/USAGE.md → ark-cli/USAGE.md
diff --git a/ark-shelf/16-720383087 → ark-cli/ark-shelf/16-720383087 b/ark-shelf/16-720383087 → ark-cli/ark-shelf/16-720383087
diff --git a/ark-shelf/18-1909444406 → ark-cli/ark-shelf/18-1909444406 b/ark-shelf/18-1909444406 → ark-cli/ark-shelf/18-1909444406
diff --git a/src/commands/file.rs → ark-cli/src/commands/file.rs b/src/commands/file.rs → ark-cli/src/commands/file.rs
diff --git a/src/commands/link.rs → ark-cli/src/commands/link.rs b/src/commands/link.rs → ark-cli/src/commands/link.rs
diff --git a/src/commands/mod.rs → ark-cli/src/commands/mod.rs b/src/commands/mod.rs → ark-cli/src/commands/mod.rs
diff --git a/src/error.rs → ark-cli/src/error.rs b/src/error.rs → ark-cli/src/error.rs
diff --git a/src/main.rs → ark-cli/src/main.rs b/src/main.rs → ark-cli/src/main.rs
diff --git a/src/models/cli.rs → ark-cli/src/models/cli.rs b/src/models/cli.rs → ark-cli/src/models/cli.rs
diff --git a/src/models/entry.rs → ark-cli/src/models/entry.rs b/src/models/entry.rs → ark-cli/src/models/entry.rs
diff --git a/src/models/format.rs → ark-cli/src/models/format.rs b/src/models/format.rs → ark-cli/src/models/format.rs
diff --git a/src/models/mod.rs → ark-cli/src/models/mod.rs b/src/models/mod.rs → ark-cli/src/models/mod.rs
diff --git a/src/models/sort.rs → ark-cli/src/models/sort.rs b/src/models/sort.rs → ark-cli/src/models/sort.rs
diff --git a/src/models/storage.rs → ark-cli/src/models/storage.rs b/src/models/storage.rs → ark-cli/src/models/storage.rs
diff --git a/src/util.rs → ark-cli/src/util.rs b/src/util.rs → ark-cli/src/util.rs