feat(ux): ✨ add tgl help command (#65)

JamesNZL · Jun 24, 2023 · 2101067 · 2101067
1 parent d376738
commit 2101067
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/Settings.cs b/src/Settings.cs
@@ -17,6 +17,7 @@ public class Settings
 		internal const string ReportsCommand = "reports";
 		internal const string BrowserCommand = "browser";
 		internal const string RefreshCommand = "refresh";
+		internal const string HelpCommand = "help";
 		internal static readonly string[] Commands = new string[] {
 			StartCommand,
 			StopCommand,
@@ -26,6 +27,7 @@ public class Settings
 			ReportsCommand,
 			BrowserCommand,
 			RefreshCommand,
+			HelpCommand,
 		};
 
 		internal const string EditProjectFlag = "-p";

diff --git a/src/TogglTrack.cs b/src/TogglTrack.cs
@@ -554,6 +554,19 @@ internal async ValueTask<List<Result>> GetDefaultHotKeys(bool prefetch = false)
 					},
 				},
 				new Result
+				{
+					Title = Settings.HelpCommand,
+					SubTitle = "Read plugin documentation",
+					IcoPath = "tip.png",
+					AutoCompleteText = $"{this._context.CurrentPluginMetadata.ActionKeyword} {Settings.HelpCommand} ",
+					Score = 75,
+					Action = c =>
+					{
+						this._context.API.OpenUrl(new Uri(@"https://github.com/JamesNZL/flow-toggl-plugin/blob/main/README.md"));
+						return true;
+					},
+				},
+				new Result
 				{
 					Title = Settings.RefreshCommand,
 					SubTitle = "Refresh plugin cache",