feat(nats): Add NATS Context

.github/config-schema.json

@@ -1022,6 +1022,19 @@
  }
  ]
  },
+ "nats": {
+ "default": {
+ "disabled": true,
+ "format": "[$symbol($name )]($style)",
+ "style": "bold purple",
+ "symbol": "✉️ "
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/NatsConfig"
+ }
+ ]
+ },
  "nim": {
  "default": {
  "detect_extensions": [
@@ -2040,14 +2053,12 @@
  "type": "string"
  },
  "charging_symbol": {
- "default": null,
  "type": [
  "string",
  "null"
  ]
  },
  "discharging_symbol": {
- "default": null,
  "type": [
  "string",
  "null"
@@ -2718,14 +2729,12 @@
  "type": "string"
  },
  "repo_root_style": {
- "default": null,
  "type": [
  "string",
  "null"
  ]
  },
  "before_repo_root_style": {
- "default": null,
  "type": [
  "string",
  "null"
@@ -4182,35 +4191,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"
@@ -4367,6 +4371,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": {

docs/config/README.md

@@ -338,6 +338,7 @@ $aws\
 $gcloud\
 $openstack\
 $azure\
+$nats\
 $direnv\
 $env_var\
 $crystal\
@@ -2895,6 +2896,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/).

docs/public/presets/toml/plain-text-symbols.toml

@@ -106,6 +106,9 @@ symbol = "memory "
 [meson]
 symbol = "meson "
 
+[nats]
+symbol = "nats "
+
 [nim]
 symbol = "nim "
 

src/configs/mod.rs

@@ -54,6 +54,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;
@@ -214,6 +215,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>,

src/configs/nats.rs

@@ -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,
+ }
+ }
+}

src/configs/starship_root.rs

@@ -37,6 +37,7 @@ pub const PROMPT_ORDER: &[&str] = &[
  "shlvl",
  "singularity",
  "kubernetes",
+ "nats",
  "directory",
  "vcsh",
  "fossil_branch",

src/module.rs

@@ -61,6 +61,7 @@ pub const ALL_MODULES: &[&str] = &[
  "lua",
  "memory_usage",
  "meson",
+ "nats",
  "nim",
  "nix_shell",
  "nodejs",

src/modules/mod.rs

@@ -51,6 +51,7 @@ mod localip;
 mod lua;
 mod memory_usage;
 mod meson;
+mod nats;
 mod nim;
 mod nix_shell;
 mod nodejs;
@@ -159,6 +160,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),
@@ -280,6 +282,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",

src/modules/nats.rs

@@ -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(())
+ }
+}

src/utils.rs

@@ -307,6 +307,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(
  "\