plugin: add support for 'section' in 'show' query param

Author: jamiebrynes7

plugin/src/i18n/langs/en.ts

@@ -253,6 +253,8 @@ export const en: Translations = {
       unknownKey: (key: string) => `Found unexpected query key '${key}'. Is this a typo?`,
       dueAndTime:
         "Both 'due' and 'time' show options are set. The 'time' option will be ignored when 'due' is present.",
+      projectAndSection:
+        "Both 'project' and 'section' show options are set. The 'section' option will be ignored when 'project' is present.",
     },
     groupedHeaders: {
       noDueDate: "No due date",

plugin/src/i18n/translation.ts

@@ -227,6 +227,7 @@ export type Translations = {
       jsonQuery: string;
       unknownKey: (key: string) => string;
       dueAndTime: string;
+      projectAndSection: string;
     };
     groupedHeaders: {
       noDueDate: string;

plugin/src/query/__snapshots__/parser.test.ts.snap

@@ -66,9 +66,9 @@ exports[`parseQuery - error message snapshots > show array must contain strings
 [Error: Field 'show' has the following issues:
   Invalid input: expected "none"
 Field 'show' elements have the following issues:
-  Item 'show[0]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"
-  Item 'show[1]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"
-  Item 'show[2]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"]
+  Item 'show[0]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"|"section"
+  Item 'show[1]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"|"section"
+  Item 'show[2]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"|"section"]
 `;
 
 exports[`parseQuery - error message snapshots > show field - invalid literal (not 'none') 1`] = `
@@ -81,8 +81,8 @@ exports[`parseQuery - error message snapshots > show must have valid enum values
 [Error: Field 'show' has the following issues:
   Invalid input: expected "none"
 Field 'show' elements have the following issues:
-  Item 'show[0]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"
-  Item 'show[1]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"]
+  Item 'show[0]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"|"section"
+  Item 'show[1]': Invalid option: expected one of "due"|"date"|"description"|"labels"|"project"|"deadline"|"time"|"section"]
 `;
 
 exports[`parseQuery - error message snapshots > sorting array must contain strings 1`] = `

plugin/src/query/parser.test.ts

@@ -269,6 +269,28 @@ describe("parseQuery", () => {
         show: new Set([ShowMetadataVariant.Due, ShowMetadataVariant.Time]),
       }),
     },
+    {
+      description: "with show including section",
+      input: {
+        filter: "bar",
+        show: ["section"],
+      },
+      expectedOutput: makeQuery({
+        filter: "bar",
+        show: new Set([ShowMetadataVariant.Section]),
+      }),
+    },
+    {
+      description: "with show including section and project",
+      input: {
+        filter: "bar",
+        show: ["section", "project"],
+      },
+      expectedOutput: makeQuery({
+        filter: "bar",
+        show: new Set([ShowMetadataVariant.Section, ShowMetadataVariant.Project]),
+      }),
+    },
   ];
 
   for (const tc of testcases) {
@@ -319,6 +341,17 @@ describe("parseQuery - warnings", () => {
         "Both 'due' and 'time' show options are set. The 'time' option will be ignored when 'due' is present.",
       ],
     },
+    {
+      description: "Both project and section in show options",
+      input: {
+        filter: "bar",
+        show: ["project", "section"],
+      },
+      expectedWarnings: [
+        "This query is written using JSON. This is deprecated and will be removed in a future version. Please use YAML instead.",
+        "Both 'project' and 'section' show options are set. The 'section' option will be ignored when 'project' is present.",
+      ],
+    },
   ];
 
   for (const tc of testcases) {

plugin/src/query/parser.ts

@@ -108,6 +108,7 @@ const showSchema = lookupToEnum({
   project: ShowMetadataVariant.Project,
   deadline: ShowMetadataVariant.Deadline,
   time: ShowMetadataVariant.Time,
+  section: ShowMetadataVariant.Section,
 });
 
 const groupBySchema = lookupToEnum({
@@ -171,6 +172,10 @@ function parseObjectZod(query: Record<string, unknown>): [Query, QueryWarning[]]
     warnings.push(t().query.warning.dueAndTime);
   }
 
+  if (show.has(ShowMetadataVariant.Project) && show.has(ShowMetadataVariant.Section)) {
+    warnings.push(t().query.warning.projectAndSection);
+  }
+
   return [
     {
       name: out.data.name,

plugin/src/query/query.ts

@@ -17,6 +17,7 @@ export enum ShowMetadataVariant {
   Description = 3,
   Deadline = 4,
   Time = 5,
+  Section = 6,
 }
 
 export enum GroupVariant {

plugin/src/ui/query/task/TaskMetadata.tsx

@@ -51,6 +51,26 @@ const projectMeta: MetadataDefinition = {
   side: "right",
 };
 
+const sectionMeta: MetadataDefinition = {
+  name: "section",
+  isShown: (query, task) =>
+    query.show.has(ShowMetadataVariant.Section) &&
+    !query.show.has(ShowMetadataVariant.Project) &&
+    task.section !== undefined,
+  content: (task) => [
+    {
+      content: task.section!.name,
+    },
+  ],
+  icons: {
+    after: {
+      id: "gallery-vertical",
+      shouldRender: (settings) => settings.renderProjectIcon,
+    },
+  },
+  side: "right",
+};
+
 const dueDateMeta: MetadataDefinition = {
   name: "due",
   isShown: (query, task) => query.show.has(ShowMetadataVariant.Due) && task.due !== undefined,
@@ -128,6 +148,7 @@ const timeOnlyMeta: MetadataDefinition = {
 
 const metadata: MetadataDefinition[] = [
   projectMeta,
+  sectionMeta,
   dueDateMeta,
   deadlineMeta,
   labelsMeta,