Add cli checks (#3)

* add: cli checks and readme

.github/workflows/linters-cargo.yml

@@ -0,0 +1,23 @@
+---
+name: Task - Linters Cargo
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  cargo-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # selecting a toolchain either by action or manual `rustup` calls should happen
+      # before the plugin, as the cache uses the current rustc version as its cache key
+      - run: rustup show
+
+      - uses: Swatinem/rust-cache@v2
+      - name: Format and clippy
+        run: |
+          cargo fmt -- --check
+          cargo clippy --no-deps -- -D warnings
+          cargo clippy --tests --no-deps -- -D warnings

.github/workflows/linters.yml

@@ -0,0 +1,33 @@
+---
+name: Task - Linters
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run prettier
+        run: |-
+          npx prettier --check .
+
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: avto-dev/markdown-lint@v1
+        with:
+          config: "./.markdownlint.json"
+          args: "."
+          ignore: "./target"
+
+  toml-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout toml files
+        uses: actions/checkout@v3
+      - name: Run toml check
+        run: npx @taplo/cli fmt --config ./taplo.toml --check

.github/workflows/pull-request.yml

@@ -0,0 +1,23 @@
+---
+name: Workflow - Pull Request
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  linters:
+    name: Run linters
+    uses: ./.github/workflows/linters.yml
+
+  rust_build:
+    name: Build Rust project
+    uses: ./.github/workflows/rust-build.yml
+
+  linters_cargo:
+    name: Run Cargo linters
+    uses: ./.github/workflows/linters-cargo.yml
+    needs: rust_build

.github/workflows/rust-build.yml

@@ -0,0 +1,22 @@
+---
+name: Task - Build Rust
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  rust_build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # selecting a toolchain either by action or manual `rustup` calls should happen
+      # before the plugin, as the cache uses the current rustc version as its cache key
+      - run: rustup show
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Build the project
+        run: |
+          cargo build --release --workspace

.markdownlint.json

@@ -0,0 +1,10 @@
+{
+  "MD033": false,
+  "MD041": false,
+  "MD045": false,
+  "MD003": false,
+  "MD013": {
+    "code_blocks": false,
+    "line_length": 135
+  }
+}

Cargo.toml

@@ -12,13 +12,13 @@ path = "src/main.rs"
 [dependencies]
 clap = { version = "4.4.11", features = ["derive"] }
 dirs = "5.0.1"
+git2 = "0.18.1"
 inquire = "0.6.2"
-serde = { version = "1.0.193",  features = ["derive"] }
+log = "0.4.20"
+remove_dir_all = "0.8.2"
+reqwest = { version = "0.11.23", features = ["json", "blocking"] }
+serde = { version = "1.0.193", features = ["derive"] }
 strum = { version = "0.25.0", features = ["derive"] }
 strum_macros = { version = "0.25.3", features = [] }
-toml = "0.8.8"
-reqwest = { version = "0.11.23", features = ["json", "blocking"] }
 thiserror = "1.0.52"
-log = "0.4.20"
-git2 = "0.18.1"
-remove_dir_all = "0.8.2"
+toml = "0.8.8"

README.md

@@ -0,0 +1,3 @@
+# Madara CLI
+
+A CLI tool to quickly deploy Madara app chains.

src/cli/init.rs

@@ -44,12 +44,9 @@ fn generate_config() -> Result<AppChainConfig, InitError> {
 
     let app_chains_home = get_app_chains_home()?;
     let binding = app_chains_home.join(format!("{}/data", app_chain));
-    let default_base_path = match binding.to_str() {
-        Some(path_str) => path_str,
-        None => "madara-data",
-    };
+    let default_base_path = binding.to_str().unwrap_or("madara-data");
 
-    let base_path = get_text_input("Enter base path for data directory of your app chain:", Some(&default_base_path))?;
+    let base_path = get_text_input("Enter base path for data directory of your app chain:", Some(default_base_path))?;
     let chain_id = get_text_input("Enter chain id for your app chain:", Some("MADARA"))?;
     let mode = get_option("Select mode for your app chain:", RollupMode::iter().collect::<Vec<_>>())?;
     let da_layer = get_option("Select DA layer for your app chain:", DALayer::iter().collect::<Vec<_>>())?;
@@ -80,7 +77,7 @@ fn write_config(config: &AppChainConfig) -> Result<(), InitError> {
     let app_home = get_app_home(&config.app_chain)?;
     let full_file_path = app_home.join(config_file);
 
-    if let Err(err) = fs::write(&full_file_path, toml) {
+    if let Err(err) = fs::write(full_file_path, toml) {
         panic!("Error writing to file: {}", err);
     } else {
         log::info!("Data written to file successfully!");

src/cli/list.rs

@@ -18,7 +18,7 @@ pub fn list() {
 /// But return app names after validating the {app}-config.toml
 pub fn get_apps_list() -> Result<Vec<String>, io::Error> {
     let app_configs = get_app_chains_home()?;
-    let app_names: Vec<String> = match fs::read_dir(&app_configs) {
+    let app_names: Vec<String> = match fs::read_dir(app_configs) {
         Ok(entries) => entries
             .filter_map(|entry| {
                 entry.ok().and_then(|entry| {

src/cli/run.rs

@@ -32,7 +32,7 @@ fn start_app_chain() -> Result<(), RunError> {
     let app_chain: &str = &app;
 
     madara::clone_madara_and_build_repo()?;
-    madara::setup_and_run_madara(&app_chain)?;
+    madara::setup_and_run_madara(app_chain)?;
 
     Ok(())
 }

src/utils/github.rs

@@ -18,7 +18,7 @@ pub fn get_latest_commit_hash(org: &str, repo: &str) -> Result<String, GithubErr
     let github_api_url = format!("{}/repos/{}/{}/commits", GITHUB_API_BASE_URL, org, repo);
 
     let client = Client::new();
-    let response = client.get(&github_api_url).header("User-Agent", "reqwest").send();
+    let response = client.get(github_api_url).header("User-Agent", "reqwest").send();
 
     return match response {
         Ok(response) => match response.json::<Vec<Commit>>() {
@@ -33,23 +33,16 @@ pub fn get_latest_commit_hash(org: &str, repo: &str) -> Result<String, GithubErr
 }
 
 pub fn git_clone(url: &str, path: &PathBuf) -> Result<(), GithubError> {
-    match Repository::open(path) {
-        Ok(repo) => {
-            // Check if the repository is valid
-            if repo.is_empty() == Ok(false) {
-                let remote = repo.find_remote("origin")?;
-                match remote.url() {
-                    Some(remote_url) => {
-                        if remote_url == url {
-                            return Ok(());
-                        }
-                    }
-                    None => (),
+    if let Ok(repo) = Repository::open(path) {
+        // Check if the repository is valid
+        if repo.is_empty() == Ok(false) {
+            let remote = repo.find_remote("origin")?;
+            if let Some(remote_url) = remote.url() {
+                if remote_url == url {
+                    return Ok(());
                 }
             }
         }
-        // We will clone the repo
-        Err(_) => {}
     }
 
     if path.exists() {
@@ -69,11 +62,11 @@ pub fn git_clone(url: &str, path: &PathBuf) -> Result<(), GithubError> {
 
     let status = output.status;
 
-    return if status.success() {
+    if status.success() {
         log::info!("Clone successful!");
         Ok(())
     } else {
         log::error!("Clone failed");
         Err(GithubError::FailedToCloneRepo)
-    };
+    }
 }

src/utils/madara.rs

@@ -27,7 +27,7 @@ pub fn clone_madara_and_build_repo() -> Result<(), MadaraError> {
 pub fn setup_and_run_madara(app_chain: &str) -> Result<(), MadaraError> {
     let madara_path = get_madara_home()?.join("madara");
 
-    let (config, _) = match regenerate_app_config(&app_chain) {
+    let (config, _) = match regenerate_app_config(app_chain) {
         Ok((config, valid)) => (config, valid),
         Err(err) => {
             log::error!("Failed to fetch the required app chain: {}", err);

src/utils/toml.rs

@@ -5,9 +5,9 @@ use crate::utils::errors::TomlError;
 use crate::utils::paths::get_app_home;
 
 pub fn regenerate_app_config(app: &str) -> Result<(AppChainConfig, bool), TomlError> {
-    let app_home = get_app_home(&app)?;
+    let app_home = get_app_home(app)?;
     let app_config = app_home.join(format!("{}-config.toml", app));
-    let toml_content = fs::read_to_string(&app_config)?;
+    let toml_content = fs::read_to_string(app_config)?;
 
     match toml::from_str::<AppChainConfig>(&toml_content) {
         Ok(app_chain_config) => Ok((app_chain_config, true)),

taplo.toml

@@ -0,0 +1,11 @@
+include = ["**/*.toml"]
+exclude = ["**/bad.toml"]
+
+[formatting]
+align_entries = false
+
+[[rule]]
+keys = ["dependencies"]
+
+[rule.formatting]
+reorder_keys = true