editor.js

// @flow

import { logDebug } from './dev'
import { showMessageYesNo, showMessage } from './userInput'
import { getFolderFromFilename } from '@helpers/folders'

/**
 * Run Editor.save() if active Editor is dirty and needs saving
 * Does nothing if Editor and Editor.note are the same (has been saved)
 * If they don't match, it saves
 * @usage await saveEditorIfNecessary()
 * @dwertheimer sometimes found that calling Editor.save() on a note which didn't need saving would crash the plugin
 */
export async function saveEditorIfNecessary() {
  if (!Editor?.note) throw 'There is no active Editor.note'
  if (Editor.note?.content !== Editor.content) await Editor.save() // ensure recent/unsaved changes get saved first
}

/**
 * Check if Editor has no content or just contains "#", "# ", or "# \n"
 * @usage const isEmpty = editorIsEmpty()
 * @returns {boolean} true if Editor is empty or contains only "#" variations
 */
export function editorIsEmpty() {
  if (!Editor?.content) return true

  const content = Editor.content.trim()
  return content === '' || content === '#' || content === '# ' || content === '# \n'
}

/**
 * Check if the template wants the note to be created in a folder and if so, move the empty note to the trash and create a new note in the folder
 * @param {*} frontmatterAttributes
 * @returns {boolean} whether to stop execution (true) or continue (false)
 */
export async function checkAndProcessFolderAndNewNoteTitle(templateNote: TNote, frontmatterAttributes: Object): Promise<boolean> {
  // Check if the template wants the note to be created in a folder and if so, move the empty note to the trash and create a new note in the folder
  const isEditorEmpty = editorIsEmpty()
  const theFolder = frontmatterAttributes?.folder?.trim() || ''
  const newNoteTitle = frontmatterAttributes?.newNoteTitle?.trim() || ''
  logDebug(`checkAndProcessFolderAndNewNoteTitle starting: templateNote:"${templateNote?.title || ''}", frontmatterAttributes:${JSON.stringify(frontmatterAttributes)}`)
  if (theFolder.length > 0 || newNoteTitle.length > 0) {
    if (isEditorEmpty) {
      logDebug(`insertNoteTemplate: template has folder:"${theFolder}", newNoteTitle:"${newNoteTitle}", so moving empty note to trash and creating a new note in the folder`)
      // invoke the template with the folder attribute
      const emptyNoteFilename = Editor.filename
      const templateTitle = templateNote?.title
      const folderToUse = theFolder.length > 0 ? theFolder : getFolderFromFilename(Editor.filename)
      const argsArray = [templateTitle, folderToUse === '/' ? '' : folderToUse, newNoteTitle, frontmatterAttributes]
      await DataStore.invokePluginCommandByName('templateNew', 'np.Templating', argsArray)
      // move the empty note to the trash
      await DataStore.moveNote(emptyNoteFilename, '@Trash')
      return true
    } else if (theFolder.length > 0) {
      if (!Editor.filename.startsWith(theFolder)) {
        const res = await showMessageYesNo(
          `The template has a folder property (folder: ${theFolder}). Should we move the current note to the folder "${theFolder}"?`,
          ['Yes', 'No'],
          'Move this Note?',
        )
        if (res === 'Yes') {
          const newFilename = DataStore.moveNote(Editor.filename, theFolder)
          if (newFilename) {
            // This message is actually necessary to kill time while the move happens because the move is not async
            // And we can't actually open the note until after 1s-ish
            await showMessage(`Note moved to folder "${theFolder}"`)
            await Editor.openNoteByFilename(newFilename)
          }
        }
      }
    }
  }
  return false
}