diff options
| -rw-r--r-- | README.md | 21 | ||||
| -rw-r--r-- | mingling_core/src/asset/comp/flags.rs | 2 | ||||
| -rw-r--r-- | mingling_core/src/builds/comp.rs | 4 | ||||
| -rw-r--r-- | mingling_core/tmpls/comps/pwsh.ps1 (renamed from mingling_core/tmpls/comps/pwsl.ps1) | 0 |
4 files changed, 19 insertions, 8 deletions
@@ -11,10 +11,10 @@ <p align="center"> <img src="https://img.shields.io/github/stars/CatilGrass/mingling?style=for-the-badge"> <a href="https://crates.io/crates/mingling"> - <img src="https://img.shields.io/badge/Crates.io-0.1.4-yellow?style=for-the-badge"> + <img src="https://img.shields.io/badge/Crates.io-0.1.5-yellow?style=for-the-badge"> </a> <a href="https://docs.rs/mingling/0.1.4/mingling/"> - <img src="https://img.shields.io/badge/Docs.rs-0.1.4-orange?style=for-the-badge"> + <img src="https://img.shields.io/badge/Docs.rs-0.1.5-orange?style=for-the-badge"> </a> <img src="https://img.shields.io/badge/Current-0.1.5-green?style=for-the-badge"> </p> @@ -33,6 +33,7 @@ - [Example Projects](#example-projects) - [Next Steps](#next-steps) - [Roadmap](#roadmap) +- [Unplanned Features](#unplanned-features) - [License](#license) ## Intro @@ -129,13 +130,23 @@ You can read the following docs to learn more about the `Mingling` framework: ## Roadmap -- [ ] core: \[**unplanned**\] Parallel Chains - [x] core: \[[0.1.4](https://docs.rs/mingling/0.1.4/mingling/)\] General Renderers *( Json, Yaml, Toml, Ron )* -- [x] core: \[**0.1.5**\] Completion *( Bash Zsh Fish Pwsl )* **\[unreleased\]** -- [ ] \[**unplanned**\] Helpdoc +- [x] core: \[[0.1.5](https://docs.rs/mingling/0.1.5/mingling/)\] Completion *( Bash Zsh Fish Pwsh )* +- [ ] core: \[**0.2.0**\] Parallel Chains +- [ ] \[**0.2.1**\] Helpdoc - [ ] \[**unplanned**\] Parser Theme - [ ] ... +## Unplanned Features + +While Mingling has several common CLI features that are **not planned** to be directly included in the framework. +This is because the Rust ecosystem already has excellent and mature crates to handle these issues, and Mingling's design is intended to be used in combination with them. + +- **Colored Output**: To add color and styles (bold, italic, etc.) to terminal output, consider using crates like [`colored`](https://crates.io/crates/colored) or [`owo-colors`](https://crates.io/crates/owo-colors). You can integrate their types directly into your renderers. +- **I18n**: To translate your CLI application, the [`rust-i18n`](https://crates.io/crates/rust-i18n) crate provides a powerful internationalization solution that you can use in your command logic and renderers. +- **Progress Bars**: To display progress indicators, the [`indicatif`](https://crates.io/crates/indicatif) crate is the standard choice. +- **TUI**: To build full-screen interactive terminal applications, it is recommended to use a framework like [`ratatui`](https://crates.io/crates/ratatui) (formerly `tui-rs`). + ## License This project is licensed under the MIT License. diff --git a/mingling_core/src/asset/comp/flags.rs b/mingling_core/src/asset/comp/flags.rs index 0762d0d..f61e9ac 100644 --- a/mingling_core/src/asset/comp/flags.rs +++ b/mingling_core/src/asset/comp/flags.rs @@ -17,7 +17,7 @@ impl From<String> for ShellFlag { "zsh" => ShellFlag::Zsh, "bash" => ShellFlag::Bash, "fish" => ShellFlag::Fish, - "pwsl" | "ps1" | "powershell" => ShellFlag::Powershell, + "pwsh" | "ps1" | "powershell" => ShellFlag::Powershell, other => ShellFlag::Other(snake_case!(other)), } } diff --git a/mingling_core/src/builds/comp.rs b/mingling_core/src/builds/comp.rs index 694af0c..57faa2e 100644 --- a/mingling_core/src/builds/comp.rs +++ b/mingling_core/src/builds/comp.rs @@ -5,7 +5,7 @@ use crate::ShellFlag; const TMPL_COMP_BASH: &str = include_str!("../../tmpls/comps/bash.sh"); const TMPL_COMP_ZSH: &str = include_str!("../../tmpls/comps/zsh.zsh"); const TMPL_COMP_FISH: &str = include_str!("../../tmpls/comps/fish.fish"); -const TMPL_COMP_PWSL: &str = include_str!("../../tmpls/comps/pwsl.ps1"); +const TMPL_COMP_PWSH: &str = include_str!("../../tmpls/comps/pwsh.ps1"); /// Generate shell completion scripts for the current binary. /// On Windows, generates PowerShell completion. @@ -74,7 +74,7 @@ fn get_tmpl(shell_flag: &ShellFlag) -> (&'static str, &'static str) { ShellFlag::Bash => (TMPL_COMP_BASH, ".sh"), ShellFlag::Zsh => (TMPL_COMP_ZSH, ".zsh"), ShellFlag::Fish => (TMPL_COMP_FISH, ".fish"), - ShellFlag::Powershell => (TMPL_COMP_PWSL, ".ps1"), + ShellFlag::Powershell => (TMPL_COMP_PWSH, ".ps1"), ShellFlag::Other(_) => (TMPL_COMP_BASH, ".sh"), } } diff --git a/mingling_core/tmpls/comps/pwsl.ps1 b/mingling_core/tmpls/comps/pwsh.ps1 index 6d7d91d..6d7d91d 100644 --- a/mingling_core/tmpls/comps/pwsl.ps1 +++ b/mingling_core/tmpls/comps/pwsh.ps1 |