Merge pull request #345 from DevTKSS/docs(targetplatforms)UpdateTarge…

…tPlattforms Docs(targetplatforms):Updated Target Plattforms
unoplatform · Feb 26, 2025 · b944190 · b944190
2 parents 19937a4 + ed2454b
commit b944190
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 28 deletions.
diff --git a/UnoCheck/TargetPlatformHelper.cs b/UnoCheck/TargetPlatformHelper.cs
@@ -24,11 +24,16 @@ public static TargetPlatform GetTargetPlatformsFromFlags(string[]? targetPlatfor
 
 			return output;
 		}
-
+        /// <summary>
+        /// Converts the string provided uno-check input argument to the corresponding <see cref="TargetPlatform"/>
+        /// </summary>
+        /// <param name="flag">The user-provided argument as <see langword="string"/></param>
+        /// <returns>The <see cref="TargetPlatform"/> from the <paramref name="flag"/></returns>
 		public static TargetPlatform GetTargetPlatformFromFlag(string flag)
 		{
 			switch (flag.ToLowerInvariant())
 			{
+                case "web":
 				case "webassembly":
 				case "wasm":
 					return TargetPlatform.WebAssembly;
@@ -39,24 +44,20 @@ public static TargetPlatform GetTargetPlatformFromFlag(string flag)
 					return TargetPlatform.Android;
 				case "macos":
 					return TargetPlatform.macOS;
-				case "skiadesktop":
-					return TargetPlatform.SkiaDesktop;
-                case "windows":
+                case "winappsdk":
                 case "wasdk":
 					return TargetPlatform.WinAppSDK;
+                case "windows":
                 case "win32desktop":
                 case "win32":
                     return TargetPlatform.Windows;
+                case "skiadesktop":
 				case "skia":
 					return TargetPlatform.SkiaDesktop;
 				case "linux":
 					return TargetPlatform.SkiaDesktop;
-				case "web":
-					return TargetPlatform.WebAssembly;
-
 				case "all":
 					return TargetPlatform.All;
-
 				default:
 					return TargetPlatform.None;
 			}

diff --git a/doc/configuring-uno-check.md b/doc/configuring-uno-check.md
@@ -8,25 +8,24 @@ uid: UnoCheck.Configuration
 
 It is possible to run Uno.Check to setup your build environment in a repeatable way by using the following commands:
 
-# [**Windows**](#tab/windows)
+## [**Windows**](#tab/windows)
 
 ```bash
-dotnet tool install --global Uno.Check --version 1.20.0
+dotnet tool install --global Uno.Check --version 1.29.4
 uno-check -v --ci --non-interactive --fix --skip vswin --skip androidemulator --skip androidsdk
 ```
 
-# [**macOS**](#tab/macos)
+## [**macOS**](#tab/macos)
 
 ```bash
-dotnet tool install --global Uno.Check --version 1.20.0
+dotnet tool install --global Uno.Check --version 1.29.4
 uno-check -v --ci --non-interactive --fix --skip xcode --skip androidemulator --skip androidsdk
 ```
 
-
-# [**Linux**](#tab/linux)
+## [**Linux**](#tab/linux)
 
 ```bash
-dotnet tool install --global Uno.Check --version 1.20.0
+dotnet tool install --global Uno.Check --version 1.29.4
 uno-check -v --ci --non-interactive --fix --skip androidemulator
 ```
 
@@ -61,19 +60,22 @@ So, for example, the following will only check your environment for web and Linu
 uno-check --target wasm --target linux
 ```
 
-The following argument values for `--target` are supported:
-
-| Value     | Comments          |
-|-----------|-------------------|
-| wasm      |                   |
-| ios       |                   |
-| android   |                   |
-| macos     |                   |
-| linux     |                   |
-| skiawpf   |                   |
-| uwp       |                   |
-| win32     |                   |
-| all       | All platforms     |
+> [!Note:]
+> When specifying multiple target platforms, each element must be preceded by --target.
+> It is not possible to list multiple values without this prefix.
+
+Supported target platforms and their `--target` values:
+
+| Target Platform  | Input Values                       |
+|------------------|------------------------------------|
+| WebAssembly      | `web`, `webassembly`, `wasm`       |
+| iOS              | `ios`                              |
+| Android          | `android`, `droid`                 |
+| macOS            | `macos`                            |
+| SkiaDesktop      | `skiadesktop`, `skia`, `linux`     |
+| WinAppSDK        | `winappsdk`, `wasdk`               |
+| Windows          | `windows`, `win32desktop`, `win32` |
+| All Platforms    | `all`                              |
 
 ### `-m <FILE_OR_URL>`, `--manifest <FILE_OR_URL>` Manifest File or Url