new: Initial commit

.github/workflows/cd.yml

@@ -0,0 +1,152 @@
+name: CD # Continuous Deployment
+
+on:
+  push:
+    tags:
+      - '[v]?[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  publish:
+
+    name: Publishing for ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+            os-name: macos
+            target: x86_64-apple-darwin
+            architecture: x86_64
+            binary-postfix: ""
+            binary-name: crates-tui
+            use-cross: false
+          - os: macos-latest
+            os-name: macos
+            target: aarch64-apple-darwin
+            architecture: arm64
+            binary-postfix: ""
+            use-cross: false
+            binary-name: crates-tui
+          - os: ubuntu-latest
+            os-name: linux
+            target: x86_64-unknown-linux-gnu
+            architecture: x86_64
+            binary-postfix: ""
+            use-cross: false
+            binary-name: crates-tui
+          - os: windows-latest
+            os-name: windows
+            target: x86_64-pc-windows-msvc
+            architecture: x86_64
+            binary-postfix: ".exe"
+            use-cross: false
+            binary-name: crates-tui
+          - os: ubuntu-latest
+            os-name: linux
+            target: aarch64-unknown-linux-gnu
+            architecture: arm64
+            binary-postfix: ""
+            use-cross: true
+            binary-name: crates-tui
+          - os: ubuntu-latest
+            os-name: linux
+            target: i686-unknown-linux-gnu
+            architecture: i686
+            binary-postfix: ""
+            use-cross: true
+            binary-name: crates-tui
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+
+          target: ${{ matrix.target }}
+
+          profile: minimal
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - name: Cargo build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+
+          use-cross: ${{ matrix.use-cross }}
+
+          toolchain: stable
+
+          args: --release --target ${{ matrix.target }}
+
+
+      - name: install strip command
+        shell: bash
+        run: |
+
+          if [[ ${{ matrix.target }} == aarch64-unknown-linux-gnu ]]; then
+
+              sudo apt update
+              sudo apt-get install -y binutils-aarch64-linux-gnu
+          fi
+      - name: Packaging final binary
+        shell: bash
+        run: |
+
+          cd target/${{ matrix.target }}/release
+
+
+          ####### reduce binary size by removing debug symbols #######
+
+          BINARY_NAME=${{ matrix.binary-name }}${{ matrix.binary-postfix }}
+          if [[ ${{ matrix.target }} == aarch64-unknown-linux-gnu ]]; then
+
+            GCC_PREFIX="aarch64-linux-gnu-"
+          else
+            GCC_PREFIX=""
+          fi
+          "$GCC_PREFIX"strip $BINARY_NAME
+
+          ########## create tar.gz ##########
+
+          RELEASE_NAME=${{ matrix.binary-name }}-${GITHUB_REF/refs\/tags\//}-${{ matrix.os-name }}-${{ matrix.architecture }}
+
+          tar czvf $RELEASE_NAME.tar.gz $BINARY_NAME
+
+          ########## create sha256 ##########
+
+          if [[ ${{ runner.os }} == 'Windows' ]]; then
+
+            certutil -hashfile $RELEASE_NAME.tar.gz sha256 | grep -E [A-Fa-f0-9]{64} > $RELEASE_NAME.sha256
+          else
+            shasum -a 256 $RELEASE_NAME.tar.gz > $RELEASE_NAME.sha256
+          fi
+      - name: Releasing assets
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+
+            target/${{ matrix.target }}/release/${{ matrix.binary-name }}-*.tar.gz
+            target/${{ matrix.target }}/release/${{ matrix.binary-name }}-*.sha256
+
+        env:
+
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+  publish-cargo:
+    name: Publishing to Cargo
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo publish
+        env:
+
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+

.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI # Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+      - name: Run tests
+        run: cargo test --all-features --workspace
+
+  rustfmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt
+      - uses: Swatinem/rust-cache@v2
+      - name: Check formatting
+        run: cargo fmt --all --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: clippy
+      - uses: Swatinem/rust-cache@v2
+      - name: Clippy check
+        run: cargo clippy --all-targets --all-features --workspace -- -D warnings
+
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+      - name: Check documentation
+        env:
+          RUSTDOCFLAGS: -D warnings
+        run: cargo doc --no-deps --document-private-items --all-features --workspace --examples

.gitignore

@@ -0,0 +1,2 @@
+/target
+.data/

.rustfmt.toml

@@ -0,0 +1,16 @@
+max_width = 120
+use_small_heuristics = "Max"
+empty_item_single_line = false
+force_multiline_blocks = true
+format_code_in_doc_comments = true
+match_block_trailing_comma = true
+imports_granularity = "Crate"
+normalize_comments = true
+normalize_doc_attributes = true
+overflow_delimited_expr = true
+reorder_impl_items = true
+reorder_imports = true
+group_imports = "StdExternalCrate"
+tab_spaces = 2
+use_field_init_shorthand = true
+use_try_shorthand = true

Cargo.toml

@@ -0,0 +1,51 @@
+[package]
+name = "crates-tui"
+version = "0.1.0"
+edition = "2021"
+description = "A TUI for crates.io"
+repository = "https://github.com/kdheepak/crates-tui"
+authors = ["Dheepak Krishnamurthy <[email protected]>"]
+build = "build.rs"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+better-panic = "0.3.0"
+chrono = "0.4.31"
+clap = { version = "4.4.11", features = ["derive", "cargo", "wrap_help", "unicode", "string", "unstable-styles", "color"] }
+color-eyre = "0.6.2"
+crates_io_api = "0.9.0"
+crossterm = { version = "0.27.0", features = ["serde", "event-stream"] }
+derive_deref = "1.1.1"
+directories = "5.0.1"
+figment = { version = "0.10.14", features = ["env", "toml"] }
+futures = "0.3.28"
+human-panic = "1.2.0"
+itertools = "0.12.0"
+json5 = "0.4.1"
+lazy_static = "1.4.0"
+libc = "0.2.148"
+log = "0.4.20"
+num-format = "0.4.4"
+pretty_assertions = "1.4.0"
+ratatui = { version = "0.26.0", features = ["serde", "macros"] }
+ratatui-macros = "0.2.3"
+serde = { version = "1.0.188", features = ["derive"] }
+serde_json = "1.0.107"
+serde_with = "3.5.0"
+signal-hook = "0.3.17"
+strip-ansi-escapes = "0.2.0"
+strum = { version = "0.26.1", features = ["derive"] }
+tokio = { version = "1.32.0", features = ["full"] }
+tokio-util = "0.7.10"
+toml = "0.8.8"
+tracing = "0.1.40"
+tracing-appender = "0.2.3"
+tracing-error = "0.2.0"
+tracing-log = "0.2.0"
+tracing-subscriber = { version = "0.3.18", features = ["env-filter", "serde", "serde_json"] }
+tui-input = "0.8.0"
+
+
+[build-dependencies]
+vergen = { version = "8.2.6", features = [ "build", "git", "gitoxide", "cargo" ]}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Dheepak Krishnamurthy <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,5 @@
+# crates-tui
+
+[![CI](https://github.com//crates-tui/workflows/CI/badge.svg)](https://github.com//crates-tui/actions)
+
+A TUI for crates.io

build.rs

@@ -0,0 +1,4 @@
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+  vergen::EmitBuilder::builder().all_build().all_git().emit()?;
+  Ok(())
+}

rust-toolchain.toml

@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"

src/action.rs

@@ -0,0 +1,33 @@
+use std::{fmt, string::ToString};
+
+use serde::{
+  de::{self, Deserializer, Visitor},
+  Deserialize, Serialize,
+};
+use strum::Display;
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Display, Deserialize)]
+pub enum Action {
+  Tick,
+  Render,
+  Resize(u16, u16),
+  Suspend,
+  Resume,
+  Quit,
+  Refresh,
+  Error(String),
+  Help,
+  GetCrates,
+  EnterSearchQueryInsert,
+  EnterFilterInsert,
+  EnterNormal,
+  MoveSelectionBottom,
+  MoveSelectionTop,
+  MoveSelectionNext,
+  MoveSelectionPrevious,
+  SubmitSearchQuery,
+  GetInfo,
+  ShowPicker,
+  ReloadData,
+  ToggleShowHelp,
+}