Feature/inprogress todo state

src/@types/Todo.ts

@@ -14,6 +14,7 @@ export interface TodoObject {
 
   priority: string | null;
   hidden: boolean;
+  inprogress: string | null;
   due: string | null;
   dueString: string | null;
   t: string | null;
@@ -50,6 +51,7 @@ export type AttributeKey =
   | "rec"
   | "pm"
   | "hidden"
+  | "inprogress"
   | "created"
   | "completed";
 

src/@types/UI.ts

@@ -20,6 +20,7 @@ export interface PromptItem {
 export interface ContextMenuItem {
   id: string;
   label: string;
+  hint?: string;
   promptItem?: PromptItem;
   function?: () => void;
 }

src/locales/en.json

@@ -7,6 +7,9 @@
   "remove": "Remove",
   "add": "Add",
   "archive": "Archive",
+  "markInProgress": "Mark in progress",
+  "removeInProgress": "Remove in progress",
+  "middleClick": "Middle-click",
   "settings": "Settings",
   "close": "Close",
   "attributes": "Attributes",
@@ -80,6 +83,7 @@
   "shared.attributeMapping.pm": "Pomodoros",
   "shared.attributeMapping.created": "Creation date",
   "shared.attributeMapping.completed": "Completion date",
+  "shared.attributeMapping.inprogress": "In progress",
   "splashscreen.noFiles.text": "Open an existing todo.txt file or create a new one",
   "splashscreen.noTodosAvailable.text": "No todos in this file",
   "splashscreen.noTodosAvailable.create": "Create a todo",

src/main/Attributes.test.ts

@@ -41,6 +41,7 @@ function todo(overrides: Partial<TodoObject> = {}): TodoObject {
     notify: false,
     hidden: false,
     complete: false,
+    inprogress: null,
     lineNumber: 1,
     body: "",
     string: "",

src/main/Attributes.ts

@@ -29,6 +29,7 @@ let attributes: Attributes = {
   rec: {},
   pm: {},
   hidden: {},
+  inprogress: {},
   created: {},
   completed: {},
 };

src/main/DataRequest/AttributeModifier.test.ts

@@ -0,0 +1,13 @@
+import { expect, describe, it } from "vitest";
+import { deleteAttributeValue } from "./AttributeModifier";
+
+describe("deleteAttributeValue", () => {
+  it("removes inprogress regardless of the passed value", () => {
+    const lines = ["Todo 1 inprogress:1", "Todo 2"];
+
+    const { count } = deleteAttributeValue(lines, "inprogress", "In progress");
+
+    expect(count).toBe(1);
+    expect(lines).toEqual(["Todo 1", "Todo 2"]);
+  });
+});

src/main/DataRequest/AttributeModifier.ts

@@ -162,6 +162,16 @@ export function deleteAttributeValue(
         }
         break;
       }
+      case "inprogress": {
+        // A flag, removed regardless of the value, which the sidebar passes as its label.
+        const item = new Item(newLine);
+        if (item.extensions().some((e) => e.key === "inprogress")) {
+          item.removeExtension("inprogress");
+          newLine = item.toString();
+          modified = true;
+        }
+        break;
+      }
       case "created":
       case "completed": {
         const item = new Item(newLine);

src/main/DataRequest/ChangeCompleteState.test.ts

@@ -45,6 +45,10 @@ describe("changeCompleteState", () => {
       changeCompleteState(todo, true);
       expect(createRecurringTodo).toHaveBeenCalledWith(todo, "1b");
     });
+    it("removes inprogress extension when marking complete", () => {
+      const r = changeCompleteState("My todo inprogress:1", true);
+      expect(r).not.toContain("inprogress:1");
+    });
   });
 
   describe("change to uncompleted", () => {

src/main/DataRequest/ChangeCompleteState.ts

@@ -26,6 +26,8 @@ function changeCompleteState(string: string, state: boolean): string {
       JsTodoTxtObject.setPriority(null);
       JsTodoTxtObject.setExtension("pri", currentPriority);
     }
+
+    JsTodoTxtObject.removeExtension("inprogress");
   } else {
     JsTodoTxtObject.setCompleted(null);
     restorePreviousPriority(JsTodoTxtObject);

src/main/DataRequest/CreateTodoObjects.test.ts

@@ -66,6 +66,17 @@ describe("createTodoObject", () => {
     });
   });
 
+  describe("create in-progress todo", () => {
+    it("sets inprogress to 1", () => {
+      const todo = createTodoObject(1, "I am in progress inprogress:1");
+      expect(todo.inprogress).toBe("1");
+    });
+    it("sets inprogress to null for other values", () => {
+      const todo = createTodoObject(1, "I am in progress inprogress:2");
+      expect(todo.inprogress).toBeNull();
+    });
+  });
+
   describe("create todo with updates", () => {
     it("updates priority", () => {
       const todo = createTodoObject(1, "(B) todo", "priority", "A");

src/main/DataRequest/CreateTodoObjects.ts

@@ -61,6 +61,11 @@ function createTodoObject(
   const hidden = extensions.some(
     (extension) => extension.key === "h" && extension.value === "1",
   );
+  const inprogress = extensions.some(
+    (extension) => extension.key === "inprogress" && extension.value === "1",
+  )
+    ? "1"
+    : null;
   const stringPm: string | null =
     extensions.find((extension) => extension.key === "pm")?.value || null;
   const rec =
@@ -111,6 +116,7 @@ function createTodoObject(
     tString,
     rec,
     hidden,
+    inprogress,
     pm,
     string: content,
   };

src/main/DataRequest/DataRequest.ts

@@ -49,6 +49,7 @@ function dataRequest(passedSearchString: string = ""): RequestedData | null {
         rec: {},
         pm: {},
         hidden: {},
+        inprogress: {},
         created: {},
         completed: {},
       },
@@ -62,6 +63,7 @@ function dataRequest(passedSearchString: string = ""): RequestedData | null {
         rec: [],
         pm: [],
         hidden: [],
+        inprogress: [],
         created: [],
         completed: [],
       },

src/main/DataRequest/Sort.test.ts

@@ -268,3 +268,16 @@ describe("rec sorting", () => {
     });
   });
 });
+
+describe("inprogress sorting", () => {
+  it("sorts in-progress todos last when inverted", () => {
+    const todos = [
+      createTodoObject(1, "Todo 1 inprogress:1"),
+      createTodoObject(2, "Todo 2"),
+    ];
+    todos.sort((a, b) =>
+      sortTodoObjects(a, b, [{ value: "inprogress", invert: true }]),
+    );
+    expect(todos.map((todo) => todo.lineNumber)).toEqual([2, 1]);
+  });
+});

src/main/DataRequest/Sort.ts

@@ -95,6 +95,10 @@ const sortTodoObjects = (
       } else {
         compareResult = invert ? keyB - keyA : keyA - keyB;
       }
+    } else if (value === "inprogress") {
+      // A flag has only one value to order by, so invert moves in-progress todos last instead
+      compareResult =
+        compareValues(a.inprogress, b.inprogress, false) * (invert ? -1 : 1);
     } else {
       compareResult = compareValues(a[value], b[value], invert);
     }

src/main/Stores.ts

@@ -159,6 +159,16 @@ const migrations = {
     if (config.get("welcomeScreenShown") === undefined) {
       config.set("welcomeScreenShown", false);
     }
+
+    const sorting = config.get("sorting");
+    config.set("sorting", [
+      ...sorting,
+      { id: String(sorting.length + 1), value: "inprogress", invert: false },
+    ]);
+    config.set("accordionOpenState", [
+      ...config.get("accordionOpenState"),
+      false,
+    ]);
   },
 };
 

