joplin-plugin-backup 1.1.1 → 1.2.1

package/README.md

@@ -2,8 +2,35 @@
 
 A plugin to extend Joplin with a manual and automatic backup function.
 
+<!-- markdownlint-disable MD033 -->
+<!-- markdownlint-disable MD028 -->
+<!-- markdownlint-disable MD007 -->
+
 <img src=img/main.jpg>
 
+<!-- prettier-ignore-start -->
+<!-- TOC depthfrom:2 orderedlist:false -->
+
+- [Installation](#installation)
+    - [Automatic](#automatic)
+    - [Manual](#manual)
+- [Usage](#usage)
+- [Options](#options)
+- [Keyboard Shortcuts](#keyboard-shortcuts)
+- [What is backed up](#what-is-backed-up)
+- [Restore](#restore)
+    - [Settings](#settings)
+    - [Notes](#notes)
+- [FAQ](#faq)
+    - [Internal Joplin links betwen notes are lost](#internal-joplin-links-betwen-notes-are-lost)
+    - [Combine multiple JEX Files to one](#combine-multiple-jex-files-to-one)
+- [Open a JEX Backup file](#open-a-jex-backup-file)
+- [Changelog](#changelog)
+- [Links](#links)
+
+<!-- /TOC -->
+<!-- prettier-ignore-end -->
+
 ## Installation
 
 ### Automatic
@@ -44,6 +71,8 @@ Go to `Tools > Options > Backup`
 | `Temporary export path`      | The data is first exported into this path before it is copied to the backup `Backup path`.                                                                               | ``                      |
 | `Backup set name`            | Name of the backup set if multiple backups are to be keep. [Available moment tokens](https://momentjs.com/docs/#/displaying/format/), which can be used with `{<TOKEN>}` | `{YYYYMMDDHHmm}`        |
 | `Single JEX`                 | Create only one JEX file for all, this option is recommended to prevent the loss of internal note links or folder structure during a restore!                            | `true`                  |
+| `Export format`              | Selection of the export format of the notes.                                                                                                                             | `jex`                   |
+| `Command on Backup finish`   | Execute command when backup is finished.                                                                                                                                 |                         |
 | `Create Subfolder`           | Create a sub folder `JoplinBackup` in the configured `Backup path`. Deactivate only if there is no other data in the `Backup path`!                                      | `true`                  |
 | `Backup plugins`             | Backup the plugin folder from the Joplin profile with all installed plugin jpl files.                                                                                    | `true`                  |
 
@@ -79,7 +108,7 @@ The notes are imported via `File > Import > JEX - Joplin Export File`.
 > Individual notes cannot be restored from the JEX file!
 
 The notes are imported additionally, no check for duplicates is performed.
-If the folder in which the note was located already exists in you Joplin, than the folder name is extended by one (1).
+If the notebook in which the note was located already exists in your Joplin, then a "(1)" will be appended to the folder name.
 
 ## FAQ
 
@@ -88,7 +117,7 @@ If the folder in which the note was located already exists in you Joplin, than t
 If several JEX files are imported and the notes have links to each other, these links will be lost.
 Therefore it is recommended to create a Single JEX Backup!
 
-### Compine multiple JEX Files to one
+### Combine multiple JEX Files to one
 
 By combining the JEX files into one, the Joplin internal links will work again after the import.
 

package/__test__/backup.test.ts

@@ -298,6 +298,51 @@ describe("Backup", function () {
       expect(fs.existsSync(expected)).toBe(true);
     });
 
+    it(`retention = 1, folder exist with same files and folder`, async () => {
+      const emptyFolder = path.join(testPath.activeBackupJob, "emptyFolder");
+      const emptyFolderCheck = path.join(
+        testPath.backupBasePath,
+        "emptyFolder"
+      );
+      const folderNotes = path.join(testPath.activeBackupJob, "notes");
+      const folderNotesCheck = path.join(testPath.backupBasePath, "notes");
+      const file1 = path.join(folderNotes, "file.txt");
+      const file1Check = path.join(folderNotesCheck, "file.txt");
+      const file2 = path.join(testPath.activeBackupJob, "file.txt");
+      const file2Check = path.join(testPath.backupBasePath, "file.txt");
+      const file3Check = path.join(testPath.backupBasePath, "fileStay.txt");
+      const file4Check = path.join(folderNotesCheck, "fileNo.txt");
+      backup.backupBasePath = testPath.backupBasePath;
+      backup.activeBackupPath = testPath.activeBackupJob;
+
+      fs.emptyDirSync(testPath.backupBasePath);
+      fs.emptyDirSync(emptyFolderCheck);
+      fs.emptyDirSync(folderNotesCheck);
+      fs.writeFileSync(file1Check, "old file");
+      fs.writeFileSync(file2Check, "old file");
+      fs.writeFileSync(file3Check, "old file");
+      fs.writeFileSync(file4Check, "old file");
+
+      fs.emptyDirSync(testPath.activeBackupJob);
+      fs.emptyDirSync(emptyFolder);
+      fs.emptyDirSync(folderNotes);
+      fs.writeFileSync(file1, "new file");
+      fs.writeFileSync(file2, "new file");
+
+      backup.backupRetention = 1;
+
+      expect(await backup.moveFinishedBackup()).toBe(testPath.backupBasePath);
+      expect(fs.existsSync(folderNotes)).toBe(false);
+      expect(fs.existsSync(folderNotesCheck)).toBe(true);
+      expect(fs.existsSync(emptyFolderCheck)).toBe(true);
+      expect(fs.existsSync(file1Check)).toBe(true);
+      expect(fs.existsSync(file2Check)).toBe(true);
+      expect(fs.existsSync(file3Check)).toBe(true);
+      expect(fs.existsSync(file4Check)).toBe(false);
+      expect(backup.log.error).toHaveBeenCalledTimes(0);
+      expect(backup.log.warn).toHaveBeenCalledTimes(0);
+    });
+
     it(`retention > 1, file exist`, async () => {
       backup.backupBasePath = testPath.backupBasePath;
       backup.activeBackupPath = testPath.activeBackupJob;

package/__test__/help.test.ts

@@ -71,4 +71,79 @@ describe("Test helper", function () {
       );
     }
   });
+  it(`Compare versions`, async () => {
+    const testCases = [
+      {
+        version1: "2.9.12",
+        version2: "2.9.12",
+        expected: 0,
+      },
+      {
+        version1: "2.9.12",
+        version2: "2.9.13",
+        expected: -1,
+      },
+      {
+        version1: "2.9.13",
+        version2: "2.9.12",
+        expected: 1,
+      },
+      {
+        version1: "2.10.6",
+        version2: "2.9.12",
+        expected: 1,
+      },
+      {
+        version1: "3.10.6",
+        version2: "2.11.8",
+        expected: 1,
+      },
+      {
+        version1: "2.10.6",
+        version2: "3.11.8",
+        expected: -1,
+      },
+      {
+        version1: "2",
+        version2: "2.1",
+        expected: -1,
+      },
+      {
+        version1: "2.1",
+        version2: "2",
+        expected: 1,
+      },
+      {
+        version1: "3",
+        version2: "2",
+        expected: 1,
+      },
+      {
+        version1: "2",
+        version2: "2",
+        expected: 0,
+      },
+      {
+        version1: "3.11.8",
+        version2: "3.11.8-a",
+        expected: 0,
+      },
+      {
+        version1: "2",
+        version2: "",
+        expected: -2,
+      },
+      {
+        version1: "3.a.8",
+        version2: "3.11.8",
+        expected: -1,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      expect(
+        await helper.versionCompare(testCase.version1, testCase.version2)
+      ).toBe(testCase.expected);
+    }
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-backup",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "scripts": {
     "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
     "prepare": "npm run dist && husky install",

package/publish/io.github.jackgruber.backup.json

@@ -2,7 +2,7 @@
 	"manifest_version": 1,
 	"id": "io.github.jackgruber.backup",
 	"app_min_version": "2.1.3",
-	"version": "1.1.1",
+	"version": "1.2.1",
 	"name": "Simple Backup",
 	"description": "Plugin to create manual and automatic backups.",
 	"author": "JackGruber",
@@ -16,6 +16,6 @@
 		"7zip",
 		"encrypted"
 	],
-	"_publish_hash": "sha256:616b034ec484e83bf972adab454c9c00d23d9bd0b21574beba7915e42ff7415a",
-	"_publish_commit": "master:98221472e60f34026ac739368c2831193f564654"
+	"_publish_hash": "sha256:ee3fee3a90fe21a1c656240f9e3506fd6651a7318f398a484c6c31bef425dec8",
+	"_publish_commit": "master:e4e8e6cff708bc7f181d2c18122084b7aeb4fb32"
 }