NoteHelpers 1.3.3 New 'add to frontmatter' command

Author: jgclark

jgclark.NoteHelpers/plugin.json

@@ -7,9 +7,9 @@
   "plugin.author": "Jonathan Clark & Eduard Metzger",
   "plugin.url": "https://github.com/NotePlan/plugins/tree/main/jgclark.NoteHelpers/",
   "plugin.changelog": "https://github.com/NotePlan/plugins/blob/main/jgclark.NoteHelpers/CHANGELOG.md",
-  "plugin.version": "1.3.2",
+  "plugin.version": "1.3.3",
   "plugin.releaseStatus": "full",
-  "plugin.lastUpdateInfo": "1.3.2: Add more detail to /log Editor Note, to help flush out a long-standing API bug.\n1.3.1: Improvements and fixes to 'list inconsistent note filenames' command.\n1.3.0: New 'duplicate note' command.\n1.2.5: Fix regression in folder chooser.\n1.2.4: Small improvements to 'jump to heading' and 'jump to note heading' commands.\n1.2.3: Fix to 'move note' command for iOS/iPadOS.\n1.2.2: Fix regression in folder picker.\n1.2.1: Allow 'delete note' command to run on Teamspace notes. Stop 'inconsistent file name' commands from running on Teamspace notes. Bug fixes.\n1.2.0: improvements to displays in 'jump to heading' and 'jump to note heading' commands, and include Teamspace notes. Improvements to 'inconsistent file name' commands.\n1.1.1: add initial support for Teamspaces + bug fix.\n1.1.0: new 'list published notes' command.",
+  "plugin.lastUpdateInfo": "1.3.3: New 'add to frontmatter' command.\n1.3.2: Add more detail to /log Editor Note, to help flush out a long-standing API bug.\n1.3.1: Improvements and fixes to 'list inconsistent note filenames' command.\n1.3.0: New 'duplicate note' command.\n1.2.5: Fix regression in folder chooser.\n1.2.4: Small improvements to 'jump to heading' and 'jump to note heading' commands.\n1.2.3: Fix to 'move note' command for iOS/iPadOS.\n1.2.2: Fix regression in folder picker.\n1.2.1: Allow 'delete note' command to run on Teamspace notes. Stop 'inconsistent file name' commands from running on Teamspace notes. Bug fixes.\n1.2.0: improvements to displays in 'jump to heading' and 'jump to note heading' commands, and include Teamspace notes. Improvements to 'inconsistent file name' commands.\n1.1.1: add initial support for Teamspaces + bug fix.\n1.1.0: new 'list published notes' command.",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.commands": [
@@ -35,6 +35,18 @@
         "trigger string (e.g. 'onEditorWillSave => jgclark.DashboardReact.decideWhetherToUpdateDashboard')"
       ]
     },
+    {
+      "name": "add to frontmatter",
+      "alias": [
+        "addFM"
+      ],
+      "description": "Add a key:value pair to the frontmatter of the current note",
+      "jsFunction": "addItemToFrontmatter",
+      "parameters": [
+        "key",
+        "value"
+      ]
+    },
     {
       "name": "convert to frontmatter",
       "alias": [

jgclark.NoteHelpers/src/index.js

@@ -23,7 +23,7 @@ export { renameInconsistentNames } from './lib/commands/renameInconsistentNames'
 export { titleToFilename } from './lib/commands/titleToFilename'
 export { listPublishedNotes } from './listPublishedNotes'
 export { newNote, newNoteFromClipboard, newNoteFromSelection } from './newNote'
-export { addTriggerToNote, convertLocalLinksToPluginLinks, addFrontmatterToNote, moveNote, logEditorNoteDetailed, renameNoteFile, trashNote } from './noteHelpers'
+export { addTriggerToNote, convertLocalLinksToPluginLinks, addFrontmatterToNote, addItemToFrontmatter, moveNote, logEditorNoteDetailed, renameNoteFile, trashNote } from './noteHelpers'
 export {
   jumpToDone,
   jumpToHeading,

jgclark.NoteHelpers/src/noteHelpers.js

@@ -329,6 +329,64 @@ export async function renameNoteFile(): Promise<void> {
   }
 }
 
+/**
+ * Add a key:value pair to the frontmatter for 'note', or if none open, the current Editor.
+ * @param {TNote?} note optional note to add the item to, or if none open, the current Editor.
+ * @param {string?} key the key to add to the frontmatter
+ * @param {string?} value the value to add to the frontmatter
+ * @returns {boolean} true if the item was added to the frontmatter successfully, false if failed for some reason
+ */
+export async function addItemToFrontmatter(note: ?TNote, key: ?string, value: ?string): Promise<boolean> {
+  try {
+    let thisNote: TNote
+    let thisKey: string = ''
+    let thisValue: string = ''
+    if (note == null) {
+      if (Editor == null) {
+        throw new Error(`No note open to convert. Stopping.`)
+      }
+      if (!Editor.note) {
+        throw new Error(`No note open in the Editor. Stopping.`)
+      }
+      thisNote = Editor.note
+    } else {
+      thisNote = note
+    }
+    if (!thisNote) {
+      throw new Error(`No note supplied, and can't find Editor either.`)
+    }
+    if (!key || key === '') {
+      const inputKey = await getInput(`Please enter the key to add to the frontmatter`, 'OK', 'Add Item to Frontmatter', '')
+      if (typeof inputKey !== 'string' || inputKey === '') {
+        throw new Error(`Empty key supplied. Stopping.`)
+      }
+      thisKey = inputKey
+    } else {
+      thisKey = key
+    }
+    if (!thisValue || thisValue === '') {
+      const inputValue = await getInput(`Please enter the value for key '${thisKey}'`, 'OK', 'Add Item to Frontmatter', '')
+      if (typeof inputValue !== 'string' || inputValue === '') {
+        throw new Error(`Empty value supplied. Stopping.`)
+      }
+      thisValue = inputValue
+    } else {
+      thisValue = value
+    }
+    const res = updateFrontMatterVars(thisNote, { [thisKey]: thisValue })
+    if (res) {
+      logDebug('note/addItemToFrontmatter', `addItemToFrontmatter(${thisKey}: ${thisValue}) returned ${String(res)}.`)
+    } else {
+      throw new Error(`Failed to add item to frontmatter. Stopping.`)
+    }
+    return res
+  } catch (error) {
+    logError(pluginJson, JSP(error))
+    await showMessage(error.message)
+    return false
+  }
+}
+
 /**
  * Convert the note to using frontmatter Syntax
  * If the plugin settings contains default frontmatter, this is added to the frontmatter.
@@ -354,7 +412,7 @@ export async function addFrontmatterToNote(note: TNote): Promise<void> {
     }
     const config = await getSettings()
     const res = await convertNoteToFrontmatter(thisNote, config.defaultFMText ?? '')
-    logDebug('note/convertNoteToFrontmatter', `ensureFrontmatter() returned ${String(res)}.`)
+    logDebug('note/convertNoteToFrontmatter', `addFrontmatterToNote() returned ${String(res)}.`)
   } catch (error) {
     logError(pluginJson, JSP(error))
     await showMessage(error.message)