plugin: add noTasksMessage support

Author: jamiebrynes7

plugin/src/query/parser.test.ts

@@ -108,6 +108,13 @@ describe("parseQuery - rejections", () => {
         show: "nonee",
       },
     },
+    {
+      description: "view.noTasksMessage must be string",
+      input: {
+        filter: "bar",
+        view: { noTasksMessage: 123 },
+      },
+    },
   ];
 
   for (const tc of testcases) {
@@ -135,6 +142,7 @@ function makeQuery(opts?: Partial<Query>): Query {
         ShowMetadataVariant.Deadline,
       ]),
     groupBy: opts?.groupBy ?? GroupVariant.None,
+    view: opts?.view ?? {},
   };
 }
 
@@ -291,6 +299,27 @@ describe("parseQuery", () => {
         show: new Set([ShowMetadataVariant.Section, ShowMetadataVariant.Project]),
       }),
     },
+    {
+      description: "with custom view.noTasksMessage",
+      input: {
+        filter: "bar",
+        view: { noTasksMessage: "All caught up!" },
+      },
+      expectedOutput: makeQuery({
+        filter: "bar",
+        view: { noTasksMessage: "All caught up!" },
+      }),
+    },
+    {
+      description: "without view defaults to empty object",
+      input: {
+        filter: "bar",
+      },
+      expectedOutput: makeQuery({
+        filter: "bar",
+        view: {},
+      }),
+    },
   ];
 
   for (const tc of testcases) {
@@ -352,6 +381,17 @@ describe("parseQuery - warnings", () => {
         "Both 'project' and 'section' show options are set. The 'section' option will be ignored when 'project' is present.",
       ],
     },
+    {
+      description: "Unknown nested key in view",
+      input: {
+        filter: "bar",
+        view: { unknownProp: "value" },
+      },
+      expectedWarnings: [
+        "This query is written using JSON. This is deprecated and will be removed in a future version. Please use YAML instead.",
+        "Found unexpected query key 'view.unknownProp'. Is this a typo?",
+      ],
+    },
   ];
 
   for (const tc of testcases) {

plugin/src/query/parser.ts

@@ -120,6 +120,13 @@ const groupBySchema = lookupToEnum({
   labels: GroupVariant.Label,
 });
 
+const viewSchema = z
+  .object({
+    noTasksMessage: z.string().optional(),
+  })
+  .optional()
+  .default({});
+
 const defaults = {
   name: "",
   autorefresh: 0,
@@ -132,6 +139,7 @@ const defaults = {
     ShowMetadataVariant.Deadline,
   ],
   groupBy: GroupVariant.None,
+  view: {},
 };
 
 const querySchema = z.object({
@@ -147,16 +155,30 @@ const querySchema = z.object({
     .optional()
     .transform((val) => val ?? defaults.show),
   groupBy: groupBySchema.optional().transform((val) => val ?? defaults.groupBy),
+  view: viewSchema,
 });
 
 const validQueryKeys: string[] = querySchema.keyof().options;
+const validNestedKeys: Record<string, string[]> = {
+  view: ["noTasksMessage"],
+};
 
 function parseObjectZod(query: Record<string, unknown>): [Query, QueryWarning[]] {
   const warnings: QueryWarning[] = [];
 
   for (const key of Object.keys(query)) {
     if (!validQueryKeys.includes(key)) {
       warnings.push(t().query.warning.unknownKey(key));
+    } else if (validNestedKeys[key]) {
+      // Validate nested keys
+      const nestedObj = query[key];
+      if (typeof nestedObj === "object" && nestedObj !== null) {
+        for (const nestedKey of Object.keys(nestedObj)) {
+          if (!validNestedKeys[key].includes(nestedKey)) {
+            warnings.push(t().query.warning.unknownKey(`${key}.${nestedKey}`));
+          }
+        }
+      }
     }
   }
 
@@ -184,6 +206,7 @@ function parseObjectZod(query: Record<string, unknown>): [Query, QueryWarning[]]
       sorting: out.data.sorting,
       show,
       groupBy: out.data.groupBy,
+      view: out.data.view,
     },
     warnings,
   ];

plugin/src/query/query.ts

@@ -29,11 +29,16 @@ export enum GroupVariant {
   Label = 5,
 }
 
+export type ViewOptions = {
+  noTasksMessage?: string;
+};
+
 export type Query = {
   name: string;
   filter: string;
   autorefresh: number;
   sorting: SortingVariant[];
   show: Set<ShowMetadataVariant>;
   groupBy: GroupVariant;
+  view: ViewOptions;
 };

plugin/src/query/replacements.test.ts

@@ -58,6 +58,7 @@ describe("applyReplacements", () => {
           groupBy: GroupVariant.None,
           sorting: [],
           show: new Set(),
+          view: {},
         };
 
         applyReplacements(query, new FakeContext(tc.filePath ?? ""));

plugin/src/ui/query/QueryRoot.tsx

@@ -151,7 +151,7 @@ const QueryResponseHandler: React.FC<{
 
   const tasks = result.tasks;
   if (tasks.length === 0) {
-    return <Displays.Empty />;
+    return <Displays.Empty message={query.view.noTasksMessage} />;
   }
 
   if (query.groupBy !== GroupVariant.None) {

plugin/src/ui/query/displays/EmptyDisplay.tsx

@@ -3,7 +3,13 @@ import type React from "react";
 import { t } from "@/i18n";
 import { Callout } from "@/ui/components/callout";
 
-export const EmptyDisplay: React.FC = () => {
+type Props = {
+  message?: string;
+};
+
+export const EmptyDisplay: React.FC<Props> = ({ message }) => {
   const i18n = t().query.displays.empty;
-  return <Callout className="todoist-no-tasks" title={i18n.label} iconId="info" />;
+  const displayMessage = message ?? i18n.label;
+
+  return <Callout className="todoist-no-tasks" title={displayMessage} iconId="info" />;
 };