Add new /end... commands, refactor code and documentation. WIP for v1.0.0

Author: jgclark

jgclark.DailyJournal/CHANGELOG.md

@@ -1,12 +1,12 @@
-# What's changed in 💭 Journalling Plugin?
+# What's changed in 💭 Journalling Helpers Plugin?
 _Please also see the Plugin [README](https://github.com/NotePlan/plugins/blob/main/jgclark.DailyJournal/README.md)._
 
 <!-- TODO: improved flexibility of questions -->
 
 ## [1.0.0] - 2025-10-10
-_I've somewhat  arbitrarily promoted this to v1.0 -- though I think it deserves it after 4.5 years._
+_I've somewhat  arbitrarily promoted this to v1.0 -- though I think it deserves it after 4.5 years. Renamed it to "Journalling Helpers Plugin"._
 ### Added
-- new **/dayEnd**, **/todayEnd** and **/weekEnd** commands, that run pre-set Templates (like /dayStart etc.)
+- new **/dayEnd**, **/todayEnd** and **/weekEnd** commands, that run pre-set Templates (like /dayStart etc.). These can be useful for review or summary questions and/or tidy up operations.
 ### Changed
 - re-wrote documentation to bring it up to date with NotePlan's improvements in Templating in the last 2 years.
 

jgclark.DailyJournal/README.md

@@ -1,21 +1,13 @@
-# 💭 Journalling plugin
+# 💭 Journalling Helpers Plugin
 <img width="196px" src="calendar-notes-319@2x.png" align="right"/>
-This plugin helps you write daily, weekly, monthly, quarterly and/or yearly Journals, by speeding up applying your pre-set Templates to your calendar notes, and/or prompting you for review questions that you set in advance.
-
-The commands are:
-- **/dayStart**: Apply your 'Daily Note' Template to the currently open daily note (or today's note if you're not editing a daily note)
-- **/todayStart**: Apply your 'Daily Note' Template to today's calendar note
-- **/weekStart**: Apply your 'Weekly Note' Template to the currently open weekly note (or the current weekly note if you're not editing a weekly note)
-- **/monthStart**: Apply your 'Monthly Note' Template to the currently open monthly note (or the current monthly note if you're not editing a monthly note)
-- **/dayReview**: Ask journal questions for an end-of-day review, and write answers in the current daily note. See below for details and examples.
-- **/weekReview**, **/monthReview**, **/quarterReview** and **/yearReview** all work similarly, asking the appropriately-configured journal questions, and write answers in the currently-open week/month/quarter/year note for that period, or if one of those isn't open, then offers to open the current note for that period.
+This plugin gives support for journalling in NotePlan, including making it easier to apply start-of-day Templates, and end-of-day/week Reviews, Summaries or Tidy Up.
 
 ### Configuration
-To use weekly/monthly/quarterly/yearly commands, you first need to have them turned on in **NotePlan Settings** > Calendar pane:
+To use this plugin on weekly/monthly/quarterly/yearly notes, you first need to have them turned on in **NotePlan Settings** > Calendar pane:
 
 <img src="calendar-settings@2x.png"/>
 
-Then you will need to **configure the Plugin**: click the gear button on the 'Journalling' line in the Plugin Preferences panel, and fill in the settings according to which of the following commands you want to use.  (On iOS or iPadOS, you need to use the separate **/Journalling: update plugin settings** command instead.)
+All the available commands require some **configuration** first. On Mac click the gear button on the 'Journalling' line in the Plugin Preferences panel, and fill in the settings according to which of the following commands you want to use.  If you only use iPhone or iPad, you'll need to use the separate **/Journalling: update plugin settings** command instead.
 
 ## Quickly applying Templates at the start of each Day/Week
 The NotePlan website has good [articles on getting started with Templates](https://help.noteplan.co/article/136-templates), and a helpful [Template Gallery](https://noteplan.co/templates), to build from.
@@ -34,9 +26,9 @@ These commands make it quicker to apply a Template at the start or end of a day
 This acts very similarly to the /dayStart command above.
 
 ### /dayEnd, /todayEnd, /weekEnd commands
-These act in the same way as above, but can be tailored to adding items at the end of a day, perhaps like a Habit or Stats summary from the separate [**Habits & Summaries plugin**]().
+These act in the same way as above, but can be tailored to adding items at the end of a day, perhaps like a Habit or Stats summary from the separate [**Habits & Summaries plugin**](https://noteplan.co/plugins/jgclark.Summaries).
 
-This is also a quick way of regularly running one or more commands from the separate [**Tidy Up plugin**]().
+This is also a quick way of regularly running one or more commands from the separate [**Tidy Up plugin**](https://noteplan.co/plugins/np.Tidy).
 
 ## Helping with periodic Reviews
 There's no right or wrong way to do reviews, and you'll no doubt change what you find helpful over time. But the key is to be taking some time to answer questions to help you pause and review what has and hasn't gone well over the last day/week/month/quarter. Some use it as a way of capturing their main **emotions**; others to track **goals**; others to write a simple **gratitude** journal.

jgclark.DailyJournal/plugin.json

@@ -2,14 +2,14 @@
   "noteplan.minAppVersion": "3.3.2",
   "macOS.minVersion": "10.13.0",
   "plugin.id": "jgclark.DailyJournal",
-  "plugin.name": "💭 Journalling",
-  "plugin.description": "Support for daily journalling in NotePlan, including start-of-day template, and end-of-day review questions. Before use it requires some configuration: please see website for details.",
+  "plugin.name": "💭 Journalling Helpers",
+  "plugin.description": "Supports daily journalling in NotePlan, including making it easier to apply start-of-day templates, and end-of-day/week  Reviews, Summaries or Tidy Up. Before use it requires some configuration: please see website for details.",
   "plugin.icon": "",
   "plugin.author": "Jonathan Clark",
   "plugin.url": "https://github.com/NotePlan/plugins/blob/main/jgclark.DailyJournal/README.md",
   "plugin.changelog": "https://github.com/NotePlan/plugins/blob/main/jgclark.DailyJournal/CHANGELOG.md",
   "plugin.version": "1.0.0",
-  "plugin.lastUpdateInfo": "v1.0.0: Add new '/dayEnd', '/todayEnd' and '/weekEnd' commands, that run pre-set Templates (like /dayStart etc.).\nv0.15.1: New 'Journalling: update plugin settings' command for use on iOS/iPadOS. v0.15: Added support for Monthly, Quarterly and Yearly review questions. v0.14: Added /weekStart command. \nv0.13: Added support for /weekReview, /monthReview and /quarterlyReview, each of which have settings for their different Review Questions. /dayStart now uses the template's location field to determine where in the note to insert.",
+  "plugin.lastUpdateInfo": "v1.0.0: Rename to 'Journalling Helpers Plugin'. Add new '/dayEnd', '/todayEnd' and '/weekEnd' commands, that run pre-set Templates for Reviews, Summaries or Tidy Up.\nv0.15.1: New 'Journalling: update plugin settings' command for use on iOS/iPadOS. v0.15: Added support for Monthly, Quarterly and Yearly review questions. v0.14: Added /weekStart command. \nv0.13: Added support for /weekReview, /monthReview and /quarterlyReview, each of which have settings for their different Review Questions. /dayStart now uses the template's location field to determine where in the note to insert.",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.isRemote": "false",
@@ -18,7 +18,8 @@
       "name": "dayStart",
       "alias": [
         "daily",
-        "template"
+        "ds",
+        "startDay"
       ],
       "description": "Apply Daily Note Template",
       "jsFunction": "dayStart"
@@ -27,7 +28,8 @@
       "name": "dayEnd",
       "alias": [
         "daily",
-        "template"
+        "de",
+        "endDay"
       ],
       "description": "Apply Day End Template",
       "jsFunction": "dayEnd"
@@ -37,7 +39,7 @@
       "alias": [
         "day",
         "today",
-        "template"
+        "ts"
       ],
       "description": "Apply Daily Note Template to Today's Calendar Note",
       "jsFunction": "todayStart"
@@ -46,8 +48,8 @@
       "name": "todayEnd",
       "alias": [
         "day",
-        "today",
-        "template"
+        "endToday",
+        "te"
       ],
       "description": "Apply Day End Template to Today's Calendar Note",
       "jsFunction": "todayEnd"
@@ -56,7 +58,7 @@
       "name": "weekStart",
       "alias": [
         "weekly",
-        "template"
+        "ws"
       ],
       "description": "Apply Weekly Note Template",
       "jsFunction": "weekStart"
@@ -71,7 +73,7 @@
       "name": "monthStart",
       "alias": [
         "monthly",
-        "template"
+        "ms"
       ],
       "description": "Apply Monthly Note Template (requires configuring)",
       "jsFunction": "monthStart"
@@ -130,6 +132,11 @@
       "name": "Journalling: update plugin settings",
       "description": "Settings interface (even for iOS)",
       "jsFunction": "updateSettings"
+    },
+    {
+      "name": "Journalling: Test onUpdateOrInstall",
+      "description": "onUpdateOrInstall",
+      "jsFunction": "onUpdateOrInstall"
     }
   ],
   "plugin.settings": [
@@ -138,29 +145,53 @@
       "title": "Daily Journal settings"
     },
     {
-      "key": "templateTitle",
-      "title": "Daily Template Title",
+      "key": "startDailyTemplateTitle",
+      "title": "Start-of-Day Template Title",
       "description": "The name of the template that `/dayStart` and `/todayStart` commands will use.",
       "type": "string",
       "default": "Daily Note Template",
-      "required": true
+      "required": false
+    },
+    {
+      "key": "endDailyTemplateTitle",
+      "title": "End-of-DayTemplate Title",
+      "description": "The name of the template that `/dayEnd` and `/todayEnd` commands will use.",
+      "type": "string",
+      "default": "Daily Review Template",
+      "required": false
     },
     {
-      "key": "weeklyTemplateTitle",
-      "title": "Weekly Template Title",
+      "key": "startWeeklyTemplateTitle",
+      "title": "Start-of-Week Template Title",
       "description": "Optional name of the template that `/weekStart` command will use.",
       "type": "string",
       "default": "Weekly Note Template",
       "required": false
     },
     {
-      "key": "monthlyTemplateTitle",
-      "title": "Monthly Template Title",
+      "key": "endWeeklyTemplateTitle",
+      "title": "End-of-Week Template Title",
+      "description": "Optional name of the template that `/weekEnd` command will use.",
+      "type": "string",
+      "default": "Weekly Review Template",
+      "required": false
+    },
+    {
+      "key": "startMonthlyTemplateTitle",
+      "title": "Start-of-Month Template Title",
       "description": "Optional name of the template that `/monthStart` command will use.",
       "type": "string",
       "default": "Monthly Note Template",
       "required": false
     },
+    {
+      "key": "endMonthlyTemplateTitle",
+      "title": "End-of-Month Template Title",
+      "description": "Optional name of the template that `/monthEnd` command will use.",
+      "type": "string",
+      "default": "Monthly Review Template",
+      "required": false
+    },
     {
       "key": "reviewSectionHeading",
       "title": "Journal Section Heading",
@@ -172,13 +203,13 @@
     {
       "key": "moods",
       "title": "List of moods",
-      "description": "A comma-separated list of possible moods to select from.",
+      "description": "(Optional.) A comma-separated list of possible moods to select from.",
       "type": "string",
       "default": "🤩 Great,🙂 Good,😇 Blessed,🥱 Tired,😫 Stressed,😤 Frustrated,😔 Low,🥵 Sick,Other",
       "required": true
     },
     {
-      "key": "reviewQuestions",
+      "key": "dailyReviewQuestions",
       "title": "Daily Journal Questions",
       "description": "Optional string that includes both the Journal/Review questions and how to lay out the answers in the daily note. (NB: can include line breaks.) The special codes that define the type of question asked are '<int>', '<number>', '<string>', '<subheading>' and '<mood>'.",
       "type": "string",

jgclark.DailyJournal/src/index.js

@@ -8,8 +8,9 @@
 
 // allow changes in plugin.json to trigger recompilation
 import pluginJson from '../plugin.json'
-import { JSP, logDebug, logInfo, logError } from "@helpers/dev"
-import { pluginUpdated, updateSettingData } from '@helpers/NPConfiguration'
+import { renameKeys } from '@helpers/dataManipulation'
+import { clo, compareObjects, JSP, logDebug, logInfo, logError } from "@helpers/dev"
+import { backupSettings, pluginUpdated, saveSettings } from '@helpers/NPConfiguration'
 import { editSettings } from '@helpers/NPSettings'
 
 const pluginID = 'jgclark.DailyJournal'
@@ -24,8 +25,11 @@ export {
 
 export {
   dayStart,
+  dayEnd,
   todayStart,
+  todayEnd,
   weekStart,
+  weekEnd,
   monthStart,
 } from './templatesStartEnd'
 
@@ -44,10 +48,34 @@ export function onSettingsUpdated(): void {
 
 export async function onUpdateOrInstall(): Promise<void> {
   try {
-    logDebug(pluginJson, `${pluginJson['plugin.id']} :: onUpdateOrInstall started`)
+    logDebug(pluginJson, `onUpdateOrInstall() ...`)
+    const initialSettings = (await DataStore.loadJSON(`../${pluginID}/settings.json`)) || DataStore.settings
+
+    // Migrate any necessary settings from v0.15 to v1.0
+    // TODO(later): remove when all users have updated to v1.0
+    await backupSettings(pluginID, `before_onUpdateOrInstall-v${pluginJson['plugin.version']}`)
+    const keysToChange = {
+      // oldKey: newKey
+      templateTitle: 'startDailyTemplateTitle',
+      weeklyTemplateTitle: 'startWeeklyTemplateTitle',
+      monthlyTemplateTitle: 'startMonthlyTemplateTitle',
+      reviewQuestions: 'dailyReviewQuestions',
+    }
+    const migratedSettings = renameKeys(initialSettings, keysToChange)
+    const diff = compareObjects(migratedSettings, initialSettings, [], true)
+    if (diff != null) {
+      // Save the settings back to the DataStore
+      logInfo(`onUpdateOrInstall`, `- changes to settings detected`)
+      clo(initialSettings, `onUpdateOrInstall:  initialSettings:`)
+      clo(migratedSettings, `onUpdateOrInstall:  migratedSettings:`)
+      await saveSettings(pluginID, migratedSettings)
+    } else {
+      logDebug(`onUpdateOrInstall`, `- no changes detected to settings.`)
+    }
+
     // Tell user the plugin has been updated
-    await updateSettingData(pluginJson)
-    await pluginUpdated(pluginJson, { code: 2, message: `Plugin Installed.` })
+    logInfo(pluginID, `- finished`)
+    await pluginUpdated(pluginJson, { code: 2, message: `Plugin Installed or Updated.` })
   } catch (error) {
     logError(pluginID, `onUpdateOrInstall: ${JSP(error)}`)
   }