Merge branch 'main' of https://github.com/NotePlan/plugins

Author: dwertheimer

helpers/userInput.js

@@ -131,20 +131,21 @@ export async function chooseOptionWithModifiers<T, TDefault = T>(
 
 /**
  * Show a list of options to the user and return which option they picked (and whether they used a modifier key), optionally with ability to create a new item.
- * V2: without the <TDefault> type parameter, using the new CommandBar.showOptions() options from v3.18
+ * This is a fork of chooseOptionWithModifiers(), without the <TDefault> type parameter, using the new CommandBar.showOptions() options from v3.18
+ * Note: requires at least v3.18
  * @author @jgclark, @dwertheimer based on @nmn chooseOption
  *
  * @param {string} message - text to display to user
  * @param {Array<TCommandBarOptionObject>} options - array of options to display
  * @param {TCommandBarOptionObject} additionalCreateNewOption - optional option object to create a new item
  * @returns {Promise<TCommandBarResultObject>} - the object that was chosen, plus an index of the chosen option and keyModifiers array. If the user created a new item, the index will be -1.
  */
-export async function chooseOptionWithModifiersV2(
+export async function chooseDecoratedOptionWithModifiers(
   message: string,
   options: Array<TCommandBarOptionObject>,
   additionalCreateNewOption?: TCommandBarOptionObject,
 ): Promise<TCommandBarResultObject> {
-  logDebug('userInput / chooseOptionWithModifiersV2()', `Will showOptions with ${options.length} options & prompt: "${message}"`)
+  logDebug('userInput / chooseDecoratedOptionWithModifiers()', `Will showOptions with ${options.length} options & prompt: "${message}"`)
 
   // label field is used elsewhere, but @eduardme made showOptions use text instead, so we map it back to label
   if (Array.isArray(options) && options.length > 0) { 
@@ -158,16 +159,12 @@ export async function chooseOptionWithModifiersV2(
   if (additionalCreateNewOption) {
     displayOptions.unshift(additionalCreateNewOption)
   }
-  // logDebug('userInput / chooseOptionWithModifiersV2()', `displayOptions: ${displayOptions.length} options`)
-// for TEST:
-  for(let i = 0; i < 15; i++) {
-    console.log(`- ${i}: ${displayOptions[i].text}`)
-  }
+  // logDebug('userInput / chooseDecoratedOptionWithModifiers()', `displayOptions: ${displayOptions.length} options`)
 
   // Use newer CommandBar.showOptions() from v3.18
   const result = await CommandBar.showOptions(displayOptions, message, '')
   const { index, keyModifiers } = result
-  clo(result, `chooseOptionWithModifiersV2 chosen result`)
+  clo(result, `chooseDecoratedOptionWithModifiers chosen result`)
   clo(displayOptions[index], `and relevant displayOption`)
 
   // Check if the user selected "Add new item"
@@ -390,7 +387,7 @@ export async function chooseFolder(
         if (includeNewFolderOption) {
           // Add in the new folder option just for newer CommandBar use
           decoratedFolderOptions.unshift(addDecoratedNewFolderOption)
-          result = await chooseOptionWithModifiersV2(msg, decoratedFolderOptions) // note disabling the add new folder option as we need to handle it with access to folders array
+          result = await chooseDecoratedOptionWithModifiers(msg, decoratedFolderOptions) // note disabling the add new folder option as we need to handle it with access to folders array
           keyModifiers = result.keyModifiers || []
           if (keyModifiers.length > 0 && keyModifiers.indexOf('opt') > -1) {
             optClickedOnFolder = true
@@ -403,13 +400,15 @@ export async function chooseFolder(
           } else if (optClickedOnFolder) {
             // i.e. new folder wanted, and parent folder chosen
             folder = folders[result.index-1] // to ignore the added new folder option if present
+            newFolderWanted = true
           }
           else {
             folder = folders[result.index-1] // to ignore the added new folder option if present
             // newFolderWanted = value === NEW_FOLDER
           }
 
-          // Handle new folder creation
+          // Handle new folder creation, if requested
+          if (newFolderWanted) {
           const newFolderPath = await handleNewFolderCreation(folder, startFolder, includeArchive, includeFolderPath, excludeTeamspaces, forceOriginalCommandBar)
           if (newFolderPath) {
             folder = newFolderPath
@@ -418,18 +417,13 @@ export async function chooseFolder(
           } else {
             throw new Error(`Failed to create new folder "${folder}"`)
           }
+          }
 
         } else {
           // not including add new folder option
-          result = await chooseOptionWithModifiersV2(msg, decoratedFolderOptions), //includeNewFolderOption ? addDecoratedNewFolderOption : undefined) // note now wanting to disable the add new folder option as we are handling it specifically here
-          clo(result, 'chooseFolder chooseOptionWithModifiersV2 result') // ✅
-          if (result.index === -1) {
-            // i.e. new folder wanted, but no name given yet
-            value = '' 
-            newFolderWanted = true
-          } else {
-            value = folders[result.index]
-          }
+          result = await chooseDecoratedOptionWithModifiers(msg, decoratedFolderOptions)
+          clo(result, 'chooseFolder chooseDecoratedOptionWithModifiers result') // ✅
+          value = folders[result.index]
         }
       } else {
         // ✅ for both private + teamspace

jgclark.NoteHelpers/src/index.js

@@ -9,10 +9,10 @@
 // allow changes in plugin.json to trigger recompilation
 import pluginJson from '../plugin.json'
 
-import { JSP, logDebug, logError } from '@helpers/dev'
+import { JSP, logDebug, logError, logInfo } from '@helpers/dev'
 // import { migrateCommandsIfNecessary } from '@helpers/NPConfiguration'
 import { editSettings } from '@helpers/NPSettings'
-import { showMessage } from '@helpers/userInput'
+import { chooseFolder, showMessage } from '@helpers/userInput'
 
 export { countAndAddDays } from './countDays'
 export { indexFolders, updateAllIndexes } from './indexFolders'
@@ -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, testChooseFolder } from './noteHelpers'
+export { addTriggerToNote, convertLocalLinksToPluginLinks, addFrontmatterToNote, moveNote, logEditorNoteDetailed, renameNoteFile, trashNote } from './noteHelpers'
 export {
   jumpToDone,
   jumpToHeading,
@@ -85,3 +85,20 @@ export async function updateSettings(): Promise<void> {
     logError(pluginJson, JSP(error))
   }
 }
+
+//-----------------------------------------------------------------
+
+/**
+ * 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, false)
+    logInfo('testChooseFolder', `Selected folder: ${selectedFolder}`)
+  } catch (err) {
+    logError('noteHelpers/testChooseFolder', err.message)
+    await showMessage(err.message)
+  }
+}

jgclark.NoteHelpers/src/noteHelpers.js

@@ -52,23 +52,6 @@ export async function getSettings(): Promise<any> {
 
 //-----------------------------------------------------------------
 
-/**
- * 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) {

np.CallbackURLs/src/NPOpenFolders.js

@@ -1,7 +1,7 @@
 // @flow
 
 import { logDebug, clo } from '../../helpers/dev'
-import { showMessage, createFolderRepresentation, chooseOptionWithModifiersV2, chooseOption } from '@helpers/userInput'
+import { showMessage, createFolderRepresentation, chooseDecoratedOptionWithModifiers, chooseOption } from '@helpers/userInput'
 import { getFolderViewData, getFoldersWithNamedViews, getNamedViewsForFolder } from '@helpers/folders'
 import { getAllTeamspaceIDsAndTitles } from '@helpers/NPTeamspace'
 
@@ -81,7 +81,7 @@ function createFolderOptions(allFolders: $ReadOnlyArray<string>, folderData: Obj
 async function selectFolder(folderOptions: Array<Object>): Promise<Object | null> {
   clo(folderOptions, `selectFolder: folderOptions`)
 
-  const selection = await chooseOptionWithModifiersV2('Choose a folder', folderOptions)
+  const selection = await chooseDecoratedOptionWithModifiers('Choose a folder', folderOptions)
   if (!selection) return null
 
   const selectedFolderObj = folderOptions[selection.index]
@@ -128,7 +128,7 @@ async function selectView(viewOptions: Array<Object>, selectedFolder: string): P
     return viewOptions[0].value
   }
   clo(viewOptions, `selectView viewOptions`)
-  const responseObj = await chooseOptionWithModifiersV2(`Choose a view for '${selectedFolder}'`, viewOptions)
+  const responseObj = await chooseDecoratedOptionWithModifiers(`Choose a view for '${selectedFolder}'`, viewOptions)
   if (responseObj) {
     clo(responseObj, `selectView responseObj`)
     return responseObj.value