feat(ux): 🚸 add tgl edit flag to clear description (#66)

JamesNZL · Jun 23, 2023 · d499a9b · d499a9b
1 parent 2363573
commit d499a9b
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 45 deletions.
diff --git a/src/Settings.cs b/src/Settings.cs
@@ -29,6 +29,7 @@ public class Settings
 		};
 
 		internal const string EditProjectFlag = "-p";
+		internal const string ClearDescriptionFlag = "-C";
 		internal const string TimeSpanFlag = "-t";
 		internal const string TimeSpanEndFlag = "-T";
 

diff --git a/src/TogglTrack.cs b/src/TogglTrack.cs
@@ -1326,7 +1326,7 @@ internal async ValueTask<List<Result>> RequestEditEntry(CancellationToken token,
 				this._state.SelectedIds.Project = timeEntry.ProjectId;
 
 				// If the -p flag exists, set up next request for project selection
-				if (Array.IndexOf(query.SearchTerms, Settings.EditProjectFlag) != -1)
+				if (query.SearchTerms.Contains(Settings.EditProjectFlag))
 				{
 					this._state.SelectedIds.Project = -1;
 					this._state.EditProject = TogglTrack.EditProjectState.NoProjectSelected;
@@ -1387,6 +1387,38 @@ internal async ValueTask<List<Result>> RequestEditEntry(CancellationToken token,
 					});
 			}
 
+			var results = new List<Result>();
+
+			if (query.SearchTerms.Contains(Settings.ClearDescriptionFlag))
+			{
+				string queryToDescription = string.Join(
+					" ",
+					query.SearchTerms.Take(
+						(this._state.EditProject == TogglTrack.EditProjectState.ProjectSelected)
+							? ArgumentIndices.DescriptionWithProject
+							: ArgumentIndices.DescriptionWithoutProject
+					)
+				);
+
+				this._context.API.ChangeQuery($"{query.ActionKeyword} {queryToDescription} ");
+			}
+			else if (this._settings.ShowUsageTips)
+			{
+				results.Add(new Result
+				{
+					Title = "Usage Tip",
+					SubTitle = $"Use {Settings.ClearDescriptionFlag} to quickly clear the description",
+					IcoPath = "tip.png",
+					AutoCompleteText = $"{query.ActionKeyword} {query.Search} {Settings.ClearDescriptionFlag} ",
+					Score = 2,
+					Action = c =>
+					{
+						this._context.API.ChangeQuery($"{query.ActionKeyword} {query.Search} {Settings.ClearDescriptionFlag} ");
+						return false;
+					}
+				});
+			}
+
 			var project = me.GetProject(this._state.SelectedIds.Project);
 
 			string projectName = project?.WithClientName ?? "No Project";
@@ -1397,60 +1429,57 @@ internal async ValueTask<List<Result>> RequestEditEntry(CancellationToken token,
 					: ArgumentIndices.DescriptionWithoutProject
 			);
 
-			var results = new List<Result>
+			results.Add(new Result
 			{
-				new Result
+				Title = (string.IsNullOrEmpty(description)) ? timeEntry.Description : description,
+				SubTitle = $"{projectName} | {timeEntry.HumanisedElapsed} ({timeEntry.DetailedElapsed})",
+				IcoPath = this._colourIconProvider.GetColourIcon(project?.Colour, "edit.png"),
+				AutoCompleteText = $"{query.ActionKeyword} {(string.IsNullOrEmpty(description) ? ($"{query.Search} {timeEntry.Description}") : query.Search)} ",
+				Score = 10000,
+				Action = c =>
 				{
-					Title = (string.IsNullOrEmpty(description)) ? timeEntry.Description : description,
-					SubTitle = $"{projectName} | {timeEntry.HumanisedElapsed} ({timeEntry.DetailedElapsed})",
-					IcoPath = this._colourIconProvider.GetColourIcon(project?.Colour, "edit.png") ,
-					AutoCompleteText = $"{query.ActionKeyword} {(string.IsNullOrEmpty(description) ? ($"{query.Search} {timeEntry.Description}") : query.Search)} ",
-					Score = 10000,
-					Action = c =>
+					Task.Run(async delegate
 					{
-						Task.Run(async delegate
+						try
 						{
-							try
-							{
-								this._context.API.LogInfo("TogglTrack", $"{this._state.SelectedIds.Project}, {timeEntry.Id}, {timeEntry.Duration}, {timeEntry.Start}, {this._state.SelectedIds.Project}, {timeEntry.WorkspaceId}, {description}");
-
-								var editedTimeEntry = (await this._client.EditTimeEntry(
-									workspaceId: timeEntry.WorkspaceId,
-									projectId: this._state.SelectedIds.Project,
-									id: timeEntry.Id,
-									description: description,
-									duration: timeEntry.Duration,
-									tags: timeEntry.Tags,
-									billable: timeEntry.Billable
-								))?.ToTimeEntry(me);
-
-								if (editedTimeEntry?.Id is null)
-								{
-									throw new Exception("An API error was encountered.");
-								}
+							this._context.API.LogInfo("TogglTrack", $"{this._state.SelectedIds.Project}, {timeEntry.Id}, {timeEntry.Duration}, {timeEntry.Start}, {this._state.SelectedIds.Project}, {timeEntry.WorkspaceId}, {description}");
 
-								this.ShowSuccessMessage($"Edited {editedTimeEntry.GetRawDescription()}", $"{projectName} | {timeEntry.DetailedElapsed}", "edit.png");
+							var editedTimeEntry = (await this._client.EditTimeEntry(
+								workspaceId: timeEntry.WorkspaceId,
+								projectId: this._state.SelectedIds.Project,
+								id: timeEntry.Id,
+								description: description,
+								duration: timeEntry.Duration,
+								tags: timeEntry.Tags,
+								billable: timeEntry.Billable
+							))?.ToTimeEntry(me);
 
-								// Update cached running time entry state
-								this.RefreshCache();
-							}
-							catch (Exception exception)
+							if (editedTimeEntry?.Id is null)
 							{
-								this._context.API.LogException("TogglTrack", "Failed to edit time entry", exception);
-								this.ShowErrorMessage("Failed to edit time entry.", exception.Message);
-							}
-							finally
-							{
-								this._state.SelectedIds.TimeEntry = -1;
-								this._state.SelectedIds.Project = -1;
-								this._state.EditProject = TogglTrack.EditProjectState.NoProjectChange;
+								throw new Exception("An API error was encountered.");
 							}
-						});
 
-						return true;
-					},
+							this.ShowSuccessMessage($"Edited {editedTimeEntry.GetRawDescription()}", $"{projectName} | {timeEntry.DetailedElapsed}", "edit.png");
+
+							// Update cached running time entry state
+							this.RefreshCache();
+						}
+						catch (Exception exception)
+						{
+							this._context.API.LogException("TogglTrack", "Failed to edit time entry", exception);
+							this.ShowErrorMessage("Failed to edit time entry.", exception.Message);
+						}
+						finally
+						{
+							this._state.SelectedIds.TimeEntry = -1;
+							this._state.SelectedIds.Project = -1;
+							this._state.EditProject = TogglTrack.EditProjectState.NoProjectChange;
+						}
+					});
+
+					return true;
 				},
-			};
+			});
 
 			if (this._settings.ShowUsageWarnings && string.IsNullOrEmpty(description) && !string.IsNullOrEmpty(timeEntry.GetRawDescription()))
 			{