mirror of
https://github.com/starship/starship.git
synced 2024-10-05 01:43:46 +02:00
feat(nats): Add NATS Context (#5900)
--------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
This commit is contained in:
parent
2221a88f5a
commit
5facd85da5
44
.github/config-schema.json
vendored
44
.github/config-schema.json
vendored
@ -1044,6 +1044,19 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"nats": {
|
||||
"default": {
|
||||
"disabled": true,
|
||||
"format": "[$symbol($name )]($style)",
|
||||
"style": "bold purple",
|
||||
"symbol": "✉️ "
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/NatsConfig"
|
||||
}
|
||||
]
|
||||
},
|
||||
"nim": {
|
||||
"default": {
|
||||
"detect_extensions": [
|
||||
@ -2082,14 +2095,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"charging_symbol": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"discharging_symbol": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
@ -2760,14 +2771,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"repo_root_style": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"before_repo_root_style": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
@ -4282,35 +4291,30 @@
|
||||
"type": "string"
|
||||
},
|
||||
"user_pattern": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"symbol": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"style": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"context_alias": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"user_alias": {
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
@ -4467,6 +4471,28 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"NatsConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"default": "[$symbol($name )]($style)",
|
||||
"type": "string"
|
||||
},
|
||||
"symbol": {
|
||||
"default": "✉️ ",
|
||||
"type": "string"
|
||||
},
|
||||
"style": {
|
||||
"default": "bold purple",
|
||||
"type": "string"
|
||||
},
|
||||
"disabled": {
|
||||
"default": true,
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"NimConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
@ -339,6 +339,7 @@ $aws\
|
||||
$gcloud\
|
||||
$openstack\
|
||||
$azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$crystal\
|
||||
@ -2937,6 +2938,35 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## NATS
|
||||
|
||||
The `nats` module shows the name of the current [NATS](https://nats.io) context.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | -------------------------- | ------------------------------------------------------------ |
|
||||
| `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'[$symbol$name]($style)'` | The format for the module. |
|
||||
| `disabled` | `false` | Disables the `nats` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | ----------- | ------------------------------------ |
|
||||
| name | `localhost` | The name of the NATS context |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
[nats]
|
||||
format = '[$symbol]($style)'
|
||||
style = 'bold purple'
|
||||
```
|
||||
|
||||
## Nim
|
||||
|
||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/).
|
||||
|
@ -109,6 +109,9 @@ symbol = "memory "
|
||||
[meson]
|
||||
symbol = "meson "
|
||||
|
||||
[nats]
|
||||
symbol = "nats "
|
||||
|
||||
[nim]
|
||||
symbol = "nim "
|
||||
|
||||
|
@ -55,6 +55,7 @@ pub mod localip;
|
||||
pub mod lua;
|
||||
pub mod memory_usage;
|
||||
pub mod meson;
|
||||
pub mod nats;
|
||||
pub mod nim;
|
||||
pub mod nix_shell;
|
||||
pub mod nodejs;
|
||||
@ -218,6 +219,8 @@ pub struct FullConfig<'a> {
|
||||
#[serde(borrow)]
|
||||
meson: meson::MesonConfig<'a>,
|
||||
#[serde(borrow)]
|
||||
nats: nats::NatsConfig<'a>,
|
||||
#[serde(borrow)]
|
||||
nim: nim::NimConfig<'a>,
|
||||
#[serde(borrow)]
|
||||
nix_shell: nix_shell::NixShellConfig<'a>,
|
||||
|
26
src/configs/nats.rs
Normal file
26
src/configs/nats.rs
Normal file
@ -0,0 +1,26 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Clone, Deserialize, Serialize)]
|
||||
#[cfg_attr(
|
||||
feature = "config-schema",
|
||||
derive(schemars::JsonSchema),
|
||||
schemars(deny_unknown_fields)
|
||||
)]
|
||||
#[serde(default)]
|
||||
pub struct NatsConfig<'a> {
|
||||
pub format: &'a str,
|
||||
pub symbol: &'a str,
|
||||
pub style: &'a str,
|
||||
pub disabled: bool,
|
||||
}
|
||||
|
||||
impl<'a> Default for NatsConfig<'a> {
|
||||
fn default() -> Self {
|
||||
NatsConfig {
|
||||
format: "[$symbol($name )]($style)",
|
||||
symbol: "✉️ ",
|
||||
style: "bold purple",
|
||||
disabled: true,
|
||||
}
|
||||
}
|
||||
}
|
@ -37,6 +37,7 @@ pub const PROMPT_ORDER: &[&str] = &[
|
||||
"shlvl",
|
||||
"singularity",
|
||||
"kubernetes",
|
||||
"nats",
|
||||
"directory",
|
||||
"vcsh",
|
||||
"fossil_branch",
|
||||
|
@ -60,6 +60,7 @@ pub const ALL_MODULES: &[&str] = &[
|
||||
"lua",
|
||||
"memory_usage",
|
||||
"meson",
|
||||
"nats",
|
||||
"nim",
|
||||
"nix_shell",
|
||||
"nodejs",
|
||||
|
@ -52,6 +52,7 @@ mod localip;
|
||||
mod lua;
|
||||
mod memory_usage;
|
||||
mod meson;
|
||||
mod nats;
|
||||
mod nim;
|
||||
mod nix_shell;
|
||||
mod nodejs;
|
||||
@ -162,6 +163,7 @@ pub fn handle<'a>(module: &str, context: &'a Context) -> Option<Module<'a>> {
|
||||
"lua" => lua::module(context),
|
||||
"memory_usage" => memory_usage::module(context),
|
||||
"meson" => meson::module(context),
|
||||
"nats" => nats::module(context),
|
||||
"nim" => nim::module(context),
|
||||
"nix_shell" => nix_shell::module(context),
|
||||
"nodejs" => nodejs::module(context),
|
||||
@ -285,6 +287,7 @@ pub fn description(module: &str) -> &'static str {
|
||||
"meson" => {
|
||||
"The current Meson environment, if $MESON_DEVENV and $MESON_PROJECT_NAME are set"
|
||||
}
|
||||
"nats" => "The current NATS context",
|
||||
"nim" => "The currently installed version of Nim",
|
||||
"nix_shell" => "The nix-shell environment",
|
||||
"nodejs" => "The currently installed version of NodeJS",
|
||||
|
89
src/modules/nats.rs
Normal file
89
src/modules/nats.rs
Normal file
@ -0,0 +1,89 @@
|
||||
use super::{Context, Module, ModuleConfig};
|
||||
use serde_json as json;
|
||||
|
||||
use crate::configs::nats::NatsConfig;
|
||||
use crate::formatter::StringFormatter;
|
||||
|
||||
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
||||
let mut module = context.new_module("nats");
|
||||
let config = NatsConfig::try_load(module.config);
|
||||
|
||||
if config.disabled {
|
||||
return None;
|
||||
};
|
||||
|
||||
let ctx_str = context
|
||||
.exec_cmd("nats", &["context", "info", "--json"])?
|
||||
.stdout;
|
||||
let nats_context: json::Value = json::from_str(&ctx_str)
|
||||
.map_err(|e| {
|
||||
log::warn!("Error parsing nats context JSON: {}\n", e);
|
||||
drop(e);
|
||||
})
|
||||
.ok()?;
|
||||
|
||||
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
|
||||
formatter
|
||||
.map_meta(|var, _| match var {
|
||||
"symbol" => Some(config.symbol),
|
||||
_ => None,
|
||||
})
|
||||
.map_style(|variable| match variable {
|
||||
"style" => Some(Ok(config.style)),
|
||||
_ => None,
|
||||
})
|
||||
.map(|variable| match variable {
|
||||
"name" => Some(Ok(nats_context.get("name")?.as_str()?)),
|
||||
_ => None,
|
||||
})
|
||||
.parse(None, Some(context))
|
||||
});
|
||||
|
||||
module.set_segments(match parsed {
|
||||
Ok(segments) => segments,
|
||||
Err(error) => {
|
||||
log::warn!("Error in module `nats`:\n{}", error);
|
||||
return None;
|
||||
}
|
||||
});
|
||||
|
||||
Some(module)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use nu_ansi_term::Color;
|
||||
use std::io;
|
||||
|
||||
use crate::test::ModuleRenderer;
|
||||
|
||||
#[test]
|
||||
fn show_context() -> io::Result<()> {
|
||||
let actual = ModuleRenderer::new("nats")
|
||||
.config(toml::toml! {
|
||||
[nats]
|
||||
format = "[$symbol$name](bold purple)"
|
||||
symbol = ""
|
||||
disabled = false
|
||||
})
|
||||
.collect();
|
||||
let expected = Some(format!("{}", Color::Purple.bold().paint("localhost")));
|
||||
assert_eq!(expected, actual);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_with_symbol() -> io::Result<()> {
|
||||
let actual = ModuleRenderer::new("nats")
|
||||
.config(toml::toml! {
|
||||
[nats]
|
||||
format = "[$symbol$name](bold red)"
|
||||
symbol = "✉️ "
|
||||
disabled = false
|
||||
})
|
||||
.collect();
|
||||
let expected = Some(format!("{}", Color::Red.bold().paint("✉️ localhost")));
|
||||
assert_eq!(expected, actual);
|
||||
Ok(())
|
||||
}
|
||||
}
|
@ -315,6 +315,10 @@ Elixir 1.10 (compiled with Erlang/OTP 22)\n",
|
||||
stdout: String::from("LuaJIT 2.0.5 -- Copyright (C) 2005-2017 Mike Pall. http://luajit.org/\n"),
|
||||
stderr: String::default(),
|
||||
}),
|
||||
"nats context info --json" => Some(CommandOutput{
|
||||
stdout: String::from("{\"name\":\"localhost\",\"url\":\"nats://localhost:4222\"}"),
|
||||
stderr: String::default(),
|
||||
}),
|
||||
"nim --version" => Some(CommandOutput {
|
||||
stdout: String::from(
|
||||
"\
|
||||
|
Loading…
Reference in New Issue
Block a user