mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-06-02 08:30:50 +00:00
8d3aa3b304
* feat(formatter): Allow scoped variables (#1094) * feat: Allow scoped variables , with the following improvements to the format string parser. - Add documentation to spec - Simplify some syntax in the spec - Rewrite for loop with iterators * Added support for R programming language. * Removed unnecessary debug log used during dev process. * Make the `R` command upper case as the *nix OS executables are case sensitives and the correct command is upper-case. * Changed comments to reflect R features (rather than node.js where code was coming from). * feat(format_string): Allow positional segments (#1138) * feat(format_string): Allow using variables in a style string (#1130) * fix(format_string): Allow multiple variable mappers (#1142) * refactor: Add error handling to variables (#1148) * Squashed commit of changes with meta variables: commit 5beb3bca18f0b0c822b740afb3778ccb1e3a7d19 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Mon Apr 27 09:52:59 2020 +0800 fix: Cache variables in meta variables properly commit 49b9324942dd55350c87107d0e8c7d1592d92e8a Merge: cc575bc 260a1ab Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sun Apr 26 21:34:52 2020 +0800 Merge branch 'feat/format-string' into meta-variables commit cc575bc27cbf87c4197e96d2fa5416d4932e45d7 Merge: 3ed2d32 e0c1901 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sun Apr 26 12:16:12 2020 +0800 Merge branch 'feat/format-string' into meta-variables commit 3ed2d326c9f625930bdd72cea736c1d0eab6d381 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sun Apr 26 11:06:28 2020 +0800 refactor(format_string): Allow returning error in variable mapper commit 766732fe697df947538fe12ca92a8eb8e7bfea3e Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 22:56:02 2020 +0800 fix: Add test for StyleVariableHolder commit 444334ad206a68132fa6257b83c3992b7b790981 Merge: 479d4a7 9796a66 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 22:52:27 2020 +0800 Merge branch 'positional-segments' into style-variables commit 9796a66a9679597676e7fd859197fd542e8042dc Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 22:51:26 2020 +0800 test: Add tests for VariableHolder commit 479d4a72fa58fd8aa777acd8228d4834407a7b6a Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 22:41:47 2020 +0800 feat: Add trait StyleVariableHolder commit 21d40c6f4e2d12b34fdec4e2e38b6ad0f91217a3 Merge: 3b459f4 e7dd987 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 22:17:11 2020 +0800 Merge branch 'positional-segments' into style-variables commit e7dd987fd7b01a82c6012ba7055d1dd9b5fd84aa Author: heyrict <xiezh0831@yahoo.co.jp> Date: Sat Apr 25 15:10:12 2020 +0800 misc: Minor changes on docs and codes commit 71020b0397a86e850ad5beda926aa9416250025c Author: heyrict <xiezh0831@yahoo.co.jp> Date: Fri Apr 24 20:51:45 2020 +0800 feat(format_string): Add syntax for positional segments commit 3b459f4379b08defce50c57a903502513ad1b2b6 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Wed Apr 22 17:49:15 2020 +0800 fix: Fix clippy commit 2fb052d68cb46680c081f5a0e25e2c3fbdc9e204 Author: heyrict <xiezh0831@yahoo.co.jp> Date: Wed Apr 22 17:02:09 2020 +0800 feat: Add map_style method to feed values in style string * fix: Change error type of StringFormatter::new * fix: Fix rustfmt * tests: Add tests to variable errors * docs: Add documentation * chore: Rename positional to conditional (#1166) * docs: Add docs for format strings (#1083) Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com> * refactor(rust): Use format strings (#1063) * Updated to latest string formatter's changes. * feat(format-string): add format string support to battery module (#1158) * update battery module with format string * update battery module docs * update battery module with format string * update battery module docs * fix battery module with new StringFormatter api * fix clippy warnings * Update docs/config/README.md Co-authored-by: Zhenhui Xie <xiezh0831@yahoo.co.jp> * battery symbols now supports format-string * battery symbols now support format-string remove space between symbol and percentage fix battery config Co-authored-by: Zhenhui Xie <xiezh0831@yahoo.co.jp> * refactor(golang): Use format strings (#1066) * refactor(golang): Use format strings * docs(golang): Update docs * docs(golang): Update docs * fix: Update to upstream API changes * docs(golang): Update docs Co-authored-by: heyrict <xiezh0831@yahoo.co.jp> * Fixed a few inconsistencies. * Removed string clone in favor of a reference. * Update src/modules/r.rs Reverting the r version string formatting to a more idiomatic way of handling it. Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com> * Update src/configs/r.rs Co-authored-by: Zhenhui Xie <xiezh0831@yahoo.co.jp> * Updated documentation to reflect changes in config. * refactor(java): Added formatter support for Java module. (#1084) * refactor(haskell): Added formatter support for the Haskell module. (#1111) * Added formatter support for the Haskell module. * Updated haskell module with latest formatter code changes. * Changed documentation for latest Haskell string formatter changes. * Fixed a few inconsistencies. * Removed unnecessary variable cloning for using reference instead. * refactor(env_var): Added formatter support for the env_var module (#1180) * refactor(memory_usage): Added formatter support for memory_usage module (#1182) * Migrated the memory usage module to string formatter' support. * Fixed a few inconsistencies. * Removed cloning of variables to instead use references. * refactor(cmd_duration): Use format strings (#1200) * Fixed format issue in code. * Fixed compilation error after adding new 'r' module in root config. * Added .Rproj extension file to be detected with R prog lang. * Aligned R module code with existing ones. * Update src/configs/r.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * fix: Added rconfig to fullconfig and fixed broken api calls * Apply suggestions from code review Co-authored-by: Dario Vladović <d.vladimyr@gmail.com> * Update src/modules/r.rs Co-authored-by: Dario Vladović <d.vladimyr@gmail.com> * Addressed PR comments. Cleaned up code and fixed code errors. * Updated docs for consistency purpose. Co-authored-by: Milo <50248166+Milo123459@users.noreply.github.com> * refactor: Renamed the `r` module to `rlang` * test: Provided R fixture and R module renderer test * doc: Updated rlang mod config to reflect latest detection changes * fix: Added missing rlang entry in config/mod * feat: Added version formatted fined grained configuration * Added version_format in R lang documentation. Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * review: Addressed later comments * fix: README was missing a previously present section for Python * Fix: Test was not updated for previous version string upgrade. * fix: Upgraded R version in remaining test. Co-authored-by: Zhenhui Xie <xiezh0831@yahoo.co.jp> Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com> Co-authored-by: Luca Rinaldi <lucarin@protonmail.com> Co-authored-by: John Letey <johnletey@gmail.com> Co-authored-by: Tilmann Meyer <47182955+ATiltedTree@users.noreply.github.com> Co-authored-by: David Knaack <davidkna@users.noreply.github.com> Co-authored-by: Dario Vladović <d.vladimyr@gmail.com> Co-authored-by: Milo <50248166+Milo123459@users.noreply.github.com>
240 lines
5.9 KiB
Rust
240 lines
5.9 KiB
Rust
use crate::context::Shell;
|
|
use crate::segment::Segment;
|
|
use crate::utils::wrap_colorseq_for_shell;
|
|
use ansi_term::{ANSIString, ANSIStrings};
|
|
use std::fmt;
|
|
use std::time::Duration;
|
|
|
|
// List of all modules
|
|
// Keep these ordered alphabetically.
|
|
// Default ordering is handled in configs/starship_root.rs
|
|
pub const ALL_MODULES: &[&str] = &[
|
|
"aws",
|
|
#[cfg(feature = "battery")]
|
|
"battery",
|
|
"character",
|
|
"cmake",
|
|
"cmd_duration",
|
|
"conda",
|
|
"dart",
|
|
"deno",
|
|
"directory",
|
|
"docker_context",
|
|
"dotnet",
|
|
"elixir",
|
|
"elm",
|
|
"erlang",
|
|
"env_var",
|
|
"gcloud",
|
|
"git_branch",
|
|
"git_commit",
|
|
"git_state",
|
|
"git_status",
|
|
"golang",
|
|
"helm",
|
|
"hg_branch",
|
|
"hostname",
|
|
"java",
|
|
"scala",
|
|
"jobs",
|
|
"julia",
|
|
"kotlin",
|
|
"kubernetes",
|
|
"line_break",
|
|
"lua",
|
|
"memory_usage",
|
|
"nim",
|
|
"nix_shell",
|
|
"nodejs",
|
|
"ocaml",
|
|
"openstack",
|
|
"package",
|
|
"perl",
|
|
"purescript",
|
|
"python",
|
|
"rlang",
|
|
"red",
|
|
"ruby",
|
|
"crystal",
|
|
"rust",
|
|
"php",
|
|
"swift",
|
|
"terraform",
|
|
"shell",
|
|
"shlvl",
|
|
"singularity",
|
|
"status",
|
|
"time",
|
|
"username",
|
|
"vcsh",
|
|
"vagrant",
|
|
"vlang",
|
|
"zig",
|
|
];
|
|
|
|
/// A module is a collection of segments showing data for a single integration
|
|
/// (e.g. The git module shows the current git branch and status)
|
|
pub struct Module<'a> {
|
|
/// The module's configuration map if available
|
|
pub config: Option<&'a toml::Value>,
|
|
|
|
/// The module's name, to be used in configuration and logging.
|
|
name: String,
|
|
|
|
/// The module's description
|
|
description: String,
|
|
|
|
/// The collection of segments that compose this module.
|
|
pub segments: Vec<Segment>,
|
|
|
|
/// the time it took to compute this module
|
|
pub duration: Duration,
|
|
}
|
|
|
|
impl<'a> Module<'a> {
|
|
/// Creates a module with no segments.
|
|
pub fn new(name: &str, desc: &str, config: Option<&'a toml::Value>) -> Module<'a> {
|
|
Module {
|
|
config,
|
|
name: name.to_string(),
|
|
description: desc.to_string(),
|
|
segments: Vec::new(),
|
|
duration: Duration::default(),
|
|
}
|
|
}
|
|
|
|
/// Set segments in module
|
|
pub fn set_segments(&mut self, segments: Vec<Segment>) {
|
|
self.segments = segments;
|
|
}
|
|
|
|
/// Get module's name
|
|
pub fn get_name(&self) -> &String {
|
|
&self.name
|
|
}
|
|
|
|
/// Get module's description
|
|
pub fn get_description(&self) -> &String {
|
|
&self.description
|
|
}
|
|
|
|
/// Whether a module has non-empty segments
|
|
pub fn is_empty(&self) -> bool {
|
|
self.segments
|
|
.iter()
|
|
// no trim: if we add spaces/linebreaks it's not "empty" as we change the final output
|
|
.all(|segment| segment.value.is_empty())
|
|
}
|
|
|
|
/// Get values of the module's segments
|
|
pub fn get_segments(&self) -> Vec<&str> {
|
|
self.segments
|
|
.iter()
|
|
.map(|segment| segment.value.as_str())
|
|
.collect()
|
|
}
|
|
|
|
/// Returns a vector of colored ANSIString elements to be later used with
|
|
/// `ANSIStrings()` to optimize ANSI codes
|
|
pub fn ansi_strings(&self) -> Vec<ANSIString> {
|
|
self.ansi_strings_for_shell(Shell::Unknown)
|
|
}
|
|
|
|
pub fn ansi_strings_for_shell(&self, shell: Shell) -> Vec<ANSIString> {
|
|
let ansi_strings = self
|
|
.segments
|
|
.iter()
|
|
.map(Segment::ansi_string)
|
|
.collect::<Vec<ANSIString>>();
|
|
|
|
match shell {
|
|
Shell::Bash => ansi_strings_modified(ansi_strings, shell),
|
|
Shell::Zsh => ansi_strings_modified(ansi_strings, shell),
|
|
Shell::Tcsh => ansi_strings_modified(ansi_strings, shell),
|
|
_ => ansi_strings,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a> fmt::Display for Module<'a> {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
let ansi_strings = self.ansi_strings();
|
|
write!(f, "{}", ANSIStrings(&ansi_strings))
|
|
}
|
|
}
|
|
|
|
fn ansi_strings_modified(ansi_strings: Vec<ANSIString>, shell: Shell) -> Vec<ANSIString> {
|
|
ansi_strings
|
|
.into_iter()
|
|
.map(|ansi| {
|
|
let wrapped = wrap_colorseq_for_shell(ansi.to_string(), shell);
|
|
ANSIString::from(wrapped)
|
|
})
|
|
.collect::<Vec<ANSIString>>()
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_module_is_empty_with_no_segments() {
|
|
let name = "unit_test";
|
|
let desc = "This is a unit test";
|
|
let module = Module {
|
|
config: None,
|
|
name: name.to_string(),
|
|
description: desc.to_string(),
|
|
segments: Vec::new(),
|
|
duration: Duration::default(),
|
|
};
|
|
|
|
assert!(module.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_module_is_empty_with_all_empty_segments() {
|
|
let name = "unit_test";
|
|
let desc = "This is a unit test";
|
|
let module = Module {
|
|
config: None,
|
|
name: name.to_string(),
|
|
description: desc.to_string(),
|
|
segments: vec![Segment::new(None, "")],
|
|
duration: Duration::default(),
|
|
};
|
|
|
|
assert!(module.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_module_is_not_empty_with_linebreak_only() {
|
|
let name = "unit_test";
|
|
let desc = "This is a unit test";
|
|
let module = Module {
|
|
config: None,
|
|
name: name.to_string(),
|
|
description: desc.to_string(),
|
|
segments: vec![Segment::new(None, "\n")],
|
|
duration: Duration::default(),
|
|
};
|
|
|
|
assert!(!module.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_module_is_not_empty_with_space_only() {
|
|
let name = "unit_test";
|
|
let desc = "This is a unit test";
|
|
let module = Module {
|
|
config: None,
|
|
name: name.to_string(),
|
|
description: desc.to_string(),
|
|
segments: vec![Segment::new(None, " ")],
|
|
duration: Duration::default(),
|
|
};
|
|
|
|
assert!(!module.is_empty());
|
|
}
|
|
}
|