2.2.1 for DBW test: adds 'due date' option for Tag/Overdue sections

jgclark · jgclark · commit f7cb0928409b · 2025-04-16T00:29:59.000+01:00
diff --git a/jgclark.Dashboard/CHANGELOG.md b/jgclark.Dashboard/CHANGELOG.md
@@ -7,6 +7,10 @@ For more details see the [plugin's documentation](https://github.com/NotePlan/pl
 - TODO: ^⌥s triggers the search bar
 - TODO: fix long-standing layout bug where some tooltips were getting clipped
  -->
+## [2.2.1] 2025-04-???
+### New
+- you can now order results in Tag and Overdue sections by due date, as well as by the existing options (for @LauraH)
+
 ## [2.2.0] 2025-04-11
 ### New
 - Search section. Click on the new icon in the header and a small search bar opens up, where you can type a term to search for open tasks and checklists in regular or calendar notes. This uses the extended syntax from my separate [Search Extensions plugin](https://noteplan.co/plugins/jgclark.SearchExtensions/) to allow more complex searches than NotePlan natively allows.  The Search Section stays until either you manually refresh the dashboard, or you click the close `[x]` button. This means you can edit the items like any other section contents, and also use Interactive Processing.
diff --git a/jgclark.Dashboard/plugin.json b/jgclark.Dashboard/plugin.json
@@ -5,9 +5,9 @@
   "plugin.name": "🎛 Dashboard",
   "plugin.description": "A Dashboard for NotePlan, that in one place shows\n- a compact list of open tasks and checklists from today's note\n- scheduled open tasks and checklists from other notes.\n- Similarly for yesterday's note, tomorrow's note, and the weekly, monthly and quarterly notes too (if used)\n- all overdue tasks\n- all open tasks and checklists that contain particular @tags or #mentions of your choosing\n- the next notes ready to review (if you use the 'Projects and Reviews' plugin).",
   "plugin.author": "@jgclark",
-  "plugin.version": "2.2.0",
+  "plugin.version": "2.2.1",
   "plugin.hidden": false,
-  "plugin.lastUpdateInfo": "2.2.0: Add 'Search' section. New keyboard shortcuts. Plus many small improvements, bug fixes and performance improvements. See documentation for details.\n2.1.10: More move-under-heading options. Bug fixes and performance improvements.\n2.1.9: performance improvements and better UI for iPhone users.\n2.1.8: various fixes and small improvements.\n2.1.7: various fixes and small improvements.\n2.1.6: allow all current timeblocks to be shown, not just the first. Add new @repeat()s if using the extended syntax from the Repeat Extensions plugin. Bug fixes.\n2.1.5: fixes to time blocks and scheduling items.\n2.1.4: fix to Interactive Processing, and Edit All Perspectives dialog now shows unsaved changes.\n2.1.3: fixes to display of timeblocks, and checklist counts being wrong. Slightly smarter task dialog.\n2.1.2: fix bug - Today section not showing up; fix settings description for max items to show.\n2.1.1: fix bug - Tomorrow section not showing up.\n2.1.0: Add Perspectives; new 'Current Time Block' section; new 'Last Week' section; and many other improvements and fixes.\n2.0.0: major new release with many new features, following major re-write.",
+  "plugin.lastUpdateInfo": "2.2.1: Add new sorting option for Tag and Overdue sections.\n2.2.0: Add 'Search' section. New keyboard shortcuts. Plus many small improvements, bug fixes and performance improvements. See documentation for details.\n2.1.10: More move-under-heading options. Bug fixes and performance improvements.\n2.1.9: performance improvements and better UI for iPhone users.\n2.1.8: various fixes and small improvements.\n2.1.7: various fixes and small improvements.\n2.1.6: allow all current timeblocks to be shown, not just the first. Add new @repeat()s if using the extended syntax from the Repeat Extensions plugin. Bug fixes.\n2.1.5: fixes to time blocks and scheduling items.\n2.1.4: fix to Interactive Processing, and Edit All Perspectives dialog now shows unsaved changes.\n2.1.3: fixes to display of timeblocks, and checklist counts being wrong. Slightly smarter task dialog.\n2.1.2: fix bug - Today section not showing up; fix settings description for max items to show.\n2.1.1: fix bug - Tomorrow section not showing up.\n2.1.0: Add Perspectives; new 'Current Time Block' section; new 'Last Week' section; and many other improvements and fixes.\n2.0.0: major new release with many new features, following major re-write.",
   "plugin.dependencies": [],
   "plugin.requiredFiles": [
     "react.c.WebView.bundle.dev.js"
diff --git a/jgclark.Dashboard/src/dashboardHelpers.js b/jgclark.Dashboard/src/dashboardHelpers.js
@@ -1,7 +1,7 @@
 // @flow
 //-----------------------------------------------------------------------------
 // Dashboard plugin helper functions
-// Last updated 2025-04-10 for v2.2.0.a13
+// Last updated 2025-04-15 for v2.2.1, @jgclark
 //-----------------------------------------------------------------------------
 
 import moment from 'moment/min/moment-with-locales'
@@ -28,13 +28,15 @@ import { createRunPluginCallbackUrl, displayTitle } from '@helpers/general'
 import { getHeadingHierarchyForThisPara } from '@helpers/headings'
 import { sendToHTMLWindow, getGlobalSharedData } from '@helpers/HTMLView'
 import { filterOutParasInExcludeFolders, isNoteFromAllowedFolder, pastCalendarNotes, projectNotesFromFilteredFolders } from '@helpers/note'
+import { getFirstDateInPeriod } from '@helpers/NPdateTime'
 import { getReferencedParagraphs } from '@helpers/NPnote'
 import { isAChildPara } from '@helpers/parentsAndChildren'
+import { RE_FIRST_SCHEDULED_DATE_CAPTURE } from '@helpers/regex'
 import { caseInsensitiveSubstringIncludes } from '@helpers/search'
 import { getNumericPriorityFromPara } from '@helpers/sorting'
 import { eliminateDuplicateSyncedParagraphs } from '@helpers/syncedCopies'
 import { getStartTimeObjFromParaContent, getTimeBlockString, isActiveOrFutureTimeBlockPara } from '@helpers/timeblocks'
-import { isOpen, isOpenNotScheduled, removeDuplicates } from '@helpers/utils'
+import { hasScheduledDate, isOpen, isOpenNotScheduled, removeDuplicates } from '@helpers/utils'
 
 //-----------------------------------------------------------------
 // Settings
@@ -206,6 +208,23 @@ export function makeDashboardParas(origParas: Array<TParagraph>): Array<TParagra
         const anyChildren = p.children()
         const hasChild = anyChildren && anyChildren.length > 0
         const isAChild = isAChildPara(p, note)
+        let dueDateStr = 'none'
+        const hasDueDate = hasScheduledDate(p.content)
+        if (hasDueDate) {
+          const dueDateMatch = p.content.match(RE_FIRST_SCHEDULED_DATE_CAPTURE)
+          if (dueDateMatch) {
+            dueDateStr = getFirstDateInPeriod(dueDateMatch[0], 'day')
+          }
+        } else {
+          // If this is from a calendar note, then use that date instead
+          if (note.type === 'Calendar') {
+            const dueDate = getFirstDateInPeriod(note.title, 'day')
+            if (dueDate) {
+              dueDateStr = dueDate
+            }
+          }
+        }
+        // logDebug('makeDashboardParas', `dueDateStr: ${dueDateStr} in note ${note.filename}`)
 
         // Note: debugging why sometimes hasChild is wrong
         // TODO(later): remove this debugging
@@ -236,11 +255,11 @@ export function makeDashboardParas(origParas: Array<TParagraph>): Array<TParagra
           indentLevel: p.indents, // TEST: not returning correct indents at times?
           lineIndex: p.lineIndex,
           priority: getNumericPriorityFromPara(p),
-          // timeStr: startTime,
           startTime: startTimeStr,
           changedDate: note?.changedDate,
           hasChild: hasChild,
           isAChild: isAChild,
+          dueDate: dueDateStr,
         }
       } else {
         logWarn('makeDashboardParas', `No note found for para {${p.content}}`)
diff --git a/jgclark.Dashboard/src/dashboardSettings.js b/jgclark.Dashboard/src/dashboardSettings.js
@@ -1,7 +1,7 @@
 // @flow
 //-----------------------------------------------------------------------------
 // Settings for the dashboard - loaded/set in React Window
-// Last updated 2025-04-09 for v2.2.0.a12
+// Last updated 2025-04-15 for v2.2.1, @jgclark
 //-----------------------------------------------------------------------------
 import type { TSettingItem } from './types.js'
 import { clo, clof, logDebug } from '@helpers/react/reactDev'
@@ -243,6 +243,16 @@ export const dashboardSettingDefs: Array<TSettingItem> = [
     default: false,
     refreshAllOnChange: true,
   },
+  {
+    key: 'overdueSortOrder',
+    label: 'Sort order for Tag/Mention and Overdue items',
+    description:
+      "The order to show items: 'priority' shows the higher priority (from `>>`, `!!!`, `!!` and `!` markers), 'earliest' by earliest modified date of the note, 'due date' by the due date (if present), or 'most recent' changed note.",
+    type: 'dropdown-select',
+    options: ['priority', 'earliest', 'due date', 'most recent'],
+    default: 'priority',
+    compactDisplay: true,
+  },
   {
     label: 'Hide priority markers?',
     key: 'hidePriorityMarkers',
@@ -311,17 +321,6 @@ export const dashboardSettingDefs: Array<TSettingItem> = [
     type: 'heading',
     label: 'Overdue Tasks section',
   },
-  {
-    key: 'overdueSortOrder',
-    label: 'Sort order for Tag/Mention and Overdue items',
-    description:
-      "The order to show items: 'priority' shows the higher priority (from `>>`, `!!!`, `!!` and `!` markers), 'earliest' by earliest modified date of the note, or 'most recent' changed note.",
-    type: 'dropdown-select',
-    options: ['priority', 'earliest', 'most recent'],
-    default: 'priority',
-    compactDisplay: true,
-    // fixedWidth: 150,
-  },
   {
     key: 'lookBackDaysForOverdue',
     label: 'Number of days to look back for Overdue tasks',
diff --git a/jgclark.Dashboard/src/dataGeneration.js b/jgclark.Dashboard/src/dataGeneration.js
@@ -1,7 +1,7 @@
 // @flow
 //-----------------------------------------------------------------------------
 // Dashboard plugin main function to generate data
-// Last updated 2025-04-01 for v2.2.0.a10, @jgclark
+// Last updated 2025-04-15 for v2.2.1, @jgclark
 //-----------------------------------------------------------------------------
 
 import moment from 'moment/min/moment-with-locales'
@@ -547,33 +547,6 @@ export function getThisQuarterSectionData(config: TDashboardSettings, useDemoDat
 //   fa-calendar-days (same as quarter). This would be section #6
 //----------------------------------------------------------------
 
-/**
- * Note: now not used, as core of it is now in getSomeSectionsData() above. This is because:
- *  1. it is really just a wrapper around getTaggedSectionData()
- *  2. this means multiple TAG sections can be returned as they are generated, rather than all at once, which feels more natural.
- * Get the tagged sections for each tag - they will all be sectionCode=TAG
- * sectionName will be the tag name, and showSettingName will be unique for this tag
- * @param {TDashboardSettings} config
- * @param {boolean} [useDemoData=false]
- * @returns {Array<TSection>}
- */
-// export function getTaggedSections(config: TDashboardSettings, useDemoData: boolean = false): Array<TSection> {
-//   const startTime = new Date()
-//   const tagSections = getTagSectionDetails(removeInvalidTagSections(config))
-//   // clo(tagSections)
-//   // logInfo('getTaggedSections', `- after getTagSectionDetails:  ${timer(startTime)}`)
-//
-//   const output = tagSections.reduce((acc: Array<TSection>, sectionDetail: TSectionDetails, index: number) => {
-//     // $FlowIgnore[invalid-computed-prop]
-//     const showSettingForTag = config[sectionDetail.showSettingName]
-//     // logDebug('getTaggedSections', `sectionDetail.sectionName=${sectionDetail.sectionName} showSettingForTag=${showSettingForTag}`)
-//     if (typeof showSettingForTag === 'undefined' || showSettingForTag) acc.push(getTaggedSectionData(config, useDemoData, sectionDetail, index))
-//     return acc // Return the accumulator
-//   }, [])
-//   logTimer('getTaggedSections', startTime, `at end`, 1500)
-//   return output
-// }
-
 /**
  * Generate data for a section for items with a Tag/Mention.
  * Only find paras with this *single* tag/mention which include open tasks that aren't scheduled in the future.
@@ -720,8 +693,10 @@ export async function getTaggedSectionData(config: TDashboardSettings, useDemoDa
           config.overdueSortOrder === 'priority'
             ? ['-priority', '-changedDate']
             : config.overdueSortOrder === 'earliest'
-            ? ['changedDate', 'priority']
-            : ['-changedDate', 'priority'] // 'most recent'
+              ? ['changedDate', '-priority']
+              : config.overdueSortOrder === 'due date'
+                ? ['dueDate', '-priority']
+                : ['-changedDate', '-priority'] // 'most recent'
         const sortedTagParas = sortListBy(dashboardParas, sortOrder)
         logTimer('getTaggedSectionData', thisStartTime, `- Filtered, Reduced & Sorted  ${sortedTagParas.length} items by ${String(sortOrder)}`)
 
@@ -828,7 +803,13 @@ export async function getOverdueSectionData(config: TDashboardSettings, useDemoD
 
       // Sort paragraphs by one of several options
       const sortOrder =
-        config.overdueSortOrder === 'priority' ? ['-priority', '-changedDate'] : config.overdueSortOrder === 'earliest' ? ['changedDate', 'priority'] : ['-changedDate', 'priority'] // 'most recent'
+        config.overdueSortOrder === 'priority'
+          ? ['-priority', '-changedDate']
+          : config.overdueSortOrder === 'earliest'
+            ? ['changedDate', '-priority']
+            : config.overdueSortOrder === 'due date'
+              ? ['dueDate', '-priority']
+              : ['-changedDate', '-priority'] // 'most recent'
       const sortedOverdueTaskParas = sortListBy(dashboardParas, sortOrder)
       logDebug('getOverdueSectionData', `- Sorted ${sortedOverdueTaskParas.length} items by ${String(sortOrder)} after ${timer(thisStartTime)}`)
 
diff --git a/jgclark.Dashboard/src/types.js b/jgclark.Dashboard/src/types.js
@@ -1,7 +1,7 @@
 // @flow
 //-----------------------------------------------------------------------------
 // Types for Dashboard code
-// Last updated 2025-04-09 for v2.2.0.a12, @jgclark
+// Last updated 2025-04-15 for v2.2.1, @jgclark
 //-----------------------------------------------------------------------------
 // Types for Settings
 
@@ -84,7 +84,7 @@ export type TDashboardSettings = {
   moveSubItems: boolean,
   newTaskSectionHeading: string,
   newTaskSectionHeadingLevel: number,
-  overdueSortOrder: string,
+  overdueSortOrder: string, // 'priority' | 'earliest' | 'most recent'
   parentChildMarkersEnabled: boolean,
   rescheduleNotMove: boolean,
   separateSectionForReferencedNotes: boolean,
@@ -179,13 +179,12 @@ export type TParagraphForDashboard = {
   lineIndex: number, // needed for child ordering processing
   priority: number,
   blockId?: string,
-  // timeStr?: string, // = used to order extended paragraphs. TEST: Can it be consolidated with .startTime?
   startTime?: string, // this is still definitely used to style time blocks
   endTime?: string,
   changedDate?: Date, // required for sorting items in display
   hasChild?: boolean, // whether it has child item(s)
   isAChild?: boolean, // whether it is a child item
-  // children?: Function, // TEST: removing it as JGC can't see it being used on 2024-12-10
+  dueDate?: string, // ISO string of due date, or 'none', required for sorting items in display
 }
 
 // a project item within a section
diff --git a/np.Tidy/src/tidyMain.js b/np.Tidy/src/tidyMain.js
@@ -2,7 +2,7 @@
 //-----------------------------------------------------------------------------
 // Main functions for Tidy plugin
 // Jonathan Clark
-// Last updated 2024-12-18 for v0.14.4, @jgclark
+// Last updated 2025-03-11 for v0.14.5, @jgclark
 //-----------------------------------------------------------------------------
 
 import moment from 'moment/min/moment-with-locales'
@@ -323,6 +323,8 @@ export async function removeDoneTimeParts(params: string = ''): Promise<void> {
 /**
  * Remove a given section (by matching on their section heading) from recently-changed Notes. Note: does not match on note title.
  * Can be passed parameters to override default time interval through an x-callback call.
+ * FIXME: Found 248 'Stats' sections in my notes.
+ * FIXME: numDays 
  * @author @jgclark
  * @param {?string} params optional JSON string
  */
@@ -341,7 +343,7 @@ export async function removeSectionFromRecentNotes(params: string = ''): Promise
     }
 
     // Get num days to process from param, or by asking user if necessary
-    const numDays: number = await getTagParamsFromString(params ?? '', 'numDays', config.numDays ?? 0)
+    const numDays: number = await getTagParamsFromString(params ?? '', 'numDays', config.numDays || 0)
     logDebug('removeSectionFromRecentNotes', `numDays = ${String(numDays)}`)
     // Note: can be 0 at this point, which implies process all days
 
@@ -395,7 +397,7 @@ export async function removeSectionFromRecentNotes(params: string = ''): Promise
       // Check user wants to proceed (if not calledWithParams)
       if (!runSilently) {
         const res = await showMessageYesNo(`Do you want to remove ${String(numToRemove)} '${sectionHeading}' sections?`, ['Yes', 'No'], 'Remove Section from Notes')
-        if (res === 'No') {
+        if (res !== 'Yes') {
           logInfo('removeSectionFromRecentNotes', `User cancelled operation`)
           return
         }
