NoteHelpers v1.2.1

Author: jgclark

.prettierrc

@@ -1,3 +1,9 @@
 {
-    "semi": false
+    "semi": false,
+    "quoteProps": "as-needed",
+    "templateCurlySpacing": false,
+    "experimentalOperatorPosition": "start",
+    "bracketSameLine": false,
+    "arrowParens": "always",
+    "objectWrap": "preserve"
 }

jgclark.NoteHelpers/CHANGELOG.md

@@ -1,6 +1,11 @@
 # What's changed in 📙 Note Helpers plugin?
 For more details see the [plugin's README](https://github.com/NotePlan/plugins/tree/main/jgclark.NoteHelpers/).
 
+## [1.2.1] - 2025-09-19
+- improve and fix folder picker in various commands (including updating the sort order to match the app -- thanks for pointing this out, @tastapod)
+- allow **delete note** command to run on Teamspace notes (if running v3.18.2 or above).
+- stop **inconsistent file name** commands from running on Teamspace notes, which are stored in a SQL DB instead of having filenames
+
 ## [1.2.0] - 2025-08-23
 - improved display of lists of notes and headings in **jump to heading** and **jump to note's heading**, and include Teamspace notes
 - various improvements/fixes to the **inconsistent file name** commands. Resolves issues #640, #642, #643 raised by @tastapod.

jgclark.NoteHelpers/plugin.json

@@ -7,8 +7,8 @@
   "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.2.0",
-  "plugin.lastUpdateInfo": "1.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.\n1.1.0: added 'write modified' command to write the modified date to frontmatter (on each save). Can be run by hand or can be included as a trigger using the 'add trigger to note' command. Small improvements to \"new note from selection\".\n1.0.0: move '/new note from ...' commands here from Filer plugin, and revived '/new note' command.\n0.20.3: New 'printEditorDetailed' command to log all paragraph details as well.\n0.20.2: 'printNote' extended to cover backlinks.\n0.20.1: new command 'printNote' for debugging purposes.\n0.20.0: new commands \"unlinked note finder\" and \"delete note\". Bug fix to \"rename note filename\" command.\n0.19.2: fix edge cases with \"add trigger to note\".",
+  "plugin.version": "1.2.1",
+  "plugin.lastUpdateInfo": "1.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.\n1.1.0: added 'write modified' command to write the modified date to frontmatter (on each save). Can be run by hand or can be included as a trigger using the 'add trigger to note' command. Small improvements to \"new note from selection\".\n1.0.0: move '/new note from ...' commands here from Filer plugin, and revived '/new note' command.\n0.20.3: New 'printEditorDetailed' command to log all paragraph details as well.\n0.20.2: 'printNote' extended to cover backlinks.\n0.20.1: new command 'printNote' for debugging purposes.\n0.20.0: new commands \"unlinked note finder\" and \"delete note\". Bug fix to \"rename note filename\" command.\n0.19.2: fix edge cases with \"add trigger to note\".",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.commands": [
@@ -263,6 +263,16 @@
       "jsFunction": "triggerFindUnlinkedNotes",
       "hidden": true
     },