src/renderer/ContextMenu.tsx

@@ -1,6 +1,8 @@
 import React, { memo, useRef, useEffect } from "react";
 import Menu from "@mui/material/Menu";
 import MenuItem from "@mui/material/MenuItem";
+import ListItemText from "@mui/material/ListItemText";
+import Typography from "@mui/material/Typography";
 import "./ContextMenu.scss";
 import { ContextMenu, ContextMenuItem, PromptItem } from "@sleek-types";
 
@@ -58,7 +60,16 @@ const ContextMenuComponent: React.FC<ContextMenuComponentProps> = memo(
               data-testid={`contextMenu-item-${contextMenuItem.id}`}
               onClick={() => onClick(contextMenuItem)}
             >
-              {contextMenuItem.label}
+              <ListItemText>{contextMenuItem.label}</ListItemText>
+              {contextMenuItem.hint && (
+                <Typography
+                  variant="body2"
+                  color="text.secondary"
+                  sx={{ ml: 3 }}
+                >
+                  {contextMenuItem.hint}
+                </Typography>
+              )}
             </MenuItem>
           ))}
       </Menu>

src/renderer/Drawer/Attributes.tsx

@@ -68,9 +68,11 @@ function buildDisplayBuckets(
 
   for (const [rawKey, entry] of Object.entries(rawGroup)) {
     const bucketNames =
-      settings.useHumanFriendlyDates && isDate
-        ? friendlyDate(rawKey, attributeKey, settings, t)
-        : [rawKey];
+      attributeKey === "inprogress"
+        ? [t("shared.attributeMapping.inprogress")]
+        : settings.useHumanFriendlyDates && isDate
+          ? friendlyDate(rawKey, attributeKey, settings, t)
+          : [rawKey];
 
     for (const bucketName of bucketNames) {
       if (!buckets[bucketName]) {

src/renderer/Grid/Group.tsx

@@ -1,6 +1,7 @@
 import React, { memo } from "react";
 import ListItem from "@mui/material/ListItem";
 import Divider from "@mui/material/Divider";
+import { useTranslation } from "react-i18next";
 import { HandleFilterSelect, IsSelected } from "../Shared";
 import { AttributeKey, Filters, SnackbarAction } from "@sleek-types";
 import { useAttributeContextMenu } from "../Shared/useAttributeContextMenu";
@@ -24,6 +25,7 @@ const Group: React.FC<GroupProps> = memo(
     settings,
     onNotification,
   }) => {
+    const { t } = useTranslation();
     const { handleContextMenu } = useAttributeContextMenu({
       setContextMenu,
       settings,
@@ -68,7 +70,9 @@ const Group: React.FC<GroupProps> = memo(
                 onContextMenu={(e) => handleContextMenu(e, value, attributeKey)}
                 data-testid={`datagrid-group-button-${attributeKey}`}
               >
-                {value}
+                {attributeKey === "inprogress"
+                  ? t("shared.attributeMapping.inprogress")
+                  : value}
               </button>
             </div>
           );

src/renderer/Grid/Renderer.tsx

@@ -52,6 +52,11 @@ const RendererComponent: React.FC<RendererComponentProps> = memo(
       { pattern: /(?:^|\s)@(\S+)/, type: "contexts", key: "@" },
       { pattern: /(?:^|\s)\+(\S+)/, type: "projects", key: "+" },
       { pattern: /(?:^|\s)h:1\b/, type: "hidden", key: "h:1" },
+      {
+        pattern: /(?:^|\s)inprogress:1\b/,
+        type: "inprogress",
+        key: "inprogress:1",
+      },
       { pattern: /(?:^|\s)pm:(\d+)/, type: "pm", key: "pm:" },
       { pattern: /(?:^|\s)rec:([^ ]+)/, type: "rec", key: "rec:" },
       {
@@ -217,6 +222,7 @@ const RendererComponent: React.FC<RendererComponentProps> = memo(
       ),
 
       hidden: () => null as React.ReactNode,
+      inprogress: () => null as React.ReactNode,
 
       url: (value) => (
         <a

src/renderer/Grid/Row.scss

@@ -30,6 +30,9 @@
   &[data-hidden="true"] {
     filter: opacity(50%) grayscale(100%);
   }
+  &[data-inprogress="1"] {
+    border-left-color: var(--semantic-warning);
+  }
   &:last-child {
     border-bottom-left-radius: 0.25em;
   }