Filer 1.6.0 WIP - new unarchive command

Author: jgclark

jgclark.Filer/CHANGELOG.md

@@ -1,6 +1,9 @@
 # What's changed in 📦 Filer plugin?
 Please see the [Readme for this plugin](https://github.com/NotePlan/plugins/tree/main/jgclark.Filer) for more details, including the available settings.
 
+## [1.6.0] - 2026-05-01
+- new **/unarchive note keeping folder structure** command that reverses **/archive note keeping folder structure** by moving a note from `@Archive` back to its original folder path.
+
 ## [1.5.3] - 2025-03-16
 - fix: improvements to the **/move completed items to done section** command
 - dev: added tests for its helper functions

jgclark.Filer/README.md

@@ -5,6 +5,14 @@ It has some settings, which you review and change by clicking on the '⚙️ Set
 
 [<img width="200px" alt="Buy Me A Coffee" src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg" />](https://www.buymeacoffee.com/revjgc)
 
+## /archive note keeping folder structure
+This command moves the current project note into NotePlan's special `@Archive` folder while keeping the same folder path under `@Archive`.
+
+For example, `Projects/ClientA/Plan.md` becomes `@Archive/Projects/ClientA/Plan.md`.
+
+## /unarchive note keeping folder structure
+This command is the inverse of the above. For example the filename changes from `@Archive/Projects/ClientA/Plan.md` to `Projects/ClientA/Plan.md`.
+
 ## /move paragraph or selection
 The **/move paragraph** command (aliased to **/mp** and **/fp**) quickly **files** (moves) lines to different notes in NotePlan, without having to lose your flow by switching to the other note. It works on any sort of lines, not just tasks.
 

jgclark.Filer/plugin.json

@@ -8,9 +8,9 @@
   "plugin.author": "jgclark",
   "plugin.url": "https://noteplan.co/plugins/jgclark.Filer",
   "plugin.changelog": "https://github.com/NotePlan/plugins/blob/main/jgclark.Filer/CHANGELOG.md",
-  "plugin.version": "1.5.3",
+  "plugin.version": "1.6.0",
   "plugin.releaseStatus": "full",
-  "plugin.lastUpdateInfo": "1.5.3: Improvements to the 'move completed items to done section' command.\n1.5.2: Allow customising the name of the 'Done' section heading used by the 'move completed items to done section' command. Improvements to the 'move completed items to done section' command.\n1.5.1: Fix 'Add date reference?' option so that when moving from calendar note the added date now correctly points to the source note's date, not always to today.\n1.5.0: New '/move completed items to done section' command that is more powerful than NP's built-in 'Move Completed to Bottom' menu action. It has two settings, which reveal its additional powers: Recreate existing section structure in Done section? (default: true). Only move completed items when whole section is complete? (default: false).\n1.4.1: Fix for /move paras command when moving to a note with a heading with trailing whitespace.\n1.4.0: \"/add sync'd copy to note\" now can work on a block of lines. Further bug fixes for some commands on notes with frontmatter.",
+  "plugin.lastUpdateInfo": "1.6.0: New '/unarchive note keeping folder structure' command to move a note from @Archive back to its original folder path.\n1.5.3: Improvements to the 'move completed items to done section' command.\n1.5.2: Allow customising the name of the 'Done' section heading used by the 'move completed items to done section' command. Improvements to the 'move completed items to done section' command.\n1.5.1: Fix 'Add date reference?' option so that when moving from calendar note the added date now correctly points to the source note's date, not always to today.\n1.5.0: New '/move completed items to done section' command that is more powerful than NP's built-in 'Move Completed to Bottom' menu action. It has two settings, which reveal its additional powers: Recreate existing section structure in Done section? (default: true). Only move completed items when whole section is complete? (default: false).",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.isRemote": "false",
@@ -34,6 +34,15 @@
       "description": "Move the current note to NotePlan's Archive, but keep the same folder structure for it inside the special @Archive folder",
       "jsFunction": "archiveNote"
     },
+    {
+      "name": "unarchive note keeping folder structure",
+      "alias": [
+        "uan",
+        "unarchive"
+      ],
+      "description": "Move the current note from NotePlan's Archive back to its original folder structure",
+      "jsFunction": "unarchiveNote"
+    },
     {
       "name": "copy note links",
       "alias": [

jgclark.Filer/src/archive.js

@@ -2,13 +2,14 @@
 // ----------------------------------------------------------------------------
 // Smarter archiving commands, part of Filer plugin
 // Jonathan Clark
-// last updated 2025-09-06 for v1.3.2
+// last updated 2026-05-01 for v1.6.0, by @Cursor & @jgclark
 // ----------------------------------------------------------------------------
 
 import pluginJson from "../plugin.json"
-import { logDebug, logError, logWarn } from '@helpers/dev'
+import { clo, JSP, logDebug, logError, logWarn } from '@helpers/dev'
 import { displayTitle } from '@helpers/general'
 import { archiveNoteUsingFolder } from '@helpers/NPnote'
+import { showMessage } from '@helpers/userInput'
 
 //-----------------------------------------------------------------------------
 
@@ -19,7 +20,7 @@ import { archiveNoteUsingFolder } from '@helpers/NPnote'
  * @param {string?} archiveRootFolder optional; if not given, then use the built-in @Archive folder)
  * @returns {?string} newFilename, if success
  */
-export function archiveNote(noteIn?: TNote, archiveRootFolder?: string): ?string {
+export async function archiveNote(noteIn?: TNote, archiveRootFolder?: string): ?string {
   try {
     let note: TNote | null
     if (noteIn && (typeof noteIn === "object")) {
@@ -38,11 +39,60 @@ export function archiveNote(noteIn?: TNote, archiveRootFolder?: string): ?string
       logDebug('archiveNote', `- Note -> ${newFilename}`)
       return newFilename
     } else {
-      throw new Error(`archiveNote(): Failed when archiving '${displayTitle(note)}' to ${archiveRootFolder ?? '@Archive'}`)
+      const _res = await showMessage(`Failed to move '${displayTitle(note)}' to the Archive. Please see log for details.`, 'OK, thanks', 'Archive Note')
+      throw new Error(`Failed when archiving '${displayTitle(note)}' to ${archiveRootFolder ?? '@Archive'} folder.`)
     }
   }
   catch (error) {
-    logError(pluginJson, `archiveNote(): ${error.message}`)
+    logError(pluginJson, `archiveNote(): ${JSP(error)}`)
+    return null
+  }
+}
+
+/**
+ * Unarchive a note by moving it out of the special @Archive folder and restoring
+ * its original folder path. If no TNote object is passed in, then unarchive
+ * the note in the open Editor.
+ * @param {TNote?} noteIn optional; if not given, then use the open Editor's note)
+ * @returns {?string} newFilename, if success
+ */
+export async function unarchiveNote(noteIn?: TNote): ?string {
+  try {
+    let note: TNote | null
+    if (noteIn && (typeof noteIn === 'object')) {
+      // A note was passed in, so use it
+      note = noteIn
+      logDebug('unarchiveNote', `Note passed in: ${note.filename}`)
+    } else {
+      logDebug(pluginJson, `unarchiveNote(): starting for note open in Editor`)
+      note = Editor.note ?? null
+    }
+    if (!note) {
+      throw new Error("Couldn't get note, so stopping.")
+    }
+    if (note.type === 'Calendar') {
+      logWarn(pluginJson, 'unarchiveNote(): Cannot unarchive a Calendar note, so stopping.')
+      return null
+    }
+
+    const currentFilename = note.filename
+    if (!currentFilename.startsWith('@Archive/')) {
+      const _res = await showMessage(`'${displayTitle(note)}' is not in the Archive, so cannot unarchive it.`, 'OK, thanks', 'Unarchive Note')
+      throw new Error(`'${displayTitle(note)}' is not in @Archive, so cannot unarchive it.`)
+    }
+
+    const filenameWithoutArchive = currentFilename.replace(/^@Archive\//, '')
+    const destinationFolder = filenameWithoutArchive.includes('/') ? filenameWithoutArchive.split('/').slice(0, -1).join('/') : ''
+    const newFilename = DataStore.moveNote(currentFilename, destinationFolder)
+    if (newFilename) {
+      logDebug('unarchiveNote', `- Note -> ${newFilename}`)
+      return newFilename
+    } else {
+      throw new Error(`unarchiveNote(): Failed when unarchiving '${displayTitle(note)}' from @Archive`)
+    }
+  }
+  catch (error) {
+    logError(pluginJson, `unarchiveNote(): ${JSP(error)}`)
     return null
   }
 }

jgclark.Filer/src/index.js

@@ -3,15 +3,15 @@
 // -----------------------------------------------------------------------------
 // Plugin to help move selected pargraphs to other notes
 // Jonathan Clark
-// Last updated 2025-12-16, for v1.5.0
+// Last updated 2026-05-01, for v1.6.0, by @Cursor
 // -----------------------------------------------------------------------------
 
 import pluginJson from '../plugin.json' // allow changes in plugin.json to trigger recompilation
 import { JSP, logDebug, logInfo, logError, logWarn, timer } from "@helpers/dev"
 import { editSettings } from '@helpers/NPSettings'
 import { showMessage } from '@helpers/userInput'
 
-export { archiveNote } from './archive'
+export { archiveNote, unarchiveNote } from './archive'
 export { addIDAndAddToOtherNote } from './IDs'
 export { moveCompletedItemsToDoneSectionCommand } from './moveCompletedToDone'
 export {