+    {
+      "comment": "TODO: delete me soon",
+      "name": "test: choose folder",
+      "description": "Test the chooseFolder function",
+      "jsFunction": "testChooseFolder",
+      "alias": [
+        "tcf"
+      ],
+      "hidden": true
+    },
     {
       "name": "Write changed/modified date to frontmatter",
       "description": "Write the modified date to frontmatter (on each save). Writes to 'modified' key.",

jgclark.NoteHelpers/src/index.js

@@ -22,7 +22,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, moveNote, logEditorNoteDetailed, renameNoteFile, trashNote, testChooseFolder } from './noteHelpers'
 export {
   jumpToDone,
   jumpToHeading,

jgclark.NoteHelpers/src/lib/commands/listInconsistentNames.js

@@ -15,6 +15,7 @@ import { chooseFolder, showMessage } from '@helpers/userInput'
 
 /**
  * Shows a list of notes with inconsistent names (i.e. where the note title and filename are different).
+ * Only makes sense for private regular notes.
  * @param {string} folderIn - Optional URL-encodedfolder to check for inconsistent names. If not provided, the user will be prompted to choose a folder.
  * @returns void
  */
@@ -26,7 +27,8 @@ export async function listInconsistentNames(folderIn: string = ''): Promise<void
       folder = decodeURIComponent(folderIn)
     } else {
       logDebug(pluginJson, 'listInconsistentNames(): Checking for inconsistent names in project notes...')
-      folder = await chooseFolder('Choose a folder to find inconsistent filenames in')
+      // Find only private (non-teamspace) notes
+      folder = await chooseFolder('Choose a note folder to find inconsistent filenames in', false, false, '', true, true)
     }
 
     if (!folder) {

jgclark.NoteHelpers/src/lib/commands/renameInconsistentNames.js

@@ -2,7 +2,7 @@
 //-----------------------------------------------------------------------------
 // Functions to identify and fix where note names and their filenames are inconsistent.
 // by Leo Melo, readied for the plugin and maintained by @jgclark
-// Last updated 2025-06-11 for v1.2.0 by @jgclark
+// Last updated 2025-09-14 for v1.2.1 by @jgclark
 //-----------------------------------------------------------------------------
 
 import pluginJson from '../../../plugin.json'
@@ -14,10 +14,11 @@ import { chooseFolder, showMessage, showMessageWithList, showMessageYesNoCancel
 /**
  * Renames all project notes with inconsistent names (i.e. where the note title and filename are different (apart from case)).
  * Optionally prompts the user before renaming each note.
+ * Note: currently only works for private regular notes.
  */
 export async function renameInconsistentNames(): Promise<void> {
   try {
-    const directory = await chooseFolder('Choose a folder to rename inconsistent notes in')
+    const directory = await chooseFolder('Choose a folder to rename inconsistent notes in', true, false, '', true, true) // exclude Teamspace notes
 
     if (!directory) {
       logWarn(pluginJson, 'renameInconsistentNames(): No folder chosen. Stopping.')

jgclark.NoteHelpers/src/noteHelpers.js

@@ -2,21 +2,16 @@
 //-----------------------------------------------------------------------------
 // Note Helpers plugin for NotePlan
 // Jonathan Clark & Eduard Metzger
-// Last updated 2025-06-06 for v1.2.0 by @jgclark
+// Last updated 2025-09-14 for v1.2.1 by @jgclark
 //-----------------------------------------------------------------------------
 
 import pluginJson from '../plugin.json'
 import { clo, JSP, logDebug, logError, logInfo, logWarn, timer } from '@helpers/dev'
 import { displayTitle } from '@helpers/general'
 import { convertNoteToFrontmatter, printNote } from '@helpers/NPnote' // Note: not the one in 'NPTemplating'
 import { addTrigger, noteHasFrontMatter, updateFrontMatterVars, TRIGGER_LIST } from '@helpers/NPFrontMatter'
-import { parseTeamspaceFilename } from '@helpers/teamspace'
-import {
-  chooseFolder,
-  chooseOption,
-  getInput,
-  showMessage,
-} from '@helpers/userInput'
+import { getTeamspaceTitleFromNote } from '@helpers/NPTeamspace'
+import {chooseFolder,chooseOption,getInput,showMessage} from '@helpers/userInput'
 
 //-----------------------------------------------------------------
 // Settings
@@ -58,9 +53,22 @@ export async function getSettings(): Promise<any> {
 //-----------------------------------------------------------------
 
 /**
- * Command from Eduard to move a note to a different folder
- * @author @eduardme
+ * Test the chooseFolder() function
+ * Call: noteplan://x-callback-url/runPlugin?pluginID=jgclark.NoteHelpers&command=test%3A%20choose%20folder
+ * @author @jgclark
  */
+export async function testChooseFolder(): Promise<void> {
+  try {
+  const selectedFolder = await chooseFolder(`TEST: Select a folder`, true, true, '', true, false, true)
+    logInfo('testChooseFolder', `Selected folder: ${selectedFolder}`)
+  } catch (err) {
+    logError('noteHelpers/testChooseFolder', err.message)
+    await showMessage(err.message)
+  }
+}
+
+//-----------------------------------------------------------------
+
 export async function logEditorNoteDetailed(): Promise<void> {
   try {
     if (!Editor || !Editor.note) {
@@ -95,7 +103,7 @@ export async function moveNote(): Promise<void> {
       const res = await showMessage(`NotePlan doesn't allow moving calendar notes.`)
       return
     }
-    const selectedFolder = await chooseFolder(`Select a folder for '${title}'`, true, true) // include @Archive as an option, and to create a new folder
+    const selectedFolder = await chooseFolder(`Select a folder for '${title}'`, true, true) // include @Archive, and new folder options
     logDebug('moveNote()', `move ${title} (filename = ${filename}) to ${selectedFolder}`)
 
     const newFilename = DataStore.moveNote(filename, selectedFolder)
@@ -114,28 +122,41 @@ export async function moveNote(): Promise<void> {
 //-----------------------------------------------------------------
 /**
  * Delete a note -- by moving to the special @Trash folder.
- * Note: this cannot work on Teamspace notes (at least as of v3.18.1), because the API doesn't support this.
+ * Note: the following NP API limitations:
+ * - this does not work for Calendar notes
+ * - this only works on Teamspace notes from v3.18.2 build 1431
  * @author @jgclark
  */
 export async function trashNote(): Promise<void> {
   try {
-    const { title, filename } = Editor
-    if (title == null || filename == null) {
-      // No note open, so don't do anything.
+    const { note, filename, type, isTeamspaceNote } = Editor
+    if (note == null || filename == null) {
       throw new Error('No note open. Stopping.')
     }
-    const possibleTeamspaceDetails = parseTeamspaceFilename(filename)
-    if (possibleTeamspaceDetails.isTeamspace) {
-      throw new Error('Sorry, I cannot currently move Teamspace notes to the Trash. You will need to do this manually.')
+    if (type === 'Calendar') {
+      throw new Error(`Sorry, NotePlan doesn't allow moving Calendar notes to the Trash.`)
+    }
+    if (isTeamspaceNote) {
+      if (NotePlan.environment.buildVersion < 1431) {
+        throw new Error('Sorry, before NotePlan v3.18.2, I cannot move Teamspace notes to the Trash. You will need to do this manually.')
+      } else {
+        showMessage('Note: currently Teamspaces have no trash folder, but a copy will be made inside the Operating System Trash, if you need to recover the note.')
+      }
     }
 
-    const newFilename = DataStore.moveNote(filename, '@Trash')
+    const result = DataStore.trashNote(filename)
 
-    if (!newFilename) {
+    if (result) {
+      if (isTeamspaceNote) {
+        logInfo('NoteHelpers/trashNote', `Note '${displayTitle(note)}' from Teamspace '${getTeamspaceTitleFromNote(note)}' (filename '${filename}') was deleted from the Teamspace, and copied to your local @Trash folder.`)
+      } else {
+        logInfo('NoteHelpers/trashNote', `Note '${displayTitle(note)}' (filename '${filename}') was moved to the Trash.`)
+      }
+    } else {
       throw new Error(`Error trying to move note to @Trash`)
     }
   } catch (err) {
-    logError(pluginJson, `${err.name}: ${err.message}`)
+    logError(`NoteHelpers/trashNote`, err.message)
     await showMessage(err.message)
   }
 }
@@ -205,7 +226,7 @@ export async function addTriggerToNote(triggerStringArg: string = ''): Promise<v
         logDebug('addTriggerToNote', `- result of updateFrontMatterVars = ${String(res)}`)
       } else {
         logDebug('addTriggerToNote', `- Editor "${displayTitle(Editor)}" doesn't already have frontmatter`)
-        await convertNoteToFrontmatter(Editor, `triggers: ${triggerStringArg}`)
+        await convertNoteToFrontmatter(Editor.note, `triggers: ${triggerStringArg}`)
       }
       return
     } else {
@@ -273,7 +294,7 @@ export function convertLocalLinksToPluginLinks(): void {
   let changed = false
   for (const para of paragraphs) {
     const content = para.content
-    const newContent = content.replace(/\[(.*?)\]\(\#(.*?)\)/g, (match, label, link) => {
+    const newContent = content.replace(/\[(.*?)\]\(\#(.*?)\)/g, (_match, label, link) => {
       const newLink = `noteplan://x-callback-url/runPlugin?pluginID=jgclark.NoteHelpers&command=jump%20to%20heading&arg1=${encodeURIComponent(link)}`
       return `[${label}](${newLink})`
     })
@@ -295,7 +316,7 @@ export function convertLocalLinksToPluginLinks(): void {
  */
 export async function renameNoteFile(): Promise<void> {
   try {
-    const { note } = Editor
+    const { note, isTeamspaceNote } = Editor
     if (note == null || note.paragraphs.length < 1) {
       // No note open, so don't do anything.
       throw new Error('No note open, or no content, so nothing to rename.')
@@ -305,27 +326,14 @@ export async function renameNoteFile(): Promise<void> {
       throw new Error('Sorry, you cannot rename Calendar notes.')
     }
     // Don't continue if note is a Teamspace note
-    const teamspaceDetailsFromFilename = parseTeamspaceFilename(note.filename)
-    if (teamspaceDetailsFromFilename.isTeamspace) {
+    if (isTeamspaceNote) {
       throw new Error('Sorry, you cannot rename Teamspace notes.')
     }
 
     const currentFullPath = note.filename
-    // TODO: could use chooseFolderV2() here first
+    // TODO: could use chooseFolder() here first
     const requestedPath = await getInput(`Please enter new filename for file (including folder and file extension)`, 'OK', 'Rename file', currentFullPath)
     if (typeof requestedPath === 'string') {
-      // let newFolder = ''
-      // let newFilename = ''
-      // if (requestedPath.lastIndexOf('/') > -1) {
-      //   newFolder = requestedPath.substr(0, requestedPath.lastIndexOf('/'))
-      //   newFilename = requestedPath.substr(requestedPath.lastIndexOf('/') + 1)
-      // } else {
-      //   newFolder = '/'
-      //   newFilename = requestedPath
-      // }
-      // logDebug(pluginJson, `${newFolder}  /  ${newFilename}`)
-      logDebug(pluginJson, `Requested new filepath = ${requestedPath}`)
-
       const newFilename = note.rename(requestedPath)
       logDebug('renameNoteFile()', `Note file renamed from '${currentFullPath}' to '${newFilename}'`)
     } else {
@@ -349,10 +357,12 @@ export async function addFrontmatterToNote(note: TNote): Promise<void> {
     let thisNote: TNote
     if (note == null) {
       if (Editor == null) {
-        throw new Error(`No note open to convert.`)
-      } else {
-        thisNote = Editor
+        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
     }