extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-12-27 09:38:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(modules): add missing module descriptions (#3081)

Browse Source
This commit is contained in:
David Knaack 2021-09-17 23:16:02 +02:00 committed by GitHub
parent 913dc3af2a
commit 20af85f0a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/modules/mod.rs
View File

@ -181,6 +181,8 @@ pub fn description(module: &str) -> &'static str {
"directory" => "The current working directory", "directory" => "The current working directory",
"docker_context" => "The current docker context", "docker_context" => "The current docker context",
"dotnet" => "The relevant version of the .NET Core SDK for the current directory", "dotnet" => "The relevant version of the .NET Core SDK for the current directory",
"elixir" => "The currently installed versions of Elixir and OTP",
"elm" => "The currently installed version of Elm",
"env_var" => "Displays the current value of a selected environment variable", "env_var" => "Displays the current value of a selected environment variable",
"erlang" => "Current OTP version", "erlang" => "Current OTP version",
"fill" => "Fills the remaining space on the line with a pad string", "fill" => "Fills the remaining space on the line with a pad string",
@ -212,22 +214,37 @@ pub fn description(module: &str) -> &'static str {
"php" => "The currently installed version of PHP", "php" => "The currently installed version of PHP",
"purescript" => "The currently installed version of PureScript", "purescript" => "The currently installed version of PureScript",
"python" => "The currently installed version of Python", "python" => "The currently installed version of Python",
"rlang" => "The currently installed version of R",
"red" => "The currently installed version of Red", "red" => "The currently installed version of Red",
"rlang" => "The currently installed version of R",
"ruby" => "The currently installed version of Ruby", "ruby" => "The currently installed version of Ruby",
"rust" => "The currently installed version of Rust", "rust" => "The currently installed version of Rust",
"scala" => "The currently installed version of Scala", "scala" => "The currently installed version of Scala",
"swift" => "The currently installed version of Swift",
"shell" => "The currently used shell indicator", "shell" => "The currently used shell indicator",
"shlvl" => "The current value of SHLVL", "shlvl" => "The current value of SHLVL",
"singularity" => "The currently used Singularity image",
"status" => "The status of the last command", "status" => "The status of the last command",
"swift" => "The currently installed version of Swift",
"terraform" => "The currently selected terraform workspace and version", "terraform" => "The currently selected terraform workspace and version",
"time" => "The current local time", "time" => "The current local time",
"username" => "The active user's username", "username" => "The active user's username",
"vlang" => "The currently installed version of V",
"vagrant" => "The currently installed version of Vagrant", "vagrant" => "The currently installed version of Vagrant",
"vcsh" => "The currently active VCSH repository", "vcsh" => "The currently active VCSH repository",
"vlang" => "The currently installed version of V",
"zig" => "The currently installed version of Zig", "zig" => "The currently installed version of Zig",
_ => "<no description>", _ => "<no description>",
} }
} }
#[cfg(test)]
mod test {
use super::*;
use crate::module::ALL_MODULES;
#[test]
fn all_modules_have_description() {
for module in ALL_MODULES {
println!("Checking if {:?} has a description", module);
assert_ne!(description(module), "<no description>");
}
}
}