feat: add support for common platform flag

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
kbdharun · Feb 20, 2024 · 015b01f · 015b01f
1 parent 06b3e7a
commit 015b01f
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 6 deletions.
diff --git a/completion/bash_tealdeer b/completion/bash_tealdeer
@@ -14,7 +14,7 @@ _tealdeer()
 			return
 			;;
 		-p|--platform)
-			COMPREPLY=( $(compgen -W 'linux macos sunos windows android freebsd netbsd openbsd' -- "${cur}") )
+			COMPREPLY=( $(compgen -W 'common linux macos sunos windows android freebsd netbsd openbsd' -- "${cur}") )
 			return
 			;;
 		--color)

diff --git a/completion/fish_tealdeer b/completion/fish_tealdeer
@@ -7,7 +7,7 @@ complete -c tldr -s h -l help           -d 'Print the help message.' -f
 complete -c tldr -s v -l version        -d 'Show version information.' -f
 complete -c tldr -s l -l list           -d 'List all commands in the cache.' -f
 complete -c tldr -s f -l render         -d 'Render a specific markdown file.' -r
-complete -c tldr -s p -l platform       -d 'Override the operating system.' -xa 'linux macos sunos windows android freebsd netbsd openbsd'
+complete -c tldr -s p -l platform       -d 'Override the operating system.' -xa 'common linux macos sunos windows android freebsd netbsd openbsd'
 complete -c tldr -s L -l language       -d 'Override the language' -x
 complete -c tldr -s u -l update         -d 'Update the local cache.' -f
 complete -c tldr      -l no-auto-update -d 'If auto update is configured, disable it for this run.' -f

diff --git a/completion/zsh_tealdeer b/completion/zsh_tealdeer
@@ -16,6 +16,7 @@ _tealdeer() {
         "($I -l --list)"{-l,--list}"[List all commands in the cache]"
         "($I -f --render)"{-f,--render}"[Render a specific markdown file]:file:_files"
         "($I -p --platform)"{-p,--platform}'[Override the operating system]:platform:((
+            common
             linux
             macos
             sunos

diff --git a/docs/src/usage.txt b/docs/src/usage.txt
@@ -11,8 +11,8 @@ ARGS:
 OPTIONS:
     -l, --list                    List all commands in the cache
     -f, --render <FILE>           Render a specific markdown file
-    -p, --platform <PLATFORMS>    Override the operating system [possible values: linux, macos,
-                                  windows, sunos, osx, android, freebsd, netbsd, openbsd]
+    -p, --platform <PLATFORMS>    Override the operating system [possible values: common, linux,
+                                  macos, windows, sunos, osx, android, freebsd, netbsd, openbsd]
     -L, --language <LANGUAGE>     Override the language
     -u, --update                  Update the local cache
         --no-auto-update          If auto update is configured, disable it for this run

diff --git a/src/cache.rs b/src/cache.rs
@@ -213,6 +213,7 @@ impl Cache {
     /// Return the platform directory.
     fn get_platform_dir(platform: PlatformType) -> &'static str {
         match platform {
+            PlatformType::Common => "common",
             PlatformType::Linux => "linux",
             PlatformType::OsX => "osx",
             PlatformType::SunOs => "sunos",

diff --git a/src/cli.rs b/src/cli.rs
@@ -40,7 +40,7 @@ pub(crate) struct Args {
         short = 'p',
         long = "platform",
         action = ArgAction::Append,
-        possible_values = ["linux", "macos", "windows", "sunos", "osx", "android", "freebsd", "netbsd", "openbsd"],
+        possible_values = ["common", "linux", "macos", "windows", "sunos", "osx", "android", "freebsd", "netbsd", "openbsd"],
     )]
     pub platforms: Option<Vec<PlatformType>>,
 

diff --git a/src/types.rs b/src/types.rs
@@ -9,6 +9,7 @@ use serde_derive::{Deserialize, Serialize};
 #[serde(rename_all = "lowercase")]
 #[allow(dead_code)]
 pub enum PlatformType {
+    Common,
     Linux,
     OsX,
     SunOs,
@@ -22,6 +23,7 @@ pub enum PlatformType {
 impl fmt::Display for PlatformType {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
+            Self::Common => write!(f, "Common"),
             Self::Linux => write!(f, "Linux"),
             Self::OsX => write!(f, "macOS / BSD"),
             Self::SunOs => write!(f, "SunOS"),
@@ -39,6 +41,7 @@ impl str::FromStr for PlatformType {
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match s {
+            "common" => Ok(Self::Common),
             "linux" => Ok(Self::Linux),
             "osx" | "macos" => Ok(Self::OsX),
             "sunos" => Ok(Self::SunOs),
@@ -48,7 +51,7 @@ impl str::FromStr for PlatformType {
             "netbsd" => Ok(Self::NetBSD),
             "openbsd" => Ok(Self::OpenBSD),
             other => Err(anyhow!(
-                "Unknown OS: {}. Possible values: linux, macos, osx, sunos, windows, android, freebsd, netbsd, openbsd",
+                "Unknown OS: {}. Possible values: common, linux, macos, osx, sunos, windows, android, freebsd, netbsd, openbsd",
                 other
             )),
         }
@@ -91,7 +94,13 @@ impl PlatformType {
         Self::OpenBSD
     }
 
+    #[cfg(any(target_os = "common",))]
+    pub fn current() -> Self {
+        Self::Common
+    }
+
     #[cfg(not(any(
+        target_os = "common",
         target_os = "linux",
         target_os = "macos",
         target_os = "freebsd",
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ _tealdeer() { @@
             "($I -l --list)"{-l,--list}"[List all commands in the cache]"
             "($I -f --render)"{-f,--render}"[Render a specific markdown file]:file:_files"
             "($I -p --platform)"{-p,--platform}'[Override the operating system]:platform:((
+                common
                 linux
                 macos
                 sunos
@@ Expand Down @@